Filters - Get global filter

API Url

Use it for loading all selected details for the current global filter.

GET

http://localhost:16010/ProMarkREST/rest/General/global-filters

Permissions: user

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
fieldId	String	Field identifier.
filters	Object[]	Global filters.
active	Boolean	Filter enabled/disabled.
fields	Object[]	Selected filter fields.
condition	String	Condition identifier (1=Equals, 2=Does not equal, 3=Begins with, 4=Ends with, 5=Contains, 6=Contains data, 7=Does not contain data).
values	String[]	List of selected values.
id	Number	Unique filter identifier.
level	Number	Filter level (0=System, 1=User profile, 2=Personal).
levelId`optional`	String	Filter owner according to level.
name	String	Name of the filter.
options	Object[]	Selected filter options.
id	String	Option identifier.
value	String	Option value.
type	Number	Filter type (1=Employee, 2=Reason, 3=Account, 4=ProJect, 5=Order/Operation, 6=Workcenter, 7=Terminal). The global filter is always an employee filter.
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:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "filters": [
            {
               "active": true,
               "id": 123456789,
               "name": "My departments",
               "level": 2,
               "levelId": "John",
               "type": 1,
               "fields": [
                  {
                     "fieldId": "19",
                     "condition": "1",
                     "values": [ "Accounting", "Reporting" ]
                  }
               ],
               "options": [
                  {
                     "id": "1",
                     "value": "0"
                  }
               ]
            }
         ]
      },
      "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.