Delete a scenario

Deletes a simulation scenario by its ID.

DELETE /v1/simulation/scenario/{scenarioId}

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 simulationScenario = await client.simulationScenario.delete('scenarioId');

console.log(simulationScenario.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

scenarioId · string · required

The ID of the scenario to delete

Response

200

application/json

Scenario deleted successfully

data · object · required

Show child attributes