Template

What can you do with Template?


Properties

Property Details
id
"id": 193
Type: Number
This is the unique numeric identifier for the Template
ownerId
"ownerId": 887
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
dataSourceTypeId
"dataSourceTypeId": 727
Type: Number
Unique identifier for the associated DataSourceType object.
paperTypeId
"paperTypeId": 42
Type: Number
Unique identifier for the associated PaperType object.
units
"units": "Hello World"
Type: String
defaultFont
"defaultFont": "Hello World"
Type: String
defaultFontSize
"defaultFontSize": "Hello World"
Type: String
columnGap
"columnGap": 347
Type: Number
headerFont
"headerFont": "Hello World"
Type: String
headerFontSize
"headerFontSize": "Hello World"
Type: String
headerTextIndent
"headerTextIndent": 809
Type: Number
headerFillColor
"headerFillColor": "Hello World"
Type: String
isLandscape
"isLandscape": true
Type: Boolean
defaultDateFormat
"defaultDateFormat": "Hello World"
Type: String
defaultDateTimeFormat
"defaultDateTimeFormat": "Hello World"
Type: String
defaultCurrencyFormat
"defaultCurrencyFormat": "Hello World"
Type: String
headerBorderLeft
"headerBorderLeft": 779
Type: Number
headerBorderTop
"headerBorderTop": 544
Type: Number
headerBorderRight
"headerBorderRight": 641
Type: Number
headerBorderBottom
"headerBorderBottom": 905
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • dataSourceTypeId
  • paperTypeId
  • units
  • defaultFont
  • defaultFontSize
  • columnGap
  • headerFont
  • headerFontSize
  • headerTextIndent
  • headerFillColor
  • isLandscape
  • defaultDateFormat
  • defaultDateTimeFormat
  • defaultCurrencyFormat
  • headerBorderLeft
  • headerBorderTop
  • headerBorderRight
  • headerBorderBottom

DataFlow PATCH objects:


End Points

DELETEapi/v1/Template/{id:int}
Delete an instance of the Template object.
GETapi/v1/Template
Retrieve all of the Template objects.
GETapi/v1/Template/Metadata
Retrieve all of the meta data details of the Template object.
GETapi/v1/Template/Metadata/{option}
Retrieve all the meta data details of the Template object based on provided options.
{option}Metadata options for the Template object.
GETapi/v1/Template/Paged
Retreive all of the Template objects in a paged fashion.
GETapi/v1/Template/Paged/Detail
Retreive all of the Template objects in a paged fashion with all object details.
GETapi/v1/Template/{id:int}
Retrieve an instance of the Template object by it's ID.
{id:int}Unique identifier for the Template object.
GETapi/v1/Template/{id:int}/Detail
Retreive all of the Detail objects for the specified Template.
{id:int}Unique identifier for the Template object.
PATCHapi/v1/Template/{id:int}
Update the Template object and optionally make changes to any child objects.
POSTapi/v1/Template
Create a new instance of the Template object.
PUTapi/v1/Template/{id:int}
Update an existing instance of the Template object.