create_area
Create an area within a container. Requires super admin.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
containerId | string | Yes | — | Parent container ID. Use get_containers. |
name | string | Yes | — | Area name. |
description | string | Yes | — | Area description. |
parentId | string | No | — | Parent area ID for nesting. |
sequence | int | No | 1 | Display order. |
Returns
AnAreaDto with the created area’s details:
| Field | Description |
|---|---|
areaId | Area ID |
areaName | Area name |
areaDesc | Area description |
update_area
Update area name, description, archive status, or sequence. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
areaId | string | Yes | — | Area ID. Use get_containers to find areas. |
name | string | No | — | New area name. |
description | string | No | — | New area description. |
archived | bool | No | — | Set to true to archive the area. |
sequence | int | No | — | New display order. |
Returns
AnAreaDto with the updated area details.
delete_area
Delete an area. Requires super admin.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
areaId | string | Yes | Area ID. Use get_containers to find areas. |