asset-objects

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

List asset objects in a schema (optionally filtered by type)#

GET/spaces/{spaceId}/assets/schemas/{schemaId}/objectsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`schemaId`Pflicht	Pfad	`string`	Schema UUID
`filter`	Query	`any`	JSON-encoded condition group: {"combinator":"and"\|"or","rules":[{"field","operator","value"}]}. Fields are base columns (name, object_key, description, object_type_id, created_at, updated_at) or schema attributes prefixed attr_<field_key>. Flat only — nested groups are rejected.
`search`	Query	`any`	Filter by name or object_key (case-insensitive substring match)
`sortDirection`	Query	`any`	Sort direction: asc \| desc (default: desc)
`sortField`	Query	`any`	Sort column: object_key \| name \| created_at \| updated_at, or attr_<field_key> for a sortable schema attribute (default: created_at)
`pageSize`	Query	`any`	Results per page (default: 50)
`page`	Query	`any`	Page number (default: 1)
`objectTypeId`	Query	`any`	Filter by object type UUID

Antworten

200Paginated list of objects with total count
401Not authenticated
403Missing view_assets permission or module disabled

Beispiel (cURL)

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

Create a new asset object instance#

POST/spaces/{spaceId}/assets/schemas/{schemaId}/objectsToken

A unique object_key (e.g. CMDB-42) is auto-assigned by a DB trigger.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`schemaId`Pflicht	Pfad	`string`	Schema UUID

Request-Body`application/jsonCreateAssetObjectDto`

Name	Typ	Beschreibung
`object_type_id`Pflicht	`string`	–
`name`Pflicht	`string`	–
`description`	`string`	–
`icon`	`string`	–
`color`	`string`	–
`attribute_values`	`object`	Attribute values keyed by field_key
`permissions`	`object`	–

Antworten

201Asset object created; object_key auto-assigned
400Validation error or object type not in this schema
401Not authenticated
403Missing manage_assets permission or module disabled

Beispiel (cURL)

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

Get a single asset object by ID#

GET/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`id`Pflicht	Pfad	`string`	Object UUID
`schemaId`Pflicht	Pfad	`any`	Schema UUID

Antworten

200Asset object returned
401Not authenticated
403Missing view_assets permission or module disabled
404Asset object not found

Beispiel (cURL)

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

Update an asset object (optimistic lock via version)#

PATCH/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`id`Pflicht	Pfad	`string`	Object UUID
`schemaId`Pflicht	Pfad	`any`	Schema UUID

Request-Body`application/jsonUpdateAssetObjectDto`

Name	Typ	Beschreibung
`name`	`string`	–
`description`	`string`	–
`icon`	`string`	–
`color`	`string`	–
`attribute_values`	`object`	–
`permissions`	`object`	–
`object_type_id`	`string`	New object type ID (must belong to same schema)
`version`	`number`	–

Antworten

200Asset object updated
400Validation error
401Not authenticated
403Missing manage_assets permission or module disabled
404Asset object not found
409Version conflict — object was updated by another request

Beispiel (cURL)

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

Delete an asset object permanently#

DELETE/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`id`Pflicht	Pfad	`string`	Object UUID
`schemaId`Pflicht	Pfad	`any`	Schema UUID

Antworten

200Asset object deleted
401Not authenticated
403Missing manage_assets permission or module disabled
404Asset object not found

Beispiel (cURL)

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

Upload or replace the image for an asset object (max 5 MB)#

POST/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}/imageToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`id`Pflicht	Pfad	`string`	Object UUID
`schemaId`Pflicht	Pfad	`any`	Schema UUID

Request-Body`multipart/form-data`

Name	Typ	Beschreibung
`file`Pflicht	`string (binary)`	Image file (max 5 MB, jpeg/png/gif/webp/svg)

Antworten

201Image uploaded; object returned with image_path set
400Missing file, invalid type, or file too large
401Not authenticated
403Missing edit_assets permission or module disabled
404Asset object not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}/image" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -F "file=@./datei.pdf"

Remove the custom image from an asset object#

DELETE/spaces/{spaceId}/assets/schemas/{schemaId}/objects/{id}/imageToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`id`Pflicht	Pfad	`string`	Object UUID
`schemaId`Pflicht	Pfad	`any`	Schema UUID

Antworten

200Image removed; object returned with image_path null
401Not authenticated
403Missing edit_assets permission or module disabled
404Asset object not found

Beispiel (cURL)

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

Export the objects of one object type as csv, xls or xlsx#

GET/spaces/{spaceId}/assets/schemas/{schemaId}/objects/exportToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`schemaId`Pflicht	Pfad	`string`	Schema UUID
`format`Pflicht	Query	`string`	csv \| xls \| xlsx
`objectTypeId`Pflicht	Query	`string`	Object type UUID — decides the exported columns
`sortDirection`	Query	`any`	–
`sortField`	Query	`any`	–
`filter`	Query	`any`	Same JSON-encoded condition group as the list endpoint
`search`	Query	`any`	–

Antworten

200File download
400Unknown format, or the selection cannot be read in full
401Not authenticated
403Missing view_assets permission or module disabled

Beispiel (cURL)

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

POST /spaces/{spaceId}/assets/schemas/{schemaId}/objects/import#

POST/spaces/{spaceId}/assets/schemas/{schemaId}/objects/importToken

Parameter

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

Antworten

201Erstellt

Beispiel (cURL)

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

Count what an import would do, without writing anything#

POST/spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/dry-runToken

Parameter

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

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/dry-run" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

POST /spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/preview#

POST/spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/previewToken

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/preview" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Search objects across the viewable object types of a schema#

GET/spaces/{spaceId}/assets/schemas/{schemaId}/objects/searchToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`schemaId`Pflicht	Pfad	`string`	Schema UUID
`objectTypeId`	Query	`any`	Limit the search to one object type UUID
`pageSize`	Query	`any`	1-50, default 25
`page`	Query	`any`	–
`search`	Query	`any`	Case-insensitive match on name, object key or attribute values

Antworten

200Matching objects with total count
401Not authenticated
403Missing view_assets permission or module disabled

Beispiel (cURL)

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

Get aggregate stats for a schema (total + updated in 24h)#

GET/spaces/{spaceId}/assets/schemas/{schemaId}/objects/statsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	Space UUID
`schemaId`Pflicht	Pfad	`string`	Schema UUID

Antworten

200Schema stats returned

Beispiel (cURL)

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

asset-objects

List asset objects in a schema (optionally filtered by type)#

Parameter

Antworten

Create a new asset object instance#

Parameter

Request-Bodyapplication/jsonCreateAssetObjectDto

Antworten

Get a single asset object by ID#

Parameter

Antworten

Update an asset object (optimistic lock via version)#

Parameter

Request-Bodyapplication/jsonUpdateAssetObjectDto

Antworten

Delete an asset object permanently#

Parameter

Antworten

Upload or replace the image for an asset object (max 5 MB)#

Parameter

Request-Bodymultipart/form-data

Antworten

Remove the custom image from an asset object#

Parameter

Antworten

Export the objects of one object type as csv, xls or xlsx#

Parameter

Antworten

POST /spaces/{spaceId}/assets/schemas/{schemaId}/objects/import#

Parameter

Antworten

Count what an import would do, without writing anything#

Parameter

Antworten

POST /spaces/{spaceId}/assets/schemas/{schemaId}/objects/import/preview#

Antworten

Search objects across the viewable object types of a schema#

Parameter

Antworten

Get aggregate stats for a schema (total + updated in 24h)#

Parameter

Antworten

Request-Body`application/jsonCreateAssetObjectDto`

Request-Body`application/jsonUpdateAssetObjectDto`

Request-Body`multipart/form-data`