SIsimscale
Export

Get the status of the export and temporary download link to the exported object if it is done

get/projects/{projectId}/export/{exportId}

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/projects/{projectId}/export/{exportId}
  • Auth
    API key in header X-API-KEY

Response

The status of the export and the temporary download link to the exported object if it is done

exportIdstring uuid
statusstring

RUNNING - Export is still in progress DONE - Export is done and ready for download FAILED - Export failed, please retry or contact support EXPIRED - Export is expired, please trigger a new export for the result

urlstring

The temporary url for downloading the exported result, only set when status is DONE.

urlExpiresAtstring

Timestamp that the url will be expired, only set when status is DONE. Note that this timestamp is not a guarantee, if the url expired prematurely, please retry this request to get a new one.

errorCodestring

Changes

No operation changes recorded.