Skip to main content

Create a unit

POST 
/nevisidm/api/core/v1/:clientExtId/units

Since: 2.73.0

Required permission(s): AccessControl.UnitCreate,AccessControl.UnitCreateTopUnit

Creates a new unit for the client with the given external ID.

If a parent unit external ID is provided, the new unit becomes a child of that parent. If no parent unit is provided, the unit becomes a root unit, which requires the AccessControl.UnitCreateTopUnit permission.

If no external ID is provided, one is generated automatically. The unit name must be unique under the same parent and conform to the configured identifier naming policy.

Request​

Path Parameters

    clientExtId stringrequired

    External ID of the client.

    Example: client-123

Body

required
    extId string

    The external ID of the unit. If not provided, one is generated automatically.

    parentUnitExtId string

    The external ID of the parent unit. If omitted, the unit becomes a root unit.

    name string

    The name of the unit.

    location string

    Free textual description of the physical location of the unit.

    description string

    The textual description of the unit.

    state string

    The state of the unit.

    displayName object

    Language-dependent name of the unit. Keys: EN, DE, FR, IT.

    property name* string
    abbreviation object

    Short form of the unit name. Keys: EN, DE, FR, IT.

    property name* string
    profileless booleanrequired

    Determines whether profile assignment is allowed.

    modificationComment string

    Textual comment regarding the last modification.

    validity object

    The validity period of the unit entity.

    from string

    Start date of the entity's validity in ISO format.

    to string

    End date of the entity's validity in ISO format.

Responses​

Unit created successfully

Response Headers
  • Location any

    URL of the created resource

Loading...
Last updated on