Filters - Get list of filters

API Url

Use it for loading the filter list (main). For all filter details, use /rest/General/filters/{id}.

GET

http://localhost:16010/ProMarkREST/rest/General/filter_list/{type}

Permissions: user

Path parameters

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

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
filterList	Object[]	Selected filter fields.
id	Number	Unique identifier of the filter.
level	Number	Filter level (0=System, 1=User profile, 2=Personal). Size range: `0-2`
levelId`optional`	String	Owner ID according to level.
name	String	Name of the filter.
protected	Boolean	Filter is read-only (true/false).
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": {
         "filterList": [
            {
               "id": 123456789,
               "name": "My new filter",
               "level": 2,
               "levelId": "JOHN"
               "protected": false
            },
            {
               "id": 987654321,
               "name": "A system filter",
               "level": 0,
               "protected": true
            },
            {
               "id": 987654321,
               "name": "A user profile filter",
               "level": 1,
               "levelId": "PR001"
               "protected": true
            }
         ]
      },
      "erorCode": 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.