Historical fields
Introduction
It is possible to retrieve historical fields. These subcollections are available via separate endpoints.
In the endpoints, the term PersonReference refers to a person identifier, which can be either an internal ID or an external reference.
Check the Swagger page for more technical information on the endpoints.
Properties
| Property | Type | Description |
|---|---|---|
id |
integer | Internal unique identifier for the historical field record. |
person.id |
integer | Internal unique identifier for the person. |
from |
string | Start date of the historical field record (YYYY-MM-DD). |
until |
string | End date of the historical field record (if applicable; until infinity if empty) (YYYY-MM-DD). |
historicalFieldCategory.id |
integer | Unique identifiers for the historical field catalog record. |
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.
Historical field categories
The options for currently supported historical field categories are the following:
| Category | Identifier |
|---|---|
| departments | department |
| employers | employer |
| jobs | job |
| job categories | job-category |
| sectors | sector |
| work locations | work-location |
Endpoints
Below you can find the supported endpoints for this data collection.
GET the history of an historical field
You can retrieve this information for one person:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/{PersonReference}/{HistoricalFieldCategoryIdentifier}-history
Example to request the history of departments for person ‘1238’:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/1238/department-history
It’s also possible to retrieve this for the whole population:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/{HistoricalFieldCategoryIdentifier}-histories
Example to request the history of departments for the whole population:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/department-histories