Replace an employee-attribute-definition
Replace an employee-attribute-definition.
Only the custom definitions, created by your organization, can be updated: any other definition returns a 400 with the attribute-definition-not-editable error. The base schema of schema cannot change.
Unlike PATCH, the request body replaces the whole definition: an omitted isArchived unarchives it, an omitted multipleValueHandling makes it single-valued, and omitted translations are removed.
Example request body, with a schema referencing a Lucca base schema:
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-definition.
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-definition.
The full representation of the employee-attribute-definition.
1JSON schema of the attribute value, in the same form as on creation. Its base schema cannot change: for an object value, every existing property must be kept with the same base schema, and only new properties can be added.
Required whenever this definition schema is of type "object". This property is a dictionary whose keys are the name of the schema object properties.
When false, resource is not archived. When true, resource is archived.
You can update this property in order to set the archival status of the resource.
Behavior regarding multiple extension values per single extended resource. When null, then only a single extension can exist for any extended resource. Multiple extensions may be accepted otherwise.
Example: "employee's children" would accept multiple value, when "employee's blood type" would not.
Response
OK
The updated employee-attribute-definition resource.
Client-generated identifier.
1 - 255^\w{1,255}"employee-attribute-definition"1JSON schema of the attribute value. Read more about employee attribute definition schemas.
The schema embeds the base schema it is built on, identified by its $id, e.g.:
Definitions based on the same base schema all embed it with the same $id, and identical $ids always denote identical schemas. If you register these schemas in a JSON Schema validator (e.g. to validate values before writing them), register each $id once: registering it again makes validators such as Ajv fail with a "schema already exists" error.
Required whenever this definition schema is of type "object". This property is a dictionary whose keys are the name of the schema object properties.
Whenever the expected schema is a taxonomy-label reference, then the taxonomy these labels must belong to must be indicated.
When false, resource is not archived. When true, resource is archived.
You can update this property in order to set the archival status of the resource.
Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.
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"
Behavior regarding multiple extension values per single extended resource. When null, then only a single extension can exist for any extended resource. Multiple extensions may be accepted otherwise.
Example: "employee's children" would accept multiple value, when "employee's blood type" would not.
employee, employment, job-position Read-only. Which API surface exposes the values of this definition, regardless of who provides them.
system: the value is a property of the primary resource named bytargetType(e.g.employee.givenName,jobPosition.manager). It is readable on that resource and onemployee-attributesalike.extension: the value is only readable onemployee-attributes. It is absent from every primary resource representation. This covers definitions created by your organization as well as definitions added by a Lucca application.
system, extension Read-only. Whether the values of this definition can be modified through the Lucca API.
false only promises that an existing value may be modified: creating a value or deleting an occurrence have their own conditions. This flag describes what the account exposes, not the rights of the caller: a write on a false definition may still be denied with 403.
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"
No embedded resources on a employee-attribute-definition(s) response. Expect an empty object if embedded are requested.