Filters - Create a new filter

API Url

Create a new filter with all selected details.

POST
http://localhost:16010/ProMarkREST/rest/General/filters

Permissions: user

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    fieldsObject[]

Selected filter fields.

      conditionString

Condition identifier (1=Equals, 2=Does not equal, 3=Begins with, 4=Ends with, 5=Contains, 6=Contains data, 7=Does not contain data).

      fieldIdString

Field identifier.

      valuesString[]

List of selected values.

    idNumber

Unique filter identifier. Irrelevant for new filters.

    levelNumber

Filter level (0=System, 1=User profile, 2=Personal).

Size range: 0-2
    levelIdoptionalString

Filter owner ID according to level.

    nameString

Name of the filter. Must be unique within each filter type.

    optionsObject[]

Selected filter options.

      idString

Option identifier.

      valueString

Option value.

    typeNumber

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

Size range: 1-7

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  filteridNumber

Unique filter identifier for the newly created filter.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"filterId": 123456789,
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

HTTP/1.1 404 Not found
{
"response": {
"errorCode": 100,
"errorMessage": "The filter could not be found."
}
}