Saved Filters

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

List accessible filters#

GET/filtersToken

Parameter

Name	Ort	Typ	Beschreibung
`search`	Query	`string`	–
`visibility`	Query	`string`	–
`is_favorite`	Query	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a saved filter#

POST/filtersToken

Request-Body`application/jsonCreateSavedFilterDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`name`Pflicht	`string`	Filter name
`description`	`object`	–
`query`Pflicht	`object`	Query rule group { combinator, rules }
`source_type`Pflicht	`string`	Werte: `spacesprocessestaskslistswikifilter`
`source_space_ids`	`string[]`	Space UUIDs
`source_entity_types`	`string[]`	–
`source_filter_id`	`object`	Required when source_type=filter
`columns`	`object[]`	–
`sort_config`	`object`	–
`visibility`	`string`	Werte: `privatespaceorganization` Standard: `"private"`
`view_type`	`string`	Werte: `listhierarchy` Standard: `"list"`

Antworten

201Erstellt

Beispiel (cURL)

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

Get a saved filter by ID#

GET/filters/{id}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a saved filter#

PUT/filters/{id}Token

Parameter

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

Request-Body`application/jsonUpdateSavedFilterDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`name`	`string`	–
`description`	`object`	–
`query`	`object`	–
`source_type`	`string`	Werte: `spacesprocessestaskslistswikifilter`
`source_space_ids`	`string[]`	–
`source_entity_types`	`string[]`	–
`source_filter_id`	`object`	–
`columns`	`object[]`	–
`sort_config`	`object`	–
`visibility`	`string`	Werte: `privatespaceorganization`
`view_type`	`string`	Werte: `listhierarchy`

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/filters/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"…","name":"…","description":{}}'

Delete a saved filter#

DELETE/filters/{id}Token

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/filters/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Execute a saved filter#

POST/filters/{id}/executeToken

Parameter

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

Request-Body`application/jsonExecuteSavedFilterDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`page`	`number`	Standard: `1`
`pageSize`	`number`	Standard: `50`
`sort`	`FilterSortDto`	Sort config: { column: string, direction: "asc"\|"desc" }

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/filters/{id}/execute" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"…","page":0,"pageSize":0}'

Export filter results as CSV#

GET/filters/{id}/exportToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/{id}/export" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Toggle favorite on a filter#

POST/filters/{id}/favoriteToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/filters/{id}/favorite" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List permissions for a filter (owner only)#

GET/filters/{id}/permissionsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Set permissions for a filter (owner only, replaces all)#

POST/filters/{id}/permissionsToken

Parameter

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

Request-Body`application/jsonSetFilterPermissionsDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`permissions`Pflicht	`FilterPermissionItemDto[]`	–
`permissions[].target_type`Pflicht	`string`	Werte: `usergrouprolespace`
`permissions[].target_id`Pflicht	`string`	–
`permissions[].can_view`	`boolean`	Standard: `true`
`permissions[].can_edit`	`boolean`	Standard: `false`
`permissions[].can_delete`	`boolean`	Standard: `false`

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/filters/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"permissions":[]}'

List subscriptions for a filter#

GET/filters/{id}/subscriptionsToken

Parameter

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

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/{id}/subscriptions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create or update subscription for a filter#

POST/filters/{id}/subscriptionsToken

Parameter

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

Request-Body`application/jsonCreateFilterSubscriptionDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`schedule_cron`Pflicht	`string`	Cron expression e.g. "0 9 * * *"
`schedule_label`	`object`	–
`schedule_frequency`	`string`	Werte: `dailyweeklymonthlyyearly` Standard: `"daily"`
`schedule_time`	`string`	Time of day HH:MM
`schedule_days_of_week`	`number[]`	Days of week 0-6 (for weekly)
`schedule_day_of_month`	`number`	–
`schedule_month_of_year`	`number`	–
`end_type`	`string`	Werte: `neverdatecount` Standard: `"never"`
`end_date`	`object`	ISO date when end_type=date
`max_occurrences`	`object`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/filters/{id}/subscriptions" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"schedule_cron":"…"}'

Delete a filter subscription#

DELETE/filters/{id}/subscriptions/{subId}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`subId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/filters/{id}/subscriptions/{subId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get system default filters#

GET/filters/defaultsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/defaults" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Execute an ad-hoc filter (no save)#

POST/filters/executeToken

Request-Body`application/jsonExecuteFilterDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Legacy client org id; ignored in favor of auth context
`query`Pflicht	`object`	Query rule group
`source_type`Pflicht	`string`	Werte: `spacesprocessestaskslistswikifilter`
`source_space_ids`	`string[]`	–
`source_entity_types`	`string[]`	–
`source_filter_id`	`string`	–
`page`	`number`	Standard: `1`
`pageSize`	`number`	Standard: `50`
`sort`	`FilterSortDto`	–
`sort.column`Pflicht	`string`	Field or custom field key to sort by
`sort.direction`Pflicht	`string`	Werte: `ascdesc`

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/filters/execute" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":{},"source_type":"spaces"}'

Get filterable field definitions#

GET/filters/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`entityTypes`	Query	`string`	–
`spaceIds`	Query	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Typeahead: tasks + processes matching search (for Parent field)#

GET/filters/parent-optionsToken

Parameter

Name	Ort	Typ	Beschreibung
`search`Pflicht	Query	`string`	–
`entityTypes`	Query	`string`	–
`spaceIds`	Query	`string`	–
`limit`	Query	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/filters/parent-options" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Saved Filters

List accessible filters#

Parameter

Antworten

Create a saved filter#

Request-Bodyapplication/jsonCreateSavedFilterDto

Antworten

Get a saved filter by ID#

Parameter

Antworten

Update a saved filter#

Parameter

Request-Bodyapplication/jsonUpdateSavedFilterDto

Antworten

Delete a saved filter#

Parameter

Antworten

Execute a saved filter#

Parameter

Request-Bodyapplication/jsonExecuteSavedFilterDto

Antworten

Export filter results as CSV#

Parameter

Antworten

Toggle favorite on a filter#

Parameter

Antworten

List permissions for a filter (owner only)#

Parameter

Antworten

Set permissions for a filter (owner only, replaces all)#

Parameter

Request-Bodyapplication/jsonSetFilterPermissionsDto

Antworten

List subscriptions for a filter#

Parameter

Antworten

Create or update subscription for a filter#

Parameter

Request-Bodyapplication/jsonCreateFilterSubscriptionDto

Antworten

Delete a filter subscription#

Parameter

Antworten

Get system default filters#

Antworten

Execute an ad-hoc filter (no save)#

Request-Bodyapplication/jsonExecuteFilterDto

Antworten

Get filterable field definitions#

Parameter

Antworten

Typeahead: tasks + processes matching search (for Parent field)#

Parameter

Antworten

Request-Body`application/jsonCreateSavedFilterDto`

Request-Body`application/jsonUpdateSavedFilterDto`

Request-Body`application/jsonExecuteSavedFilterDto`

Request-Body`application/jsonSetFilterPermissionsDto`

Request-Body`application/jsonCreateFilterSubscriptionDto`

Request-Body`application/jsonExecuteFilterDto`