Report / Folder

What can you do with ReportFolder?


Properties

Property Details
id
"id": 606
Type: Number
This is the unique numeric identifier for the ReportFolder
ownerId
"ownerId": 980
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
reportFolderId
"reportFolderId": 459
Type: Number


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
  • description
  • parentFolderId

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

Standard PATCH objects:

  • report - create, update, delete

DataFlow PATCH objects:


End Points

DELETEapi/v1/Report/Folder/{id:int}
Delete an instance of the ReportFolder object.
GETapi/v1/Report/Folder
Retrieve all of the ReportFolder objects.
GETapi/v1/Report/Folder/Detail
Retrieve all of the ReportFolder objects.
GETapi/v1/Report/Folder/Metadata
Retrieve all of the meta data details of the ReportFolder object.
GETapi/v1/Report/Folder/Metadata/{option}
Retrieve all the meta data details of the ReportFolder object based on provided options.
{option}Metadata options for the ReportFolder object.
GETapi/v1/Report/Folder/Paged
Retreive all of the ReportFolder objects in a paged fashion.
GETapi/v1/Report/Folder/Paged/Detail
Retreive all of the ReportFolder objects in a paged fashion with all object details.
GETapi/v1/Report/Folder/{id:int}
Retrieve an instance of the ReportFolder object by it's ID.
{id:int}Unique identifier for the ReportFolder object.
GETapi/v1/Report/Folder/{id:int}/Detail
Retreive all of the Detail objects for the specified ReportFolder.
{id:int}Unique identifier for the ReportFolder object.
POSTapi/v1/Report/Folder
Create a new instance of the ReportFolder object.
PUTapi/v1/Report/Folder/{id:int}
Update an existing instance of the ReportFolder object.