List AxisSections

curl --request GET \
  --url https://{host}/api/v3/axisSections \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": {
      "code": "<string>",
      "multilingualName": "<string>",
      "axisId": 123,
      "id": 2,
      "name": "<string>",
      "url": "<string>",
      "description": "<string>",
      "ownerId": 123,
      "startOn": "2023-11-07T05:31:56Z",
      "endOn": "2023-11-07T05:31:56Z",
      "active": true,
      "parentAxisSections": [
        {
          "code": "<string>",
          "multilingualName": "<string>",
          "axisId": 123,
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "description": "<string>",
          "ownerId": 123,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true
        }
      ],
      "childrenAxisSections": [
        {
          "code": "<string>",
          "multilingualName": "<string>",
          "axisId": 123,
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "description": "<string>",
          "ownerId": 123,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true
        }
      ]
    }
  }
}

GET

api

axisSections

List AxisSections

curl --request GET \
  --url https://{host}/api/v3/axisSections \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": {
      "code": "<string>",
      "multilingualName": "<string>",
      "axisId": 123,
      "id": 2,
      "name": "<string>",
      "url": "<string>",
      "description": "<string>",
      "ownerId": 123,
      "startOn": "2023-11-07T05:31:56Z",
      "endOn": "2023-11-07T05:31:56Z",
      "active": true,
      "parentAxisSections": [
        {
          "code": "<string>",
          "multilingualName": "<string>",
          "axisId": 123,
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "description": "<string>",
          "ownerId": 123,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true
        }
      ],
      "childrenAxisSections": [
        {
          "code": "<string>",
          "multilingualName": "<string>",
          "axisId": 123,
          "id": 2,
          "name": "<string>",
          "url": "<string>",
          "description": "<string>",
          "ownerId": 123,
          "startOn": "2023-11-07T05:31:56Z",
          "endOn": "2023-11-07T05:31:56Z",
          "active": true
        }
      ]
    }
  }
}

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

Example:

"100,0"

axisId

integer[]

Filter on the axis it belongs to.

ownerId

integer[]

Filter on the owner managing it.

active

boolean

default:true

Filter on active status.

Response

data

object

Show child attributes

data.items

The Axis Section resource · object

Show child attributes

data.items.code

string

required

data.items.multilingualName

string

required

data.items.axisId

integer

required

data.items.id

integer

Required range: x >= 1

data.items.name

string

data.items.url

string<uri>

data.items.description

string | null

data.items.ownerId

integer | null

data.items.startOn

string<date-time> | null

data.items.endOn

string<date-time> | null

data.items.active

boolean

default:true

data.items.parentAxisSections

AxisSectionTreeless · object[]

Show child attributes

data.items.parentAxisSections.code

string

required

data.items.parentAxisSections.multilingualName

string

required

data.items.parentAxisSections.axisId

integer

required

data.items.parentAxisSections.id

integer

Required range: x >= 1

data.items.parentAxisSections.name

string

data.items.parentAxisSections.url

string<uri>

data.items.parentAxisSections.description

string | null

data.items.parentAxisSections.ownerId

integer | null

data.items.parentAxisSections.startOn

string<date-time> | null

data.items.parentAxisSections.endOn

string<date-time> | null

data.items.parentAxisSections.active

boolean

default:true

data.items.childrenAxisSections

AxisSectionTreeless · object[]

Show child attributes

data.items.childrenAxisSections.code

string

required

data.items.childrenAxisSections.multilingualName

string

required

data.items.childrenAxisSections.axisId

integer

required

data.items.childrenAxisSections.id

integer

Required range: x >= 1

data.items.childrenAxisSections.name

string

data.items.childrenAxisSections.url

string<uri>

data.items.childrenAxisSections.description

string | null

data.items.childrenAxisSections.ownerId

integer | null

data.items.childrenAxisSections.startOn

string<date-time> | null

data.items.childrenAxisSections.endOn

string<date-time> | null

data.items.childrenAxisSections.active

boolean

default:true

The axis-section resource

Create a new AxisSection

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List AxisSections

Headers

Query Parameters

Response