Exports
Get all exports
Restricted!This operation is currently in beta-test and as such it is subject to change.
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. |
Add export
Restricted!This operation is currently in beta-test and as such it is subject to change.
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. |
| required | Type of exported entities |
Response
Property | Type | Contract | Description |
---|---|---|---|
| required | Added export. |
Export
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the export. |
| required | Current status of the export. | |
| required | Type of exported entities | |
| array of Export file entry | 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
Processing
Success
Failed
Expired
Exported entity type
OrderItem
Payment
Reservation
Customer
Company
Bill
AvailabilityAdjustment
AvailabilityBlock
ResourceBlock
Export file entry
Property | Type | Contract | Description |
---|---|---|---|
| string | required | URL of the exported file for download in JSON Lines format. |
| integer | required | Total size of the exported file in bytes. |
Last updated