Report Definition

What can you do with ReportDefinition?


Properties

Property Details
id
"id": 776
Type: Number
This is the unique numeric identifier for the ReportDefinition
ownerId
"ownerId": 27
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
reportFolderId
"reportFolderId": 121
Type: Number
Unique identifier for the associated ReportFolder object.
title
"title": "Hello World"
Type: String
repeatTitle
"repeatTitle": true
Type: Boolean
isLocked
"isLocked": true
Type: Boolean
isActive
"isActive": true
Type: Boolean
created
"created": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 551
Type: Number
Unique identifier for the associated User object.
updated
"updated": "2005-04-11T14:56:24"
Type: Date
updatedByUserId
"updatedByUserId": 780
Type: Number
Unique identifier for the associated User object.


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
  • reportFolderId
  • title
  • repeatTitle
  • isLocked
  • isActive

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the ReportDefinition object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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