# Exports

#Available from v.3.10.0 Build and manage exports from the PIM system

POST /exports/buildexport Create an export

#Available from v.3.10.12

Request parameters

Property name Parameter type Data type Description
model body object : ExportModel

Model defining the export to build

ExportModel
Property name Data type Description
EntityType string

The entity type to export data for

EntityIds array

The ids to export data for

ExportSettings object : ExportSettings

Settings to use for the export

ExportSettings
Property name Data type Description
ExportSettingsType string

Type of export settings

Can be any of:

  • ExcelExportSettings
  • ExcelListAttributeExportSettings
  • ExcelTemplateExportSettings

Response status OK (200)

object : ExportResult
ExportResult
Property name Data type Description
FileBytes string

The actual file containing the exported data

FileName string

Name of the file

FileExtension string

Extension of the file

MimeType string

Mimetype of the file


GET /exports/fields/{entityType} Create an export

#Available from v.3.10.12

Request parameters

Property name Parameter type Data type Description
entityType path string

Entity type to get fields for

Response status OK (200)

array : ExportField
ExportField
Property name Data type Description
Uid string
Name string