TAG LINE
SMALL TITLE

Report Definition

(API Version v3)


What can you do with ReportDefinition?


Properties

Property Details
identity
READ-ONLY
"identity": 27
Type: Number
This is the unique numeric identifier for the ReportDefinition
ownerId
READ-ONLY
"ownerId": 20
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
"name": "Hello World"
Type: String
reportFolderId
"reportFolderId": 6
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
"title": "Hello World"
Type: String
repeatTitle
"repeatTitle": true
Type: Boolean
isLocked
"isLocked": true
Type: Boolean
isActive
"isActive": true
Type: Boolean
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": 7
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
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
updatedByUserId
"updatedByUserId": 27
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": 14
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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

GETapi/v3/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/v3/ReportDefinition/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 26,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "reportFolderId": 16,
        "reportFolderName": "Sample Text Data",
        "title": "Sample Text Data",
        "repeatTitle": true,
        "isLocked": true,
        "isActive": true,
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 18,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 5,
        "updatedByUserName": "Sample Text Data",
        "reportDefinitionTypeId": 1,
        "reportDefinitionTypeName": "Sample Text Data"
    }
}
GETapi/v3/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/v3/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/v3/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.