Skip to main content

An employee-attribute represents a single property value of an employee or any of their directly related resources.

It can be:

  • a property of the employee resource;
  • a property of their employment resources;
  • a property of their job-position resource;
  • an extension property of any of these resources, either user-defined or application-defined.

Such representation makes it possible to retrieve all attributes of an employee in a uniform manner.

​
id
string
Minimum string length: 1
​
type
string
Allowed value: "employee-attribute"
​
url
string<uri>
​
definition
employee-attribute-definition-reference · object
​
employee
employee-reference · object

Reference to an employee resource.

​
employment
employment-reference · object | null

Reference to an employment resource.

​
jobPosition
job-position-reference · object | null

Reference to a job-position resource.

​
applicability
null | object

The time window during which this attribute value applies to the employee.

Two periods are exposed side by side:

  • start / end describe the computed period. It is stretched to cover the gaps between two consecutive resources, so that the history of an attribute reads as an uninterrupted timeline. As a result it may span periods during which the employee had no contract at all.
  • strictStart / strictEnd describe the strict period, inherited from the source resource (employment, job-position) without any gap filling. Use it whenever contractual accuracy matters, typically to build point-in-time reports.

A null lower bound must be interpreted as "since the beginning of time", and a null upper bound as "until the end of time".

If the attribute has no temporal dimension (e.g. employee.givenName, custom extensions), all four dates are null. It must be interpreted as "applies indefinitely".

The applicability.asOf and applicability.strictAsOf query parameters can be used to filter by date, on the computed and on the strict period respectively.

​
value
​
createdAt
string<date-time>

Read-only. UTC timestamp of the moment this object was created. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

​
lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

​
links
object