Retrieve a list
Introduction
Returns a list of all activity definitions for a given activity structure version and level.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-structure-versions/{structureVersionId}/levels/{level}/activity-definitions
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<structureVersionId> |
The ID of the activity structure. Can be found in the configuration in myProtime. |
<level> |
Defines the level in the structure. |
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
string | Unique identifier for the activity definition. |
structureVersion |
string | Identifier for the activity structure version. Links the definition to a specific structure configuration. |
level |
integer | Level of the activity definition in the configured structure. |
canConfigureRestrictions |
boolean | Indicates if restrictions can be configured for this definition. |
name.default |
string | Default name value of the activity definition. Shown to users if no translation is available. |
name.translations |
string | A list of translated names by language code. Allows localization for different languages. |
parent.id |
string | Unique identifier of the parent activity definition in a hierarchy set-up. Can only be set during creation! |
shortCode |
string | Short code for the activity definition. |
dataEntryCode |
string | Data entry code for the activity definition, mostly used on hardware devices. Mandatory or optional depending on configuration. Can only be 16 characters long! |
externalReference |
string | External reference identifier for the activity definition. Needs to be unique within the structure and level when used! Can only be 16 characters long! |
info |
string | Additional information about the activity definition. Can be used for notes or extra details. |
activeFrom |
string | Start date (YYYY-MM-DD) when the activity definition is active. Controls when the definition becomes available for registrations. |
activeUntil |
string | End date (YYYY-MM-DD) when the activity definition is no longer active. Controls when the definition is no longer available. |
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
Retrieve all activity definitions
Example retrieving all activity definitions for a structure and level:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-structure-versions/1604fc20-8bf2-449f-83d9-1f3092283646/levels/1/activity-definitions
Retrieve with external references in response
Example retrieving the list with external references in the response:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-structure-versions/1604fc20-8bf2-449f-83d9-1f3092283646/levels/2/activity-definitions?externalReferences=(activity-definitions,@data-entry-code)