Get the status of an Execution

An execution will have many status updates along the way. The primary ones you should trigger off of are.

• QUEUING
• COMPLETE
• FAILED

In general, these are returned in lower-case but may be displayed differently in our UI. There are several other status updates for generating plots and other output. But from an application or automation standpoint, the 3 primary statuses above can help you gauge where your analysis is.

Route

The final routes are subject to change before Go-Live Summer 2024

The following applies to EARLY ACCESS prior to Go Live.

Some of our routes will be changing prior to our final go-live date this summer (2024). They won't change during Early Access, but be sure to check the documentation.

In order to make a smooth tranistion, we'll provide detailed information on which routes changed and which remained the same. As a good programming practice, you store the routes in a central library for easier migration.

Older routes may be kept active for short period of time to help with any transitions.

Endpoint URL

Method Type

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/nca/executions/{id}

GET

Payload

No payload - GET Method

Response

Currently, the response returns all of the execution information. This is subject to change to create a lighter response package. We'll determine the final response by Go-Live Summer 2024.

You can always count on returning an id and a status. Official status_codes are still being defined.

Once the status is complete, a presigned url section will be available containing the url to download your results in a zip format.

Full Source

Note

The presigned section is only available once the status is complete

This may be a separate call in the full version of the api.