Organization
Employee Records
BETAEvents & Webhooks
BETA{
"summary": "employee-attribute-definition example",
"description": "employee-attribute-definition example",
"value": {
"id": "e_tShirtSize",
"type": "employee-extension-definition",
"url": "https://example.ilucca.net/lucca-api/employee-extension-definitions/12",
"name": "T-shirt size",
"multipleValueHandling": null,
"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
}
}
},
"taxonomy": {
"id": "45",
"type": "taxonomy",
"url": "https://example.ilucca.net/lucca-api/taxonomies/45"
},
"t9n": {
"name": {
"fr-FR": "Taille de t-shirt"
}
},
"targetType": "employee",
"links": {}
}
}The employee-attribute-definition resource
employee-attribute-definition
Client-generated identifier.
1 - 255^\w{1,255}"employee-attribute-definition"1JSON 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"
}
}
}
}
JSON schema of the applicable resources this definition only applies to.
Required whenever this definition schema is of type "object". This property is a dictionary whose keys are the name of the schema object properties.
Show child attributes
Show child attributes
Whenever the expected schema is a taxonomy-label reference, then the taxonomy these labels must belong to must be indicated.
Show child attributes
Show child attributes
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.
"2023-01-23T12:45:23.1234Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
employee, employment, job-position Was this page helpful?