Report Definition

(API Version v2)

What can you do with ReportDefinition?

GET api/v2/ReportDefinition/{id:Guid}
GET api/v2/ReportDefinition/{id:int}/LastGenerated
GET api/v2/ReportDefinition/{reportDefinitionId:int}/Generated
POST api/v2/ReportDefinition/{id:int}/Render

Properties

Property Details

id	"id": 17 Type: Number This is the unique numeric identifier for the ReportDefinition
ownerId	"ownerId": 15 Type: Number Unique identifier for the associated Owner object.
name	"name": "Hello World" Type: String
reportFolderId	"reportFolderId": 18 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": 15 Type: Number Unique identifier for the associated User object.
updated	"updated": "2005-04-11T14:56:24" Type: Date
updatedByUserId	"updatedByUserId": 5 Type: Number Unique identifier for the associated User object.
reportDefinitionTypeId	"reportDefinitionTypeId": 20 Type: Number Unique identifier for the associated ReportDefinitionType 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
reportDefinitionTypeId

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:

reportGroup - create, update, delete

DataFlow PATCH objects:

reportDefinition - create, update, delete
reportGroup - create, update, delete

End Points

GET	api/v2/ReportDefinition/{id:Guid}
Retrieve all of the ReportDefinition objects.

GET	api/v2/ReportDefinition/{id:int}/LastGenerated
Retreive all of the LastGenerated objects for the specified ReportDefinition.
{id:int}	Unique identifier for the ReportDefinition object.

GET	api/v2/ReportDefinition/{reportDefinitionId:int}/Generated
Retrieve all of the ReportDefinition objects.

POST	api/v2/ReportDefinition/{id:int}/Render
Create a new instance of a Render object that belongs to the ReportDefinition.
{id:int}	Unique identifier for the ReportDefinition object.