Jump to

• Request
• Response

Perform Scenario Action

post

/scenarios/{id}

Performs the specified scenario workflow action. Common actions are submit to submit a scenario for approval, approve to approve a scenario, reject to reject it, and apply to overwrite the base data with the scenario data. Additional actions include copy, refresh, and clear.

Request

Path Parameters

• id(required):

  Scenario ID.

Query Parameters

• action:

  Valid values are submit, approve, reject, apply, copy, refresh, and clear.

• overwrite:

  Optional overwrite parameter, applicable only when action is refresh. If true, when the base and scenario data have different values, the base value overwrites the scenario changes. Default is false.

Back to Top

Response

200 Response

OK

Scenario action performed successfully.

400 Response

Bad Request

Failed to perform scenario action. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top