Template / Section

What can you do with TemplateSection?


Properties

Property Details
id
"id": 568
Type: Number
This is the unique numeric identifier for the TemplateSection
name
"name": "Hello World"
Type: String
templateId
"templateId": 29
Type: Number
Unique identifier for the associated Template object.
templateSectionTypeId
"templateSectionTypeId": 184
Type: Number
Unique identifier for the associated TemplateSectionType object.
parentTemplateSectionId
"parentTemplateSectionId": 950
Type: Number
Unique identifier for the associated TemplateSection object.
isStacked
"isStacked": true
Type: Boolean
marginLeft
"marginLeft": "Hello World"
Type: String
marginTop
"marginTop": "Hello World"
Type: String
marginRight
"marginRight": "Hello World"
Type: String
marginBottom
"marginBottom": "Hello World"
Type: String
height
"height": "Hello World"
Type: String
absolutePositionX
"absolutePositionX": 456
Type: Number
absolutePositionY
"absolutePositionY": 585
Type: Number
templateSectionWidthTypeId
"templateSectionWidthTypeId": 367
Type: Number
Unique identifier for the associated TemplateSectionWidthType object.
width
"width": 864
Type: Number
borderLeft
"borderLeft": 903
Type: Number
borderTop
"borderTop": 518
Type: Number
borderRight
"borderRight": 23
Type: Number
borderBottom
"borderBottom": 713
Type: Number
backgroundColor
"backgroundColor": "Hello World"
Type: String
startOnNewPage
"startOnNewPage": true
Type: Boolean
sortOrder
"sortOrder": 331
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
  • templateId
  • templateSectionTypeId
  • parentTemplateSectionId
  • isStacked
  • marginLeft
  • marginTop
  • marginRight
  • marginBottom
  • height
  • absolutePositionX
  • absolutePositionY
  • templateSectionWidthTypeId
  • width
  • borderLeft
  • borderTop
  • borderRight
  • borderBottom
  • backgroundColor
  • startOnNewPage
  • sortOrder

DataFlow PATCH objects:


End Points

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