Filters - Update/Create global filter

API Url

Use it for creating a new global filter or for editing the existing one.

PUT
http://localhost:16010/ProMarkREST/rest/General/global-filters

Permissions: user

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    filtersObject[]

Global filters to update.

      activeBoolean

Filter enabled/disabled.

      adHocBoolean

True if the filter is adHoc.

      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. Not relevant; used only for object consistancy.

      levelNumber

Filter level (0=System, 1=User profile, 2=Personal). Not relevant; used only for object consistancy.

      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). Type should be always 1, the global filter is an employee filter.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.