Skip to main content

employee-attribute-definition

​
id
string

Client-generated identifier.

Required string length: 1 - 255
Pattern: ^\w{1,255}
​
type
string
Allowed value: "employee-attribute-definition"
​
url
string<uri>
​
name
string
Minimum string length: 1
​
schema
object

JSON schema of the extension value. Read more about extension definition schemas.

When creating a new extension definition, you must express its schema via referencing base schemas, e.g.:

The server responses will replace it by embedding the referenced JSON schema:

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.

​
propertyDescriptions
object | null

Required whenever this definition schema is of type "object". This property is a dictionary whose keys are the name of the schema object properties.

​
taxonomy
null | taxonomy-reference · object

Whenever the expected schema is a taxonomy-label reference, then the taxonomy these labels must belong to must be indicated.

​
isArchived
boolean

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.

​
lastArchivedAt
string<date-time> | null

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.

Example:

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

​
t9n
object
​
links
object | null
​
multipleValueHandling
object | null

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.

​
targetType
enum<string>
Available options:
employee,
employment,
job-position
​
category
enum<string>
read-only

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 by targetType (e.g. employee.givenName, jobPosition.manager). It is readable on that resource and on employee-attributes alike.
  • extension: the value is only readable on employee-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.
Available options:
system,
extension
​
isValueReadOnly
boolean
read-only

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.

​
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"