Skip to content
Renewables.Architect

Update Analysis State

PUT
/analyses/{analysis_id}/state

Update the state of an analysis to cancelled or terminated.

Setting the state to ‘Cancelled’ prevents all queued runs from being started. Runs that are already in progress will complete. Setting the state to ‘Terminated’ cancels all queued runs and terminates all runs that are already in progress.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
analysis_id
required
Analysis Id
string

Query Parameters

Section titled “Query Parameters ”
organization_name
Any of:
string

Header Parameters

Section titled “Header Parameters ”
x-originating-user-id
X-Originating-User-Id
string
x-originating-user-organization-name
X-Originating-User-Organization-Name
string

Request Body required

Section titled “Request Body required ”
StateRequest

Schema for update state endpoints.

object
state
required
State
string
Allowed values: Cancelled Terminated

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string