API Reference

Retrieve Fire Pathway Placement Status

get
https://api-sandbox.aurorasolar.com/tenants//designs//fire_pathway_placement/status

Retrieve the status of an Fire Pathway Placement 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 Fire Pathway Placement endpoint, or from the parameters of a fire_pathway_placement_job_completed webhook call.

[block:callout] { "type": "warning", "body": "Please note that currently only jobs started from the API can be retrieved." } [/block]

Path Params
uuid
required

The Unique ID of the tenant that the design is part of.

uuid
required

The Unique ID of the design to retrieve the Fire Pathway Placement job for.

Query Params
uuid
required

The Unique ID of the Fire Pathway Placement job.

Responses

Updated 6 months ago

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