TAG LINE
TAG LINE
SMALL TITLE
List of reports that have been defined in the system.
identity READ-ONLY | "identity": 0 Type: Number This is the unique numeric identifier for the ReportDefinition |
ownerId READ-ONLY | "ownerId": 22 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": 10 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": 4 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": 5 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": 17 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. |
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:
| DELETE | ReportDefinition/{id} |
| Delete an instance of the ReportDefinition object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ReportDefinition object. |
Delete an instance of the ReportDefinition object. DELETE ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "reportDefinition"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 8,
"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": 23,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 17,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 21,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 12,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 4,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 6,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 27,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 7,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 27,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 20,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 21,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 22,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 22,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 11,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 16,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/ |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 18,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 20,
"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": 13,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 6,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/Metadata |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/Metadata HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 21,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 21,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 16,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 11,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 5,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | ReportDefinition/Metadata/sql |
| Retrieve all of the ReportDefinition objects. | |
Retrieve all of the ReportDefinition objects. GET ReportDefinition/Metadata/sql HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 23,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 19,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 8,
"reportDefinitionTypeName": "Sample Text Data"
}
]
} | |
| GET | 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 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": 15,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 9,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 22,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 17,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 23,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | 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 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": 2,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 20,
"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": 6,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 16,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | 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 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": 13,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 10,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 27,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 7,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | 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 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": 11,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 15,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 6,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 6,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | 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 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": 18,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 25,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 13,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 20,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| GET | ReportDefinition/Paged/Detail |
| Retrieve all of the ReportDefinition objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the ReportDefinition objects in a paged fashion with all object details. GET ReportDefinition/Paged/Detail 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": 11,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 18,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 19,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 23,
"reportDefinitionTypeName": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 1,
"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": 8,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 1,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 27,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 4,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 5,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 23,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 6,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 10,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 1,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 5,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 15,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 18,
"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": 14,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 6,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 10,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 26,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 10,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 16,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 4,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 0,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 16,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 12,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 17,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 23,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 14,
"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": 16,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 25,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 4,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 16,
"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": 5,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 4,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 2,
"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": 24,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 13,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | 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 ReportDefinition/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 27,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 19,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 8,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 9,
"reportDefinitionTypeName": "Sample Text Data"
}
} | |
| GET | ReportDefinition/{id}/Detail |
| Retrieve deep detail of the ReportDefinition object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the ReportDefinition object. |
Retrieve deep detail of the ReportDefinition object by its ID. GET ReportDefinition/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 0,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 3,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 11,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 7,
"reportDefinitionTypeName": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| GET | 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 | 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 | 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 | 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 | 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 | 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. |
| GET | 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. |
| GET | 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. |
| GET | 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. |
| GET | 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. |
| PATCH | ReportDefinition/{id} |
| Update or Add the ReportDefinition object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the ReportDefinition object. |
Update or Add the ReportDefinition object and optionally make changes to any child objects. PATCH ReportDefinition/{id}
{
"details": {},
"reportDefinitions": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"reportFolderId": 4,
"createdByUserId": 21,
"updatedByUserId": 7,
"reportDefinitionTypeId": 20
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "reportDefinition",
"instance": {
"identity": 1,
"ownerId": 23,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 21,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 7,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 8,
"reportDefinitionTypeName": "Sample Text Data"
}
}
]
}
} | |
| POST | ReportDefinition/ |
| Create a new instance of the ReportDefinition object. | |
Create a new instance of the ReportDefinition object. POST ReportDefinition/
{
"reportFolderId": 2,
"createdByUserId": 22,
"updatedByUserId": 20,
"reportDefinitionTypeId": 17
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 1,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 2,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 13,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 0,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |
| POST | 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. |
| POST | 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. |
| POST | 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. |
| POST | 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. |
| POST | 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. |
| PUT | ReportDefinition/{id} |
| Update an existing instance of the ReportDefinition object. | |
Update an existing instance of the ReportDefinition object. PUT ReportDefinition/{id}
{
"identity": 1,
"reportFolderId": 21,
"createdByUserId": 15,
"updatedByUserId": 15,
"reportDefinitionTypeId": 9
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 26,
"ownerName": "Sample Text Data",
"name": "Montly Sales Summary",
"reportFolderId": 23,
"reportFolderName": "Sample Text Data",
"title": "Montly Sales Results",
"repeatTitle": true,
"isLocked": true,
"isActive": true,
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 8,
"createdByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 13,
"updatedByUserName": "Sample Text Data",
"reportDefinitionTypeId": 2,
"reportDefinitionTypeName": "Sample Text Data"
}
]
}
} | |