Run List API

The Run List API provides Green Building Studio client developers a facility for discovering what simulation runs exist in a given project. The output includes runId, altRunId, Title, and run status.

Making The Request

To access the Run List API, use:

https://gbs.autodesk.com/gbs/api/v1/project/runs/projectId/responseFormat

where projectId is the integer id of the project for which to retrieve a list of runs

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.

Run List API Responses

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

JSON Output Example

[{"altRunId": 0,"name": "FirstStreet.xml", "runId": 30676, "status": 4 "useSI": false}, {"altRunId": 59, "name": "With xlucent wall", "runId": 30676,     "status": 4, "useSI": false}, { "altRunId": 60, "name": "Premium HVAC", "runId": 30676, "status": 5, "useSI": false}]

XML Output Example

<ArrayOfProjectRun>
 <ProjectRun>
  <altRunId>0</altRunId>
  <name>FirstStreet.xml</name>
  <runId>30676</runId>
  <status>4</status>
  <useSI>false</useSI>
  </ProjectRun>
 <ProjectRun>
  <altRunId>59</altRunId>
  <name>With xlucent wall</name>
  <runId>30676</runId>
  <status>4</status>
  <useSI>false</useSI>
  </ProjectRun>
 <ProjectRun>
  <altRunId>60</altRunId>
  <name>Premium HVAC</name>
  <runId>30676</runId>
  <status>5</status>
  <useSI>false</useSI>
  </ProjectRun>
</ArrayOfProjectRun>