ProReport - Get report filters

API Url

Will return the filters supported by the specified report.

GET

http://localhost:16010/ProMarkREST/rest/ProReport/reports/{id}/specifications/filters

Permissions: user

Path parameters

Field	Type	Description
id	String	Report unique identifier.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
filterSpec	Object[]	Filter specifications
balanceType`optional`	Object[]	Balance type
default	Number	Default balance type
options	Object[]	Balance type options
description	String	Balance type description
id	Number	Balance type id (1=Latest closed period, 2=Current and future periods, 3=Oldest open period, 4=Current period, 5=A given cutoff time )
filterType	Number	Filter type (1=Employee, 2=Reason, 3=Account, 4=ProJect, 5=Order/Operation, 6=Workcenter, 7=Terminal).
reportId	String	Report unique identifier.
showFrom`optional`	Boolean	Show "Period start". Only valid for "Time" filter, aka period selection.
showTo`optional`	Boolean	Show "Period end". Only valid for "Time" filter, aka period selection.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example for 'AccBalance03':

HTTP/1.1 200 OK
{
   "response": {
      "filterSpec": [
         {
            "reportId": "AccBalance03",
            "filterType": 3
         },
         {
            "reportId": "AccBalance03",
            "filterType": 1
         },
         {
            "reportId": "AccBalance03",
            "filterType": 0,
            "showFrom": true,
            "showTo": true
         }
      ],
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.