Mutation / jobs
cancelScenarioSimulation
Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.
Arguments
The QUEUED or RUNNING run to cancel
Returns CancelScenarioSimulationPayload!
Explore in a view
View exact SDL
"""
Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.
"""
cancelScenarioSimulation(
"""The QUEUED or RUNNING run to cancel"""
id: ScenarioSimulationRunID!
): CancelScenarioSimulationPayload! @topic(names: ["jobs"])Schema reference describes the API contract. Actual access is checked by the platform for every operation.