- style
List Timers
UNDER DEVELOPMENT
Service Application Warning
Timer endpoints all operate from the current user and because of this are not available to service applications. If this restriction impacts your business model, please contact support and we will consider opening certain timer access up to service applications by requiring a staff id.
Service applications can list all the timers in the deployment. Installed and web application types can only list the current user's timers.
The following endpoint can be used to list timers.
GET /timers
Parameters
Table of allowed parameters.
| _page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
|---|---|---|
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
| _offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page. |
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
| _filters | partial string |
Filtering Timers
You can filter the returned list using the _filters parameter.
| Name | Example | Description |
|---|---|---|
| against_id(<ids>) | against_id(12,32) | Only return timers against one of the given object ids |
| against_type(<types>) | against_types(company,job) | Only return timers against one of the given object types. |
| against(<type>(<ids>)) | against(company(12,32),job(21)) | Only return timers against the given against type and id. |
| min_id(<id>) | min_id(12) | Only return issues with ids greater or equal to |
| max_id(<id>) | max_id(120) | Only return issues with ids less or equal to |
| order_by_asc(<value>), order_by_desc(<value>) | order_by_desc(id) | Accepts: id |
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)
| _filters=id_greater_than(5) | Available fields: id |
Handling the response
Please see the get timer for controlling the response.