Filters - Get meta-schema for filter

API Url

GET

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

Permissions: user

Query parameters

Field	Type	Description
condition`optional`	String	Limit to a set of conditions (1=Equals, 2=Does not equal, 3=Begins with, 4=Ends with, 5=Contains, 6=Contains data, 7=Does not contain data).

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.
conditions	Object[]	Field conditions that can be selected.
description	String	Condition description (localized).
id	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).
input	Number	Supported input box type (0=No input box, 1=Input box with lookup, 2=Basic input box).
description	String	Filter description (localized).
fields	Object[]	Filter fields that can be selected.
conditions`optional`	Object[]	Field conditions that can be selected. If not supplied, then fallback to master conditions.
description	String	Condition description (localized).
id	String	Condition identifier.
input	Number	Supported input box type (0=No input box, 1=Input box with lookup, 2=Basic input box).
description	String	Field description (localized).
id	String	Field identifier.
parentId	String	Parent field identifier. Used for cascading values.
table	String	Table name. Used for lookup of possible values.
filterType	Number	Filter type (1=Employee, 2=Reason, 3=Account, 4=ProJect, 5=Order/Operation, 6=Workcenter, 7=Terminal).
options	Object[]	Filter options that can be selected.
default	String	Default value.
description	String	Option description (localized).
id	String	Option identifier.
values	Object[]	Option values that can be selected.
description	String	Option value description (localized).
id	String	Option value identifier.
preview	Object	Data needed for filter preview.
schema	Object[]	Column schema for filter preview.
id	String	Field mapped to the column.
order	Number	Column order from left to right.
title	String	Column header (localized).
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": {
         "filterType": 2,
         "description": "Absence reason",
         "fields": [
            {
               "id": "1",
               "description": "Reason group",
               "table": "absreasongrp",
               "parentId": "",
               "conditions": [
               {
                  "id": "1",
                  "description": "Equals",
                  "input": 1
               }
            },
            {
               "id": "2",
               "description": "Reason",
               "table": "absreason",
               "parentId": "1"
            }
         ],
         "options": [
            {
               "id": "1",
               "description": "Include",
               "default": "1",
               "values": [
                  {
                     "id": "0",
                     "description": "All"
                  },
                  {
                     "id": "1",
                     "description": "Only active"
                  }
               ]
           }
         ],
         "conditions": [
            {
               "id": "1",
               "description": "Equals",
               "input": 1
            },
            {
               "id": "2",
               "description": "Does not equal",
               "input": 1
            },
            {
               "id": "5",
               "description": "Contains",
               "input": 2
            },
            {
               "id": "6",
               "description": "Contains data",
               "input": 0
            }
         ],
         "preview": {
            "schema": [
               {
                  "id": "reasonCode",
                  "title": "Reason code",
                  "order": 10
               },
               {
                  "id": "reasonDesc",
                  "title": "Reason description",
                  "order": 20
               }
            ]
         }
      },
      "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.