Retrieve a list

Returns a list of activity definitions for a given structure version and level.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-structure-versions/{structureVersionId}/levels/{level}/activity-definitions

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-activity-definitions.read

URL parameters

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

Field	Type	Required	Writable	Description
id	Guid	Yes	Read-only	Unique identifier (GUID) for the activity definition.
structureVersion	Guid	Yes	Read-only	Identifier for the activity structure version. Links the definition to a specific structure configuration.
level	integer	Yes	Read-only	Level of the activity definition in the configured structure.
changeVersion	string	—	Read-only	Property to indicate the order of changes.
name.default	string	Yes	Yes	Default name value of the activity definition. Shown to users if no translation is available.
name.translations	object	No	Yes	A list of translated names by language code. Allows localization for different languages.
parent.id	Guid	No	Yes	Unique identifier of the parent activity definition in a hierarchy set-up.
parent.externalReferences	object	No	—	External references for the parent activity definition (when external references are requested).
shortCode	string	No	Yes	Short code for the activity definition.
dataEntryCode	string	No	Yes	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	No	Yes	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	No	Yes	Additional information about the activity definition. Can be used for notes or extra details.
activeFrom	date	No	Yes	Start date (YYYY-MM-DD) when the activity definition is active. Controls when the definition becomes available for registrations.
activeUntil	date	No	Yes	End date (YYYY-MM-DD) when the activity definition is no longer active. Controls when the definition is no longer available.

This endpoint does not support the expand query parameter. To retrieve usages and restrictions, use the GET single endpoint or the dedicated usages/restrictions endpoints.

Pagination

This endpoint supports pagination via continuationToken. The response includes a continuationToken field when more results are available. Pass it as a query parameter to retrieve the next page.

Filters

This endpoint does not support any filter parameters. Delta synchronization is not available for this collection.

External references

The endpoint supports predefined and custom external references. See the external references page for details.

The following collections are supported for this endpoint:

Collection	Predefined	Custom
activity-definitions	@data-entry-code, @external-reference	Supported

Error responses

Status code	Description
401	Unauthorized. The bearer token is missing, expired, or invalid.

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)