Run Status API

The Run Status API provides Green Building Studio client developers a facility for discovering the simulation status of a run.

Making The Request

To access the Run Status API, use:

https://gbs.autodesk.com/gbs/api/v1/run/status/runId/altRunId/responseFormat

where runId, altRunId is the id's of the run/simulation that was submitted.

responseFormat may be either of the following values:

json indicates output in JavaScript Object Notation (JSON)
xml indicates output as XML

Note: If responseFormat is omitted, the output will default to XML.

Request Method

GET

Run Status API Responses

Run Status API responses are returned in the format indicated in the responseFormat within the request URL.

JSON Output Example

{"DetailedStatus":"Run submitted for analysis", "StatusPercentDone":0}

XML Output Example

<RunStatus xmlns="http://gbs.autodesk.com/gbs/api/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <DetailedStatus>Finished</DetailedStatus>
   <StatusPercentDone>100</StatusPercentDone>
</RunStatus>