Exports
Restricted!These operations are currently in beta-test and as such are subject to change.
Get all exports
Get exports for the given ExportIds
. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/exports/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the Exports. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Export | required | Requested exports. |
Export
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the export. |
| string Export status | required | Current status of the export. |
| string Entity type | required | Type of exported entities. |
| array of Exported files | required | Files with exported data. Empty if no files are available. |
| string | optional | Expiration date and time of the export in UTC timezone in ISO 8601 format. After this time the Exported files may no longer be available for download. |
Export status
Pending
- export created but hasn't started yet.Processing
- export process has started.Success
- export has been successfully finished and Exported files are available for download.Expired
- export has expired and exported files are no longer available.Failed
- export has failed and exported files are not available; you can try creating a new export.
Exported file
Property | Type | Contract | Description |
---|---|---|---|
| string | required | URL of the exported file for download in JSON Lines format. |
| number | required | Total size of the exported file in bytes. |
Add export
Create a pending export. Export all entities of the specified EntityType
within the enterprise. Note this operation supports Portfolio Access Tokens but doesn't have filtering by EnterpriseIds
or ChainIds
, so will return entities from all enterprises within the scope of the portfolio. If there is already an export with status Pending
or Processing
for the specified entity type, the request for a new export will be rejected. Successful exports remain available for download until the expiration date specified in ExpiresUtc
.
Request
[PlatformAddress]/api/connector/v1/exports/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string Entity type | required | Type of exported entities. |
Entity type
OrderItem
- Order itemsPayment
- PaymentsReservation
- ReservationsCustomer
- CustomerCompany
- Company...
Response
Property | Type | Contract | Description |
---|---|---|---|
| required | Added export. |
Last updated