Report / Column

What can you do with ReportColumn?


Properties

Property Details
id
"id": 1
Type: Number
This is the unique numeric identifier for the ReportColumn
ownerId
"ownerId": 830
Type: Number
Unique identifier for the associated Owner object.
reportId
"reportId": 287
Type: Number
Unique identifier for the associated Report object.
dataSourceColumnId
"dataSourceColumnId": 604
Type: Number
Unique identifier for the associated DataSourceColumn object.
heading
"heading": "Hello World"
Type: String
alignment
"alignment": 565
Type: Number
format
"format": "Hello World"
Type: String
isGroupable
"isGroupable": true
Type: Boolean
width
"width": 222
Type: Number
aggregationFunction
"aggregationFunction": 652
Type: Number
sortOrder
"sortOrder": 957
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:

  • reportId
  • dataSourceColumnId
  • heading
  • alignment
  • format
  • isGroupable
  • width
  • aggregationFunction
  • sortOrder

DataFlow PATCH objects:


End Points

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