Asset Schemas (Lists)

11 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

Get schema by key#

GET/spaces/{spaceId}/lists/key/{key}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`key`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/key/{key}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List all schemas in a space#

GET/spaces/{spaceId}/lists/schemasToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a schema#

POST/spaces/{spaceId}/lists/schemasToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonCreateAssetSchemaDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	–
`key`Pflicht	`string`	Unique key per space, lowercase alphanumeric + underscores
`description`	`string`	–
`icon`	`string`	–
`fields_definition`	`object[]`	–
`column_config`	`ColumnConfigItemDto[]`	–
`column_config[].id`Pflicht	`string`	Column identifier
`column_config[].visible`Pflicht	`boolean`	Whether the column is visible
`column_config[].order`Pflicht	`number`	Display order (0-based)
`settings`	`object`	–
`permissions`	`object`	–
`field_group_ids`	`string[]`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","key":"…"}'

Get schema by ID#

GET/spaces/{spaceId}/lists/schemas/{schemaId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a schema#

PUT/spaces/{spaceId}/lists/schemas/{schemaId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateAssetSchemaDto`

Name	Typ	Beschreibung
`name`	`string`	–
`description`	`string`	–
`icon`	`string`	–
`column_config`	`ColumnConfigItemDto[]`	–
`column_config[].id`Pflicht	`string`	Column identifier
`column_config[].visible`Pflicht	`boolean`	Whether the column is visible
`column_config[].order`Pflicht	`number`	Display order (0-based)
`settings`	`object`	–
`permissions`	`object`	–
`field_group_ids`	`string[]`	–

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…","icon":"…"}'

Soft delete a schema#

DELETE/spaces/{spaceId}/lists/schemas/{schemaId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add a column to a schema#

POST/spaces/{spaceId}/lists/schemas/{schemaId}/columnsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonAddColumnDto`

Name	Typ	Beschreibung
`column`Pflicht	`ColumnConfigItemDto`	–
`column.id`Pflicht	`string`	Column identifier
`column.visible`Pflicht	`boolean`	Whether the column is visible
`column.order`Pflicht	`number`	Display order (0-based)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}/columns" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"column":"…"}'

Reorder all columns#

PUT/spaces/{spaceId}/lists/schemas/{schemaId}/columnsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonReorderColumnsDto`

Name	Typ	Beschreibung
`column_order`Pflicht	`ColumnOrderDto[]`	–
`column_order[].columnId`Pflicht	`string`	–
`column_order[].order`Pflicht	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}/columns" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"column_order":[]}'

Rename a column#

PUT/spaces/{spaceId}/lists/schemas/{schemaId}/columns/{columnId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–
`columnId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonRenameColumnDto`

Name	Typ	Beschreibung
`new_label`Pflicht	`string`	New label for the column

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}/columns/{columnId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"new_label":"…"}'

Remove a column from a schema#

DELETE/spaces/{spaceId}/lists/schemas/{schemaId}/columns/{columnId}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–
`columnId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}/columns/{columnId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Export schema items as CSV#

GET/spaces/{spaceId}/lists/schemas/{schemaId}/exportToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–
`schemaId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/lists/schemas/{schemaId}/export" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Asset Schemas (Lists)

Get schema by key#

Parameter

Antworten

List all schemas in a space#

Parameter

Antworten

Create a schema#

Parameter

Request-Bodyapplication/jsonCreateAssetSchemaDto

Antworten

Get schema by ID#

Parameter

Antworten

Update a schema#

Parameter

Request-Bodyapplication/jsonUpdateAssetSchemaDto

Antworten

Soft delete a schema#

Parameter

Antworten

Add a column to a schema#

Parameter

Request-Bodyapplication/jsonAddColumnDto

Antworten

Reorder all columns#

Parameter

Request-Bodyapplication/jsonReorderColumnsDto

Antworten

Rename a column#

Parameter

Request-Bodyapplication/jsonRenameColumnDto

Antworten

Remove a column from a schema#

Parameter

Antworten

Export schema items as CSV#

Parameter

Antworten

Request-Body`application/jsonCreateAssetSchemaDto`

Request-Body`application/jsonUpdateAssetSchemaDto`

Request-Body`application/jsonAddColumnDto`

Request-Body`application/jsonReorderColumnsDto`

Request-Body`application/jsonRenameColumnDto`