GOgooddata
Export templates

Patch Export Template entity

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

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

idstring required

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').

Request body

Example request

{
  "data": {
    "attributes": {
      "dashboardSlidesTemplate": {
        "appliedOn": [
          "PDF",
          "PPTX"
        ],
        "contentSlide": {
          "descriptionField": "{{dashboardFilters}}"
        },
        "coverSlide": {
          "descriptionField": "Exported at: {{exportedAt}}"
        },
        "introSlide": {
          "descriptionField": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}",
          "titleField": "Introduction"
        }
      },
      "widgetSlidesTemplate": {
        "appliedOn": [
          "PDF",
          "PPTX"
        ],
        "contentSlide": {
          "descriptionField": "{{dashboardFilters}}"
        }
      }
    },
    "id": "id1",
    "type": "exportTemplate"
  }
}

Response

Request successfully processed

Example response

{
  "data": {
    "attributes": {
      "dashboardSlidesTemplate": {
        "appliedOn": [
          "PDF",
          "PPTX"
        ],
        "contentSlide": {
          "descriptionField": "{{dashboardFilters}}"
        },
        "coverSlide": {
          "descriptionField": "Exported at: {{exportedAt}}"
        },
        "introSlide": {
          "descriptionField": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}",
          "titleField": "Introduction"
        }
      },
      "widgetSlidesTemplate": {
        "appliedOn": [
          "PDF",
          "PPTX"
        ],
        "contentSlide": {
          "descriptionField": "{{dashboardFilters}}"
        }
      }
    },
    "id": "id1",
    "type": "exportTemplate"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.