Retrieve Performance Simulation Status

Retrieve the status of a performance simulation job.


[block:callout] { "type": "info", "body": "This endpoint is not provisioned by default in all tenants. For availability, please contact your Aurora account team." } [/block] Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

You will need the job_id from the response body of a POST to the Run Performance Simulation endpoint, or from the parameters of a performance_simulation_job_completed webhook call. Note that the webhook fires for both jobs initiated from the API and from the UI.

Path Params
uuid
required

The ID of the tenant to which the design belongs.

uuid
required

The ID of the design for which to retrieve the performance simulation job.

Query Params
string
required

The ID of the performance simulation job.

Responses

Language
Credentials
Bearer
header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json