Create Base Run API

The Create Base Run API provides Green Building Studio client developers a facility for submitting a model for simulation into a given project.

Making the request

To access the Create Base Run API, use: https://gbs.autodesk.com/gbs/api/v1/run/create/base/responseFormat

where 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

POST

Parameters

• ProjectId : Id for project which runs are requested.
  • Values: Integer
  • Required: Yes
• Title - Title for this new run
  • Values: string (50 chars max)
  • Required: Yes
• Base64EncodedGbxml - gbXML

  • Values: String base64 encoded and zip compressed gbXML data.
  • Required: Yes
• UtilityId - see utility billing data set API

  • Values: guid string
  • Required: No

Create Base Run Responses

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

JSON Output Example

113

XML Output Example

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">113</int>