# 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
{
"EntityType": "Product",
"EntityIds": [
1000,
10001,
10002
],
"ExportSettings": {
"Fields": [
{
"FieldUid": "Product#PIM.InternalId",
"ColumnName": "Id",
"UseFixedValue": false
},
{
"FieldUid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_1_NA",
"ColumnName": "Name (en-GB)",
"UseFixedValue": false
},
{
"FieldUid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_2_NA",
"ColumnName": "Name (da-DK)",
"UseFixedValue": false
}
],
"ExportSettingsType": "ExcelExportSettings"
}
}{
"FileBytes": "U3RydWN0IFBJTSBleGFtcGxl",
"FileName": "Product export",
"FileExtension": "xlsx",
"MimeType": "application/vnd.ms-excel"
}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:
|
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
[
{
"Uid": "PIM.InternalId",
"Name": "Internal id"
},
{
"Uid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_1_NA",
"Name": "Name (en-GB)"
},
{
"Uid": "Product#95821967-e799-4100-b3a3-6ec6ae07e0f0_2_NA",
"Name": "Name (da-DK)"
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| entityType | path | string |
Entity type to get fields for |