ResponseOfExportResponse
5 properties20 including nested16 operations use this
Properties
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
requestId string required Id of the request made
result array of ExportResponse required
Array of results for individual records in the operation, may be empty
Model ExportResponse
createdAt string (date-time) Date when the export request was created
errorMsg string Error message in case of "Failed" status
exportId string required Unique id of the export job
fileSize integer (int64) Size of exported file in bytes. This will have a value only when status is "Completed", otherwise null
fileChecksum string SHA-256 hash of exported file. This will have a value only when status is "Completed", otherwise null
finishedAt string (date-time) Finish time of export job. This will have value only when status is "Completed" or "Failed", otherwise null
format string Format of file as given in the request ("CSV", "TSV", "SSV")
numberOfRecords integer (int64) Number of records in the export file. This will have value only when status is "Completed", otherwise null
queuedAt string (date-time) Queue time of export job. This will have value when "Queued" status is reached, before that null
startedAt string (date-time) Start time of export job. This will have value when "Processing" status is reached, before that null
status string required Status of the export job ("Created","Queued","Processing","Canceled","Completed","Failed")
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Referenced models
Used by
16 operations in 4 groups, including indirect use through another model.
Bulk Export Activities4
POSTCancel Export Activity JobPOSTCreate Export Activity JobPOSTEnqueue Export Activity JobGETGet Export Activity Job StatusBulk Export Custom Objects4
POSTCancel Export Custom Object JobPOSTCreate Export Custom Object JobPOSTEnqueue Export Custom Object JobGETGet Export Custom Object Job StatusGenerated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.