Report Definition

(API Version v2)

List of reports that have been defined in the system.

What can you do with ReportDefinition?

• GET api/v2/ReportDefinition/{id}
  
  Retrieve an instance of the ReportDefinition object by its ID.
  
  
• GET api/v2/ReportDefinition/{id}/Generated
  
  Return a list of PDFs that have been generated by a system schedule for the specified ReportDefinition.
  
  
• GET api/v2/ReportDefinition/{id}/LastGenerated
  
  Return the last generated report PDF for a specified ReportDefinition regardless of how the report was generated.
  
  
• POST api/v2/ReportDefinition/{id}/Render
  
  Kicks off a report generation rendering request for the specified ReportDefinition.
  
  

Properties

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

End Points

GET api/v2/ReportDefinition/{id}

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 4,
        "ownerName": "Sample Text Data",
        "name": "Montly Sales Summary",
        "reportFolderId": 26,
        "reportFolderName": "Sample Text Data",
        "title": "Montly Sales Results",
        "repeatTitle": true,
        "isLocked": true,
        "isActive": true,
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 13,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 1,
        "updatedByUserName": "Sample Text Data",
        "reportDefinitionTypeId": 0,
        "reportDefinitionTypeName": "Sample Text Data"
    }
}