Delete a run plan

Soft-deletes a simulation run plan by its ID.

DELETE /v1/simulation/plan/{planId}

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 simulationRunPlan = await client.simulationRunPlan.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(simulationRunPlan.data);

200

{
  "data": {
    "deleted": true
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

planId · string<uuid> · required

The ID of the run plan to delete

Response

200

application/json

Run plan deleted successfully

data · object · required

Show child attributes