TAG LINE
SMALL TITLE

Report Definition

(API Version v4)


List of reports that have been defined in the system.


What can you do with ReportDefinition?


Properties

Property Details
identity
READ-ONLY
"identity": 3
Type: Number
This is the unique numeric identifier for the ReportDefinition
ownerId
READ-ONLY
"ownerId": 5
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": 24
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": 1
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": 11
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": 15
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.


End Points

GETapi/v4/ReportDefinition/
Retrieve all of the ReportDefinition objects.
Retrieve all of the ReportDefinition objects.
GET api/v4/ReportDefinition/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 1,
            "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": 21,
            "createdByUserName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "updatedByUserId": 21,
            "updatedByUserName": "Sample Text Data",
            "reportDefinitionTypeId": 3,
            "reportDefinitionTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/ReportDefinition/Paged
View Sample Response
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": 9,
                "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": 4,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 22,
                "updatedByUserName": "Sample Text Data",
                "reportDefinitionTypeId": 12,
                "reportDefinitionTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/ReportDefinition/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 17,
        "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": 3,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 3,
        "updatedByUserName": "Sample Text Data",
        "reportDefinitionTypeId": 16,
        "reportDefinitionTypeName": "Sample Text Data"
    }
}
GETapi/v4/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/v4/ReportDefinition/{id}
View Sample Response
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": 23,
        "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": 18,
        "updatedByUserName": "Sample Text Data",
        "reportDefinitionTypeId": 20,
        "reportDefinitionTypeName": "Sample Text Data"
    }
}
GETapi/v4/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.
GETapi/v4/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.
POSTapi/v4/ReportDefinition/Search
Retreive a list of ReportDefinition objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of ReportDefinition objects based on search criteria.
POST api/v4/ReportDefinition/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 15,
            "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": 6,
            "createdByUserName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "updatedByUserId": 15,
            "updatedByUserName": "Sample Text Data",
            "reportDefinitionTypeId": 14,
            "reportDefinitionTypeName": "Sample Text Data"
        }
    ]
}
POSTapi/v4/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.