Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
    Automations
      Delete selected automations across all workspacespostPause selected automations across all workspacespostUnpause selected automations across all workspacespostUnsubscribe from selected automations across all workspacespostUnsubscribe from all automations in all workspacesdeleteDelete selected automations in the workspacepostPause selected automations in the workspacepostTrigger automation.postUnpause selected automations in the workspacepostUnsubscribe from selected automations in the workspacepostUnsubscribe from all automations in the workspacedeleteTrigger existing automation.postUnsubscribe from an automationdeleteGet all Automations across all WorkspacesgetGet all AutomationsgetPost AutomationspostGet an AutomationgetPut an AutomationputDelete an AutomationdeletePatch an AutomationpatchGet automationsgetSet automationsput
    Tabular export
    Visual export
    Raw export
    Slides export
    Export Definitions
    Image export
    Export templates
Other
Schemas
powered by Zudoku
OpenAPI definition

Automations (3.51)

Endpoint:/

Delete selected automations across all workspaces

POST
/api/v1/actions/organization/automations/delete

Delete selected automations across all workspaces › Request Body

  • automationsobject[] · required

Delete selected automations across all workspaces › Responses

No Content

No data returned
POST /api/v1/actions/organization/automations/delete

Pause selected automations across all workspaces

POST
/api/v1/actions/organization/automations/pause

Pause selected automations across all workspaces › Request Body

  • automationsobject[] · required

Pause selected automations across all workspaces › Responses

No Content

No data returned
POST /api/v1/actions/organization/automations/pause

Unpause selected automations across all workspaces

POST
/api/v1/actions/organization/automations/unpause

Unpause selected automations across all workspaces › Request Body

  • automationsobject[] · required

Unpause selected automations across all workspaces › Responses

No Content

No data returned
POST /api/v1/actions/organization/automations/unpause

Unsubscribe from selected automations across all workspaces

POST
/api/v1/actions/organization/automations/unsubscribe

Unsubscribe from selected automations across all workspaces › Request Body

  • automationsobject[] · required

Unsubscribe from selected automations across all workspaces › Responses

No Content

No data returned
POST /api/v1/actions/organization/automations/unsubscribe

Unsubscribe from all automations in all workspaces

DELETE
/api/v1/actions/organization/automations/unsubscribe

Unsubscribe from all automations in all workspaces › Responses

No Content

No data returned
DELETE /api/v1/actions/organization/automations/unsubscribe

Delete selected automations in the workspace

POST
/api/v1/actions/workspaces/{workspaceId}/automations/delete

Delete selected automations in the workspace › path Parameters

  • workspaceIdstring · required

Delete selected automations in the workspace › Request Body

  • automationsobject[] · required

Delete selected automations in the workspace › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/delete

Pause selected automations in the workspace

POST
/api/v1/actions/workspaces/{workspaceId}/automations/pause

Pause selected automations in the workspace › path Parameters

  • workspaceIdstring · required

Pause selected automations in the workspace › Request Body

  • automationsobject[] · required

Pause selected automations in the workspace › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/pause

Trigger automation.

POST
/api/v1/actions/workspaces/{workspaceId}/automations/trigger

Trigger the automation in the request.

Trigger automation. › path Parameters

  • workspaceIdstring · required

Trigger automation. › Request Body

  • automationobject · required

Trigger automation. › Responses

The automation is successfully triggered.

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/trigger

Unpause selected automations in the workspace

POST
/api/v1/actions/workspaces/{workspaceId}/automations/unpause

Unpause selected automations in the workspace › path Parameters

  • workspaceIdstring · required

Unpause selected automations in the workspace › Request Body

  • automationsobject[] · required

Unpause selected automations in the workspace › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/unpause

Unsubscribe from selected automations in the workspace

POST
/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe

Unsubscribe from selected automations in the workspace › path Parameters

  • workspaceIdstring · required

Unsubscribe from selected automations in the workspace › Request Body

  • automationsobject[] · required

Unsubscribe from selected automations in the workspace › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe

Unsubscribe from all automations in the workspace

DELETE
/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe

Unsubscribe from all automations in the workspace › path Parameters

  • workspaceIdstring · required

Unsubscribe from all automations in the workspace › Responses

No Content

No data returned
DELETE /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe

Trigger existing automation.

POST
/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger

Trigger the existing automation to execute immediately.

Trigger existing automation. › path Parameters

  • workspaceIdstring · required
  • automationIdstring · required

Trigger existing automation. › Responses

The automation is successfully triggered.

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger

Unsubscribe from an automation

DELETE
/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe

Unsubscribe from an automation › path Parameters

  • workspaceIdstring · required
  • automationIdstring · required

Unsubscribe from an automation › Responses

No Content

No data returned
DELETE /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe

Get all Automations across all Workspaces

GET
/api/v1/entities/organization/workspaceAutomations

Get all Automations across all Workspaces › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    workspaces
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    workspace
  • 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:
    page
    all
    ALL

Get all Automations across all Workspaces › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedarray · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/organization/workspaceAutomations

Get all Automations

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

Get all Automations › path Parameters

  • workspaceIdstring · required

Get all Automations › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    notificationChannel
    analyticalDashboard
  • 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 Automations › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Automations › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedarray · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/automations

Post Automations

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

Post Automations › path Parameters

  • workspaceIdstring · required

Post Automations › query Parameters

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    notificationChannel
    analyticalDashboard
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Automations › Request Body

  • dataobject · required

    JSON:API representation of automation entity.

Post Automations › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of automation entity.

  • includedarray · unique

    Included resources

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

Get an Automation

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

Get an Automation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get an Automation › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    notificationChannel
    analyticalDashboard
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get an Automation › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get an Automation › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of automation entity.

  • includedarray · unique

    Included resources

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

Put an Automation

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

Put an Automation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put an Automation › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    notificationChannel
    analyticalDashboard

Put an Automation › Request Body

  • dataobject · required

    JSON:API representation of automation entity.

Put an Automation › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of automation entity.

  • includedarray · unique

    Included resources

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

Delete an Automation

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

Delete an Automation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete an Automation › 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 an Automation › Responses

Successfully deleted

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

Patch an Automation

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

Patch an Automation › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch an Automation › 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').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    notificationChannels
    analyticalDashboards
    userIdentifiers
    exportDefinitions
    users
    automationResults
    notificationChannel
    analyticalDashboard

Patch an Automation › Request Body

  • dataobject · required

    JSON:API representation of patching automation entity.

Patch an Automation › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of automation entity.

  • includedarray · unique

    Included resources

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

Get automations

GET
/api/v1/layout/workspaces/{workspaceId}/automations

Retrieve automations for the specific workspace

Get automations › path Parameters

  • workspaceIdstring · required

Get automations › query Parameters

  • excludestring[]
    Enum values:
    ACTIVITY_INFO

Get automations › Responses

Retrieved automations.

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
  • alertobject
  • analyticalDashboardobject

    An analytical dashboard identifier.

  • createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…

    Time of the entity creation.

    Example: 2023-07-20 12:30
  • createdByobject

    A user identifier.

    Example: {"id":"example123","type":"user"}
  • dashboardTabularExportsobject[] · unique
  • descriptionstring · maxLength: 255
  • detailsobject · maxLength: 10000

    TODO

  • evaluationModestring · enum

    Specify automation evaluation mode.

    Enum values:
    SHARED
    PER_RECIPIENT
    Default: PER_RECIPIENT
  • exportDefinitionsobject[] · unique
  • externalRecipientsobject[] · unique

    External recipients of the automation action results.

  • imageExportsobject[] · unique
  • metadataobject | null · maxLength: 250000

    Additional information for the automation.

  • modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…

    Time of the last entity modification.

    Example: 2023-07-20 12:30
  • modifiedByobject

    A user identifier.

    Example: {"id":"example123","type":"user"}
  • notificationChannelobject

    A notification channel identifier.

  • rawExportsobject[] · unique
  • recipientsobject[] · unique
  • scheduleobject
  • slidesExportsobject[] · unique
  • statestring · enum

    Current state of the automation.

    Enum values:
    ACTIVE
    PAUSED
    Default: ACTIVE
  • tabularExportsobject[] · unique
  • tagsstring[] · unique
  • titlestring · maxLength: 255
  • visualExportsobject[] · unique
GET /api/v1/layout/workspaces/{workspaceId}/automations

Set automations

PUT
/api/v1/layout/workspaces/{workspaceId}/automations

Set automations for the specific workspace.

Set automations › path Parameters

  • workspaceIdstring · required

Set automations › Request Body

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required
  • alertobject
  • analyticalDashboardobject

    An analytical dashboard identifier.

  • createdAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…

    Time of the entity creation.

    Example: 2023-07-20 12:30
  • createdByobject

    A user identifier.

    Example: {"id":"example123","type":"user"}
  • dashboardTabularExportsobject[] · unique
  • descriptionstring · maxLength: 255
  • detailsobject · maxLength: 10000

    TODO

  • evaluationModestring · enum

    Specify automation evaluation mode.

    Enum values:
    SHARED
    PER_RECIPIENT
    Default: PER_RECIPIENT
  • exportDefinitionsobject[] · unique
  • externalRecipientsobject[] · unique

    External recipients of the automation action results.

  • imageExportsobject[] · unique
  • metadataobject | null · maxLength: 250000

    Additional information for the automation.

  • modifiedAtstring | null · pattern: [0-9]{4}-[0-9]{2}-[0…

    Time of the last entity modification.

    Example: 2023-07-20 12:30
  • modifiedByobject

    A user identifier.

    Example: {"id":"example123","type":"user"}
  • notificationChannelobject

    A notification channel identifier.

  • rawExportsobject[] · unique
  • recipientsobject[] · unique
  • scheduleobject
  • slidesExportsobject[] · unique
  • statestring · enum

    Current state of the automation.

    Enum values:
    ACTIVE
    PAUSED
    Default: ACTIVE
  • tabularExportsobject[] · unique
  • tagsstring[] · unique
  • titlestring · maxLength: 255
  • visualExportsobject[] · unique

Set automations › Responses

Automations successfully set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}/automations
LLM EndpointsTabular export