Retrieve an employee-attribute-definition

curl --request GET \
  --url https://{host}/lucca-api/employee-attribute-definitions/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/employee-attribute-definitions/{id}"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/employee-attribute-definitions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employee-attribute-definitions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employee-attribute-definitions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{host}/lucca-api/employee-attribute-definitions/{id}")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employee-attribute-definitions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "e_tShirtSize",
  "type": "employee-attribute-definition",
  "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/e_tShirtSize",
  "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",
  "category": "extension",
  "isValueReadOnly": false,
  "links": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

GET

lucca-api

employee-attribute-definitions

{id}

Retrieve an employee-attribute-definition

curl --request GET \
  --url https://{host}/lucca-api/employee-attribute-definitions/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/employee-attribute-definitions/{id}"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/employee-attribute-definitions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/employee-attribute-definitions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/employee-attribute-definitions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{host}/lucca-api/employee-attribute-definitions/{id}")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/employee-attribute-definitions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "e_tShirtSize",
  "type": "employee-attribute-definition",
  "url": "https://example.ilucca.net/lucca-api/employee-attribute-definitions/e_tShirtSize",
  "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",
  "category": "extension",
  "isValueReadOnly": false,
  "links": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.

Access

OAuth 2.0 scopes

 employee-attribute-definitions.readonly

 employee-attribute-definitions.readwrite

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

FlowClient Credentials

Token URL: https://accounts.world.luccasoftware.com/connect/token

Scopes1

employee-attribute-definitions.readonly

Read [employee-attribute-definitions](/api-reference/latest/employee-attributes/employee-attribute-definition).

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Path Parameters

string

required

Identifier of the employee-attribute-definition.

Minimum string length: 1

Query Parameters

include

enum<string>[]

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 be null when 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.

Response

An employee-attribute-definition resource.

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

{
  "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
        }
    }
  }
}

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.

Show child attributes

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.

Show child attributes

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.

Examples:

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

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

t9n

object

Show child attributes

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.

Show child attributes

targetType

enum<string>

Available options:

employee,

employment,

job-position

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

Retrieve an employee-attribute-definition

Authorizations

Headers

Path Parameters

Query Parameters

Response