Skip to main content

The employee-extension resource represents the definition of an extension property to the base models regarding employee records.

It defines the type and behavior of said extension. extension-definition

​
name
string
required
Minimum length: 1
​
schema
object
required

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.:

{
  "schema": {
    "$ref": "/lucca-api/schemas/taxonomy-label-reference"
  }
}

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

{
  "schema": {
    "$id": "/lucca-api/schemas/taxonomy-label-reference",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "taxonomy-label-reference",
    "type": ["object", "null"],
    "additionalProperties": false,
    "required": ["id"],
    "properties": {
        "id": {
            "type": "string",
            "minLength": 1
        },
        "type": {
            "type": "string",
            "const": "taxonomy-label",
            "readOnly": true
        },
        "url": {
            "type": "string",
            "format": "uri",
            "readOnly": "true"
        }
    }
  }
}
​
multipleValueHandling
object | null
required

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.

​
id
string

Client-generated identifier. Employee extension definitions id must start with e_ for legacy reasons.

Required string length: 3 - 255
​
type
string
Allowed value: "employee-extension-definition"
​
url
string<uri>
​
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
object | null

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

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

Examples:

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

​
t9n
object
​
links
object | null