Get Filter Count
Retrieves the number of filters that fulfill a provided query. Corresponds to the size of the result set when using the Get Filters method.
Method
GET /filter/count
Parameters
Query Parameters
Name | Description |
---|---|
filterId | Restrict to filters that have the given id. |
resourceType | Restrict to filters that have the given resource type, e.g., Task . |
name | Restrict to filters that have the given name. |
nameLike | Restrict to filters that have a name with the given parameter value as substring. |
owner | Restrict to filters that the given user owns. |
Result
A JSON object with a single count property.
Name | Value | Description |
---|---|---|
count | Number | The number of filters that fulfill the query criteria. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
400 | application/json |
Returned if some of the query parameters are invalid, for example if a sortOrder
parameter is supplied, but no sortBy , or if an invalid operator for variable
comparison is used. See the Introduction for the
error response format.
|
Example
Request
GET /filter/count?resourceType=Task&owner=aUserId
Response
Status 200.
{
"count": 3
}