Retrieve a counter group
Introduction
You can retrieve a counter group by the internal ID or an external reference using the GET call. Internal IDs for counter groups can be found by listing all counter groups using the GET collection endpoint.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-groups/{counterGroupReference}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<counterGroupReference> |
The internal ID or external reference of the counter group. |
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 group. |
name.default |
string | Default name value of the counter group. |
name.translations |
object | A list of translated names of the counter group by language code. |
External references
It’s possible to use custom external references. More information can be found on the External References Page
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Caution
There are some restrictions on the characters allowed in URL requests. See the fetching resources page for more information.
Examples
Retrieving a counter group by internal ID
Example with internal ID 2:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-groups/2
With custom external reference
Example with custom external reference OVERTIME-GROUP:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/counter-groups/OVERTIME-GROUP?externalReferences=(counter-groups,customCounterGroupCode)