Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
    Automations
    Tabular export
    Visual export
    Raw export
    Slides export
    Export Definitions
      Get all Export DefinitionsgetPost Export DefinitionspostGet an Export DefinitiongetPut an Export DefinitionputDelete an Export DefinitiondeletePatch an Export Definitionpatch
    Image export
    Export templates
Other
Schemas
powered by Zudoku
OpenAPI definition

Export Definitions (3.51)

Endpoint:/

Get all Export Definitions

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

Get all Export Definitions › path Parameters

  • workspaceIdstring · required

Get all Export Definitions › 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:
    visualizationObjects
    analyticalDashboards
    automations
    userIdentifiers
    visualizationObject
    analyticalDashboard
    automation
    createdBy
  • 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 Export Definitions › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Export Definitions › Responses

Request successfully processed

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

    Included resources

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

Post Export Definitions

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

Post Export Definitions › path Parameters

  • workspaceIdstring · required

Post Export Definitions › 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:
    visualizationObjects
    analyticalDashboards
    automations
    userIdentifiers
    visualizationObject
    analyticalDashboard
    automation
    createdBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Export Definitions › Request Body

  • dataobject · required

    JSON:API representation of exportDefinition entity.

Post Export Definitions › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportDefinition entity.

  • includedarray · unique

    Included resources

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

Get an Export Definition

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

Get an Export Definition › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get an Export Definition › 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:
    visualizationObjects
    analyticalDashboards
    automations
    userIdentifiers
    visualizationObject
    analyticalDashboard
    automation
    createdBy
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get an Export Definition › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get an Export Definition › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportDefinition entity.

  • includedarray · unique

    Included resources

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

Put an Export Definition

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

Put an Export Definition › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put an Export Definition › 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:
    visualizationObjects
    analyticalDashboards
    automations
    userIdentifiers
    visualizationObject
    analyticalDashboard
    automation
    createdBy

Put an Export Definition › Request Body

  • dataobject · required

    JSON:API representation of exportDefinition entity.

Put an Export Definition › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportDefinition entity.

  • includedarray · unique

    Included resources

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

Delete an Export Definition

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

Delete an Export Definition › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

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

Successfully deleted

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

Patch an Export Definition

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

Patch an Export Definition › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch an Export Definition › 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:
    visualizationObjects
    analyticalDashboards
    automations
    userIdentifiers
    visualizationObject
    analyticalDashboard
    automation
    createdBy

Patch an Export Definition › Request Body

  • dataobject · required

    JSON:API representation of patching exportDefinition entity.

Patch an Export Definition › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportDefinition entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}
Slides exportImage export