Retrieve an employee-attribute
Retrieve a single employee-attribute by ID.
Access
Access
EstablishmentsThis API endpoint will filter out results based on accessible business-establishments.You may only access employee-attributes of employees whose applicable business-establishments are accessible to you.
ClaimsThis API endpoint will filter out results based on accessible claims.Each employee-attribute is associated with specific an employee directory “section”. You may only access employee-attributes attached to sections that are accessible to you.
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Set the API version.
2024-11-01 "2024-11-01"10"2024-11-01"
Query Parameters
Include metadata:
embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links: links to related resources or actions (e.g. approving a leave-request). May benullwhen you do not have access to the resource (or action). Includes the download links of the files the resource references, underlinks.files.totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
embedded, links, totalCount Response
OK
An employee-attribute resource.
Reference to an employment resource.
Reference to a job-position resource.
The time window during which this attribute value applies to the employee.
Two periods are exposed side by side:
start/enddescribe 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/strictEnddescribe 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, e_tShirtSize), 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.
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.
"2023-01-23T12:45:23.1234567+00:00"
"2023-01-23T12:45:23.1234Z"