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
    Image export
    Export templates
      GET all Export Template entitiesgetPost Export Template entitiespostGET Export Template entitygetPUT Export Template entityputDelete Export Template entitydeletePatch Export Template entitypatch
Other
Schemas
powered by Zudoku
OpenAPI definition

Export templates (3.51)

Endpoint:/

GET all Export Template entities

GET
/api/v1/entities/exportTemplates

GET all Export Template entities › 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').

  • 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 Export Template entities › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/exportTemplates

Post Export Template entities

POST
/api/v1/entities/exportTemplates

Post Export Template entities › Request Body

  • dataobject · required

    JSON:API representation of exportTemplate entity.

Post Export Template entities › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportTemplate entity.

  • linksobject
POST /api/v1/entities/exportTemplates

GET Export Template entity

GET
/api/v1/entities/exportTemplates/{id}

GET Export Template entity › path Parameters

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

GET Export Template entity › 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').

GET Export Template entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportTemplate entity.

  • linksobject
GET /api/v1/entities/exportTemplates/{id}

PUT Export Template entity

PUT
/api/v1/entities/exportTemplates/{id}

PUT Export Template entity › path Parameters

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

PUT Export Template entity › 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 Export Template entity › Request Body

  • dataobject · required

    JSON:API representation of exportTemplate entity.

PUT Export Template entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportTemplate entity.

  • linksobject
PUT /api/v1/entities/exportTemplates/{id}

Delete Export Template entity

DELETE
/api/v1/entities/exportTemplates/{id}

Delete Export Template entity › path Parameters

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

Delete Export Template entity › 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 Export Template entity › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/exportTemplates/{id}

Patch Export Template entity

PATCH
/api/v1/entities/exportTemplates/{id}

Patch Export Template entity › path Parameters

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

Patch Export Template entity › 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 Export Template entity › Request Body

  • dataobject · required

    JSON:API representation of patching exportTemplate entity.

Patch Export Template entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of exportTemplate entity.

  • linksobject
PATCH /api/v1/entities/exportTemplates/{id}
Image exportOther