Skip to main content
PUT
/
v1
/
simulation
/
plan
/
{planId}
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.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(simulationRunPlan.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "direction": "INBOUND",
    "iterationCount": 123,
    "maxConcurrentJobs": 123,
    "maxSimulationDurationSeconds": 123,
    "silenceTimeoutSeconds": 123,
    "endCallPhrases": [
      "<string>"
    ],
    "executionMode": "PARALLEL",
    "scenarios": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "personas": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "agentEndpoints": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "evaluators": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "testCaseCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>"
  }
}

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 update

Body

application/json

Input for updating an existing simulation run plan

​
name
string

Name of the run plan

Minimum string length: 1
​
description
string

Description of the run plan

​
direction
enum<string>

Direction of the simulation (INBOUND or OUTBOUND)

Available options:
INBOUND,
OUTBOUND
​
iterationCount
integer

Number of iterations to run for each test case. Must be 1 for OUTBOUND direction.

Required range: x >= 1
​
maxConcurrentJobs
integer

Maximum number of concurrent simulation jobs

Required range: x >= 1
​
maxSimulationDurationSeconds
integer

Maximum duration in seconds for each simulation

Required range: x >= 1
​
silenceTimeoutSeconds
integer

Timeout in seconds for silence detection

Required range: x >= 1
​
endCallPhrases
string[]

Phrases that trigger end of call. Empty array disables the feature.

​
executionMode
enum<string>

Execution mode (PARALLEL or SEQUENTIAL)

Available options:
PARALLEL,
SEQUENTIAL_SAME_RUN_PLAN,
SEQUENTIAL_PROJECT
​
scenarios
object[]

Scenarios to include in this run plan. The same scenario ID can appear multiple times with different variables.

Minimum array length: 1
​
personas
object[]

Personas to include in this run plan

Minimum array length: 1
​
agentEndpoints
object[]

Agent endpoints to include in this run plan

Minimum array length: 1
​
evaluators
object[]

Evaluators to include in this run plan

Minimum array length: 1

Response

The updated run plan

​
data
object
required

A simulation run plan defining the test matrix