Exports

Build and manage exports from the PIM system

Create an export

get

#Available from v.3.10.12

Authorizations

Path parameters

entityTypeinteger · enumRequired

Enum representing each supported entity type in enrichment insights engine

Possible values:

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/exports/fields/{entityType} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "text",
    "Name": "text"
  }
]

Create an export

post

#Available from v.3.10.12

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Model defining export to build

EntityTypeinteger · enumOptional

Enum representing each supported entity type in enrichment insights engine

Possible values:

EntityIdsinteger · int32[] | nullableOptional

The ids to export data for

Responses

200

OK

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /v1/exports/buildexport HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 53

{
  "EntityType": 10,
  "EntityIds": [
    1
  ],
  "ExportSettings": {}
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "FileBytes": "Ynl0ZXM=",
  "FileName": "text",
  "FileExtension": "text",
  "MimeType": "text"
}