Report / Layout

What can you do with ReportLayout?


Properties

Property Details
id
"id": 25
Type: Number
This is the unique numeric identifier for the ReportLayout
ownerId
"ownerId": 491
Type: Number
Unique identifier for the associated Owner object.
reportId
"reportId": 499
Type: Number
Unique identifier for the associated Report object.
paperTypeId
"paperTypeId": 721
Type: Number
Unique identifier for the associated PaperType object.
landscape
"landscape": true
Type: Boolean
units
"units": "Hello World"
Type: String
marginBottom
"marginBottom": "Hello World"
Type: String
marginLeft
"marginLeft": "Hello World"
Type: String
marginRight
"marginRight": "Hello World"
Type: String
marginTop
"marginTop": "Hello World"
Type: String


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:

  • reportId
  • paperTypeId
  • landscape
  • units
  • marginBottom
  • marginLeft
  • marginRight
  • marginTop

DataFlow PATCH objects:


End Points

DELETEapi/v1/Report/Layout/{id:int}
Delete an instance of the ReportLayout object.
GETapi/v1/Report/Layout
Retrieve all of the ReportLayout objects.
GETapi/v1/Report/Layout/Metadata
Retrieve all of the meta data details of the ReportLayout object.
GETapi/v1/Report/Layout/Metadata/{option}
Retrieve all the meta data details of the ReportLayout object based on provided options.
{option}Metadata options for the ReportLayout object.
GETapi/v1/Report/Layout/Paged
Retreive all of the ReportLayout objects in a paged fashion.
GETapi/v1/Report/Layout/{id:int}
Retrieve an instance of the ReportLayout object by it's ID.
{id:int}Unique identifier for the ReportLayout object.
POSTapi/v1/Report/Layout
Create a new instance of the ReportLayout object.
PUTapi/v1/Report/Layout/{id:int}
Update an existing instance of the ReportLayout object.