Report

What can you do with Report?


Properties

Property Details
id
"id": 883
Type: Number
This is the unique numeric identifier for the Report
ownerId
"ownerId": 614
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
title
"title": "Hello World"
Type: String
dataSourceId
"dataSourceId": 933
Type: Number
Unique identifier for the associated DataSource object.
isLocked
"isLocked": true
Type: Boolean
reportFolderId
"reportFolderId": 935
Type: Number
Unique identifier for the associated ReportFolder object.
showDetails
"showDetails": true
Type: Boolean
reportTypeId
"reportTypeId": 359
Type: Number
Unique identifier for the associated ReportType object.
repeatTitle
"repeatTitle": true
Type: Boolean
chartId
"chartId": 81
Type: Number
Unique identifier for the associated Chart object.
generateServerSide
"generateServerSide": true
Type: Boolean
isLive
"isLive": true
Type: Boolean


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
  • title
  • dataSourceId
  • isLocked
  • reportFolderId
  • showDetails
  • reportTypeId
  • repeatTitle
  • chartId
  • generateServerSide
  • isLive

Patch Types

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 Report object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Report/{id:int}
Delete an instance of the Report object.
GETapi/v1/Report
Retrieve all of the Report objects.
GETapi/v1/Report/Metadata
Retrieve all of the meta data details of the Report object.
GETapi/v1/Report/Metadata/{option}
Retrieve all the meta data details of the Report object based on provided options.
{option}Metadata options for the Report object.
GETapi/v1/Report/Paged
Retreive all of the Report objects in a paged fashion.
GETapi/v1/Report/Paged/Detail
Retreive all of the Report objects in a paged fashion with all object details.
GETapi/v1/Report/Preview/DataSource/{id:int}
Retrieve an instance of the Report object by it's ID.
{id:int}Unique identifier for the Report object.
GETapi/v1/Report/{id:int}
Retrieve an instance of the Report object by it's ID.
{id:int}Unique identifier for the Report object.
GETapi/v1/Report/{id:int}/Detail
Retreive all of the Detail objects for the specified Report.
{id:int}Unique identifier for the Report object.
PATCHapi/v1/Report/{id:int}
Update the Report object and optionally make changes to any child objects.
POSTapi/v1/Report
Create a new instance of the Report object.
POSTapi/v1/Report/{id:int}/Generate
Create a new instance of a Generate object that belongs to the Report.
{id:int}Unique identifier for the Report object.
POSTapi/v1/Report/{id:int}/Generate/Count
Create a new instance of a Generate/Count object that belongs to the Report.
{id:int}Unique identifier for the Report object.
POSTapi/v1/Report/{id:int}/Generate/Paged
Create a new instance of a Generate/Paged object that belongs to the Report.
{id:int}Unique identifier for the Report object.
PUTapi/v1/Report/{id:int}
Update an existing instance of the Report object.