SHshapemaker
analysis

Get Analysis Status For Analysis Run Id

get/v1/analysis/statuses/{analysis_run_id}

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Path parameters

analysis_run_idstring required

Response

Successful Response

uuidstring required
structureNamestring required
createdAtUTCstring date-time required
startedAtUTCstring date-time nullable required
completedAtUTCstring date-time nullable required
createdBystring required
organizationIdinteger required
batchAnalysisStatusIdinteger nullable required
errorMessagestring nullable required
status'PENDING' | 'IN PROGRESS' | 'SUCCESSFUL' | 'FAILED' | 'CANCELLED' required
structureUuidstring required
estimatedCompletedAtUTCstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.