ProReport - Get report instance filters

API Url

Will return the filters used when running the specified report. There will be no filter ID since this is a copy, not a reference!

GET
http://localhost:16010/ProMarkREST/rest/ProReport/repository/{id}/filters

Permissions: user

Path parameters

FieldTypeDescription
idString

Unique identifier of the report instance.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    fieldsObject[]

Selected filter fields.

      conditionString

Condition identifier (1=Equals, 2=Does not equal, 3=Begins with, 4=Ends with, 5=Contains, 6=Contains data, 7=Does not contain data).

      fieldIdString

Field identifier.

      valuesString[]

List of selected values.

    levelNumber

Filter level (0=System, 1=User profile, 2=Personal).

Size range: 0-2
    nameString

Name of the filter.

    optionsObject[]

Selected filter options.

      idString

Option identifier.

      valueString

Option value.

    typeNumber

Filter type (1=Employee, 2=Reason, 3=Account, 4=ProJect, 5=Order/Operation, 6=Workcenter, 7=Terminal).

Size range: 1-7
  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"filters": [
{
"name": "My departments",
"level": 2,
"type": 1,
"fields": [
{
"fieldId": "19",
"condition": "1",
"values": [ "Accounting", "Reporting" ]
}
],
"options": [
{
"id": "1",
"value": "0"
}
]
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

HTTP/1.1 404 Not found
{
"response": {
"filters": []
"errorCode": 285,
"errorMessage": "The report could not be found. Maybe it was deleted by another user."
}
}