Retrieve a list
Introduction
You can retrieve a list of counter definitions using a filter.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-definitions
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Internal unique identifier for the counter definition. |
name.default |
string | Default name value of the counter definition. |
name.translations |
object | A list of translated names of the definition by language code. |
code |
string | A counter code used for this definition. |
friendlyName.default |
string | Default friendly name value for this definition shown to users. |
friendlyName.translations |
object | A list of translated friendly names by language code. |
friendlyCode.default |
string | Default friendly code value for this definition shown to users. |
friendlyCode.translations |
object | A list of translated friendly codes by language code. |
isEnabled |
boolean | Indicates if the counter definition is enabled in myProtime. |
counterGroup.id |
integer | The ID of the associated counter group. |
unit |
string | The unit type for the counter definition (Unknown, Interval, Duration, Instance). |
Filters
This list of filters can be used for this endpoint.
| Filter | Type | Description |
|---|---|---|
counter-group |
Optional | Filter by one or more counter groups |
enabled |
Optional | Filter by enabled status (true or false) |
Check the Fetching Resources page on how to use the filter.
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Retrieving all counter definitions
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-definitions
Retrieving with filter
Example with enabled counter definitions and a counter definition group:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-definitions?filter=enabled eq true and counter-definition-group in (1)