Filters - Create a new filter
API Url
Create a new filter with all selected details.
http://localhost:16010/ProMarkREST/rest/General/filters
Permissions: user
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| 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). |
| fieldId | String | Field identifier. |
| values | String[] | List of selected values. |
| id | Number | Unique filter identifier. Irrelevant for new filters. |
| level | Number | Filter level (0=System, 1=User profile, 2=Personal). 0-2 |
levelIdoptional | String | Filter owner ID according to level. |
| name | String | Name of the filter. Must be unique within each filter type. |
| 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). 1-7 |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| filterid | Number | Unique filter identifier for the newly created filter. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"filterId": 123456789,"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. |
Error example:
HTTP/1.1 404 Not found{"response": {"errorCode": 100,"errorMessage": "The filter could not be found."}}