Report / Filter

What can you do with ReportFilter?


Properties

Property Details
id
"id": 665
Type: Number
This is the unique numeric identifier for the ReportFilter
ownerId
"ownerId": 68
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
operatorTypeId
"operatorTypeId": 748
Type: Number
Unique identifier for the associated OperatorType object.
reportId
"reportId": 352
Type: Number
Unique identifier for the associated Report object.
dataSourceColumnId
"dataSourceColumnId": 581
Type: Number
Unique identifier for the associated DataSourceColumn object.
value
"value": "Hello World"
Type: String
isRequired
"isRequired": true
Type: Boolean
sortOrder
"sortOrder": 376
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
  • operatorTypeId
  • reportId
  • dataSourceColumnId
  • value
  • isRequired
  • sortOrder

DataFlow PATCH objects:


End Points

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