Filter

Get Single Filter

Retrieves a single filter by id, according to the Filter interface in the engine.

get/filter/{id}

Request

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

Path parameters

idstring required

The id of the filter to be retrieved.

Query parameters

itemCountboolean

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

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.