Filters - Preview filter results

API Url

POST

http://localhost:16010/ProMarkREST/rest/General/filter_results

Permissions: user

Query parameters

Field	Type	Description
skip`optional`	Number	Skip a certain number of records.
take`optional`	Number	Limit the number of records to return.

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.
fieldId	String	Field identifier.
values	String[]	List of selected values.
id	Number	Unique filter identifier. Irrelevant for preview.
level	Number	Filter level (0=System, 1=User profile, 2=Personal). Irrelevant for preview. Size range: `0-2`
name	String	Name of the filter. Irrelevant for preview.
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). Size range: `1-7`

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
results	Object[]	Object containing filter results.
any	Any	Properties depend on filter schema.
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 an employee filter:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "results":[ 
            {
               "empNo": "1",
               "empName": "John Doe"
            },
            {
               "empNo": "5",
               "empName": "Michael Kors"
            }
         ]
      },
      "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.