Cancel a simulation plan job

Stops a run that has not finished yet. Already-finished runs are left alone.

Intended for CI: when a pipeline is cancelled or superseded, cancelling the run stops it placing calls you no longer need. Safe to call more than once.

POST /v1/simulation/plan/job/{jobId}/cancel

JavaScript

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.simulationRunPlanJob.cancel('7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f');

console.log(response.data);

200

{
  "data": {
    "simulationRunPlanJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "status": "CANCELLED",
    "cancelled": true
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

jobId · string<uuid> · required

Simulation run plan job ID

Response

200

application/json

The run is cancelled, or had already finished

data · object · required

Result of cancelling a simulation plan job

Show child attributes

Example:

{
  "simulationRunPlanJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
  "status": "CANCELLED",
  "cancelled": true
}