Definitions
Activity definitions are the core entities that define what activities can be tracked in the system. Each definition contains information such as names, codes, references, and validity periods.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoints
Below you can find the supported endpoints for activity definition operations:
External references
The activity-definitions collection supports both predefined and custom external references. More information can be found on the External References Page.
| Type | External reference | Description |
|---|---|---|
| Predefined | @data-entry-code |
The data entry code configured in Protime for the activity definition. |
| Predefined | @external-reference |
The external reference identifier configured for the activity definition. |
| Custom | customActivityCode |
A custom key-value pair managed by the 3rd party. |
Usage in other collections
Activity-definitions external references can also be used in the following collections:
Predefined example:
?externalReferences=(activity-definitions,@data-entry-code)
Custom example:
?externalReferences=(activity-definitions,customActivityCode)