Delete Base Run API

The Delete Run API provides GBStudio client developers a facility for deleting a Run and all related data and files that are attached to the Run.

Making The Request

To access the Delete Run API, use:

https://gbs.autodesk.com/gbs/api/v1/un/delete/runId/altRunId/responseFormat

where runId, altRunId is the unique identification of the run simulation you want to delete.

Note: If altRunId is 0. All the alternative runs will also be deleted.

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

API Responses

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

JSON Output Example

True

XML Output Example

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> true</boolean>