Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
    Workspaces - Declarative APIs
    Data Filters
    Workspaces - Settings
      Values for all settings.getValues for selected settings.postGet all Custom Application SettingsgetPost Custom Application SettingspostGet a Custom Application SettinggetPut a Custom Application SettingputDelete a Custom Application SettingdeletePatch a Custom Application SettingpatchGet all Setting for WorkspacesgetPost Settings for WorkspacespostGet a Setting for WorkspacegetPut a Setting for a WorkspaceputDelete a Setting for WorkspacedeletePatch a Setting for Workspacepatch
    Appearance
    Plugins
    Hierarchy
    Translations
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Workspaces - Settings (3.51)

Endpoint:/

Values for all settings.

GET
/api/v1/actions/workspaces/{workspaceId}/resolveSettings

Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.

Values for all settings. › path Parameters

  • workspaceIdstring · required

Values for all settings. › Responses

Values for selected settings.

  • contentobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}
  • typestring · enum

    Type of the setting.

    Enum values:
    TIMEZONE
    ACTIVE_THEME
    ACTIVE_COLOR_PALETTE
    ACTIVE_LLM_ENDPOINT
    ACTIVE_CALENDARS
    WHITE_LABELING
    LOCALE
    METADATA_LOCALE
    Example: TIMEZONE
  • idstring · deprecated · required

    Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.

GET /api/v1/actions/workspaces/{workspaceId}/resolveSettings

Values for selected settings.

POST
/api/v1/actions/workspaces/{workspaceId}/resolveSettings

Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.

Values for selected settings. › path Parameters

  • workspaceIdstring · required

Values for selected settings. › Request Body

  • settingsstring[] · required

    An array of setting IDs to resolve.

    Example: ["timezone"]

Values for selected settings. › Responses

Values for selected settings.

  • contentobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}
  • typestring · enum

    Type of the setting.

    Enum values:
    TIMEZONE
    ACTIVE_THEME
    ACTIVE_COLOR_PALETTE
    ACTIVE_LLM_ENDPOINT
    ACTIVE_CALENDARS
    WHITE_LABELING
    LOCALE
    METADATA_LOCALE
    Example: TIMEZONE
  • idstring · deprecated · required

    Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.

POST /api/v1/actions/workspaces/{workspaceId}/resolveSettings

Get all Custom Application Settings

GET
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings

Get all Custom Application Settings › path Parameters

  • workspaceIdstring · required

Get all Custom Application Settings › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL
  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    page
    all
    ALL

Get all Custom Application Settings › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Custom Application Settings › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings

Post Custom Application Settings

POST
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings

Post Custom Application Settings › path Parameters

  • workspaceIdstring · required

Post Custom Application Settings › query Parameters

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Custom Application Settings › Request Body

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

Post Custom Application Settings › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

  • linksobject
POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings

Get a Custom Application Setting

GET
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Get a Custom Application Setting › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Custom Application Setting › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Custom Application Setting › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Custom Application Setting › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

  • linksobject
GET /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Put a Custom Application Setting

PUT
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Put a Custom Application Setting › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Custom Application Setting › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put a Custom Application Setting › Request Body

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

Put a Custom Application Setting › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

  • linksobject
PUT /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Delete a Custom Application Setting

DELETE
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Delete a Custom Application Setting › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Custom Application Setting › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete a Custom Application Setting › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Patch a Custom Application Setting

PATCH
/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Patch a Custom Application Setting › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Custom Application Setting › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch a Custom Application Setting › Request Body

  • dataobject · required

    JSON:API representation of patching customApplicationSetting entity.

Patch a Custom Application Setting › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of customApplicationSetting entity.

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}

Get all Setting for Workspaces

GET
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings

Get all Setting for Workspaces › path Parameters

  • workspaceIdstring · required

Get all Setting for Workspaces › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL
  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    page
    all
    ALL

Get all Setting for Workspaces › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Setting for Workspaces › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings

Post Settings for Workspaces

POST
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings

Post Settings for Workspaces › path Parameters

  • workspaceIdstring · required

Post Settings for Workspaces › query Parameters

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Settings for Workspaces › Request Body

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

Post Settings for Workspaces › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

  • linksobject
POST /api/v1/entities/workspaces/{workspaceId}/workspaceSettings

Get a Setting for Workspace

GET
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Get a Setting for Workspace › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get a Setting for Workspace › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get a Setting for Workspace › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get a Setting for Workspace › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

  • linksobject
GET /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Put a Setting for a Workspace

PUT
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Put a Setting for a Workspace › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put a Setting for a Workspace › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put a Setting for a Workspace › Request Body

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

Put a Setting for a Workspace › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

  • linksobject
PUT /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Delete a Setting for Workspace

DELETE
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Delete a Setting for Workspace › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete a Setting for Workspace › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete a Setting for Workspace › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Patch a Setting for Workspace

PATCH
/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}

Patch a Setting for Workspace › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch a Setting for Workspace › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch a Setting for Workspace › Request Body

  • dataobject · required

    JSON:API representation of patching workspaceSetting entity.

Patch a Setting for Workspace › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of workspaceSetting entity.

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}
Data FiltersAppearance