Filter

Get Filters

Queries for a list of filters using a list of parameters. The size of the result set can be retrieved by using the Get Filter Count method.

get/filter

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/filter
  • Auth: HTTP basic

Query parameters

filterIdstring

Filter by the id of the filter.

resourceTypestring

Filter by the resource type of the filter, e.g., Task.

namestring

Filter by the name of the filter.

nameLikestring

Filter by the name that the parameter is a substring of.

ownerstring

Filter by the user id of the owner of the filter.

itemCountboolean

If set to true, each filter result will contain an itemCount property with the number of items matched by the filter itself.

sortBy'filterId' | 'resourceType' | 'name' | 'owner'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The id of the filter.

resourceTypestring nullable

The resource type of the filter.

namestring nullable

The name of the filter.

ownerstring nullable

The user id of the owner of the filter.

queryobject

The query of the filter as a JSON object.

propertiesobject

The properties of a filter as a JSON object.

itemCountinteger nullable

The number of items matched by the filter itself. Note: Only exists if the query parameter itemCount was set to true

Changes

No recorded changes to this operation across all 1 revision of this API.