Sign in

v1

latestOpenAPI 3.0.02026-07-132849114.2 KB
Exports

Retrieve the status of an Export.

Check the status of an Export by ID.

get/v4/exports/{exportId}/status

Path parameters

exportIdstring uuid required

Unique identifier of an Export.

Response

OK

status'PROCESSING' | 'INVALID' | 'EXPIRED' | 'COMPLETED' | 'NO_DATA' required

Current status of the export request:

  • PROCESSING - Export request has been received by Climate and is being processed.
  • INVALID - Export request has failed validity check.
  • EXPIRED - Export contents have expired, and are no longer available for retrieval.
  • COMPLETED - The export request has been successfully processed, and its contents are available for retrieval.
  • NO_DATA - The export request completed successfully but generated no data.
errorstring

Message indicating reason for validation failure.

sizeinteger

Size of the export's contents in bytes.

checksumstring

Base64 encoded MD5 hash of the export's contents.

xNextTokenstring

Token which may be used when executing an identical export in the future, but which only wants export data which was not previously exported. Assume a given field export request matches 12 fields today. And tomorrow it matches 15 fields. By passing the xNextToken in the definition section of tomorrow's field export request, only the 3 additional fields would be exported. Note, all other parameters passed in the definition section must be identical to the original request.