Report Group

What can you do with ReportGroup?


Properties

Property Details
id
"id": 942
Type: Number
This is the unique numeric identifier for the ReportGroup
ownerId
"ownerId": 114
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
reportDefinitionId
"reportDefinitionId": 807
Type: Number
Unique identifier for the associated ReportDefinition object.
dataSourceId
"dataSourceId": 858
Type: Number
Unique identifier for the associated DataSource object.
sortOrder
"sortOrder": 146
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
  • reportDefinitionId
  • dataSourceId
  • sortOrder

DataFlow PATCH objects:


End Points

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