Export

export_xlsx_summary

export_xlsx_description

post/pimcore-studio/api/export/xlsx

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/export/xlsx
  • Auth: none declared

Request body

elementsinteger[]
elementType'data-object' | 'object' | 'asset' | 'document'

Example request

{
  "elements": [
    83
  ],
  "columns": [
    {
      "key": "id",
      "locale": "en",
      "type": "system.id",
      "group": [
        "system"
      ],
      "config": [
        {
          "advancedColumns": [
            {
              "key": "simpleField",
              "config": {
                "field": "name"
              }
            }
          ],
          "transformers": [
            {
              "key": "uppercase"
            }
          ]
        }
      ]
    }
  ],
  "config": {
    "header": "title"
  },
  "elementType": "asset"
}

Response

export_xlsx_created_response

jobRunIdinteger required

ID of created jobRun

Example response

{
  "jobRunId": 66
}

Changes

No recorded changes to this operation across all 2 revisions of this API.