Skip to main content
POST
/
api
/
v3
/
axisSections
Create a new AxisSection
curl --request POST \
  --url https://{host}/api/v3/axisSections \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "multilingualName": {},
  "axisId": 123,
  "id": 2,
  "description": "<string>",
  "ownerId": 123,
  "endOn": "2023-11-07T05:31:56Z",
  "active": true,
  "isPublic": true,
  "departments": [
    {
      "id": 123
    }
  ],
  "legalEntities": [
    {
      "id": 123
    }
  ],
  "users": [
    {
      "id": 123
    }
  ],
  "parentAxisSections": [
    {
      "code": "<string>",
      "multilingualName": {},
      "axisId": 123,
      "id": 2,
      "description": "<string>",
      "ownerId": 123,
      "endOn": "2023-11-07T05:31:56Z",
      "active": true,
      "isPublic": true,
      "departments": [
        {
          "id": 123
        }
      ],
      "legalEntities": [
        {
          "id": 123
        }
      ],
      "users": [
        {
          "id": 123
        }
      ]
    }
  ],
  "childrenAxisSections": [
    {
      "code": "<string>",
      "multilingualName": {},
      "axisId": 123,
      "id": 2,
      "description": "<string>",
      "ownerId": 123,
      "endOn": "2023-11-07T05:31:56Z",
      "active": true,
      "isPublic": true,
      "departments": [
        {
          "id": 123
        }
      ],
      "legalEntities": [
        {
          "id": 123
        }
      ],
      "users": [
        {
          "id": 123
        }
      ]
    }
  ]
}
'
{
  "data": {
    "code": "<string>",
    "multilingualName": {},
    "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,
    "isPublic": true,
    "departments": [
      {
        "id": 123
      }
    ],
    "legalEntities": [
      {
        "id": 123
      }
    ],
    "users": [
      {
        "id": 123
      }
    ],
    "parentAxisSections": [
      {
        "code": "<string>",
        "multilingualName": {},
        "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,
        "isPublic": true,
        "departments": [
          {
            "id": 123
          }
        ],
        "legalEntities": [
          {
            "id": 123
          }
        ],
        "users": [
          {
            "id": 123
          }
        ]
      }
    ],
    "childrenAxisSections": [
      {
        "code": "<string>",
        "multilingualName": {},
        "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,
        "isPublic": true,
        "departments": [
          {
            "id": 123
          }
        ],
        "legalEntities": [
          {
            "id": 123
          }
        ],
        "users": [
          {
            "id": 123
          }
        ]
      }
    ]
  }
}

Headers

​
Authorization
string
required

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

Body

application/json
​
code
string
required
​
multilingualName
required

The following characters should be avoided in the actual name of the axis-sections: "[", "]" and "|". Besides, slashes "/" and backslashes "\" might also cause problems.

To learn more about this, please refer to Get Started With Axis-Sections.

​
axisId
integer
required
​
id
integer
Required range: x >= 1
​
description
string | null
​
ownerId
integer | null
​
endOn
string<date-time> | null
​
active
boolean
default:true
​
isPublic
boolean
default:true
​
departments
object[]

List of departments associated with this axis-section. Only applicable when isPublic is false.

​
legalEntities
object[]

List of legal entities associated with this axis-section. Only applicable when isPublic is false.

​
users
object[]

List of users associated with this axis-section. Only applicable when isPublic is false.

​
parentAxisSections
AxisSectionTreeless · object[]
​
childrenAxisSections
AxisSectionTreeless · object[]

Response

OK

​
data
The Axis Section resource · object