Skip to navigation

Poll async task status

Beta

Poll status for Turn a procedure run plan into an active procedure run. The plan must not already be converted. Returns an async task — poll the task endpoint for completion and the created procedure run ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired
ID of the asynchronous task to poll.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Response

OK
messagestring
statusenum
Allowed values:
resultobject or nullOptional
Output returned when promoting a procedure run plan to an active procedure run.

Errors

400
Procedure Run Plan Promote Get Request Bad Request Error
403
Procedure Run Plan Promote Get Request Forbidden Error
404
Procedure Run Plan Promote Get Request Not Found Error
429
Procedure Run Plan Promote Get Request Too Many Requests Error
500
Procedure Run Plan Promote Get Request Internal Server Error