Update an employee-attribute
Update an employee-attribute.
The value is replaced as a whole: for an object value, send all its properties, including the unchanged ones.
Access
Access
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"
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Path Parameters
Identifier of the employee-attribute.
1Query 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).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 Body
Representation of an employee-attribute.
The representation of the employee-attribute to update.
Response
OK
The updated employee-attribute resource.
1"employee-attribute"Reference to an employee 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, 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.
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.
"2023-01-23T12:45:23.1234567+00:00"
"2023-01-23T12:45:23.1234Z"
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"
Embeds the representation of resources related to the employee-attribute(s).
Only returned if requested by the API client: ?include=embedded.