TAG LINE
TAG LINE
SMALL TITLE
List of reports that have been defined in the system.
identity READ-ONLY | "identity": 7 Type: Number This is the unique numeric identifier for the ReportDefinition |
ownerId READ-ONLY | "ownerId": 10 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name READ-ONLY | "name": "Montly Sales Summary" Type: String User defined name for the Report. |
reportFolderId | "reportFolderId": 8 Type: Number Unique identifier for the associated ReportFolder object. |
reportFolderName | "reportFolderName": "Sample Name" Type: String The name of the object associated with the reportFolderId property. |
title READ-ONLY | "title": "Montly Sales Results" Type: String Text that appears at the top of the report. |
repeatTitle READ-ONLY | "repeatTitle": true Type: Boolean Whether or not to repeat the title on all pages. |
isLocked READ-ONLY | "isLocked": true Type: Boolean Internal Flag Denoting this report cannot be edited. |
isActive READ-ONLY | "isActive": true Type: Boolean Whether or not this report is active to be run. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
createdByUserId | "createdByUserId": 15 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
updatedByUserId | "updatedByUserId": 21 Type: Number Unique identifier for the associated User object. |
updatedByUserName | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
reportDefinitionTypeId | "reportDefinitionTypeId": 3 Type: Number Unique identifier for the associated ReportDefinitionType object. |
reportDefinitionTypeName | "reportDefinitionTypeName": "Sample Name" Type: String The name of the object associated with the reportDefinitionTypeId property. |
| GET | api/v5/ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET api/v5/ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 10,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 3,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 15,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 2,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 13,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | api/v5/ReportDefinition/Paged |
| Retrieve all of the ReportDefinition objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the ReportDefinition objects in a paged fashion. GET api/v5/ReportDefinition/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 21,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 14,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 10,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 5,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 20,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | api/v5/ReportDefinition/{id} |
| Retrieve an instance of the ReportDefinition object by its ID. | |
| {id} | Unique identifier for the ReportDefinition object. |
Retrieve an instance of the ReportDefinition object by its ID. GET api/v5/ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 17,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 14,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 9,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | api/v5/ReportDefinition/{id} |
| Retrieve an instance of the ReportDefinition object by its ID. | |
| {id} | Unique identifier for the ReportDefinition object. |
Retrieve an instance of the ReportDefinition object by its ID. GET api/v5/ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 24,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 6,
"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": 21,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 5,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | api/v5/ReportDefinition/{id}/Generated |
| Return a list of PDFs that have been generated by a system schedule for the specified ReportDefinition. | |
| {id} | Unique identifier for the ReportDefinition object. |
| GET | api/v5/ReportDefinition/{id}/LastGenerated |
| Return the last generated report PDF for a specified ReportDefinition regardless of how the report was generated. | |
| {id} | Unique identifier for the ReportDefinition object. |
| POST | api/v5/ReportDefinition/{id}/Render |
| Kicks off a report generation rendering request for the specified ReportDefinition. This is an asynchronous request which will return the report storage identifier where the report will be stored when it has finished its rendering. | |
| {id} | Unique identifier for the ReportDefinition object. |