Skip to main content
GET
/
v1
/
simulation
/
plan
/
jobs
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.simulation.listRunPlanJobs();

console.log(response.data);
{
  "data": [
    {
      "simulationRunPlanJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "simulationRunPlanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "triggeredBy": "<string>",
      "createdAt": "<string>",
      "startedAt": "<string>",
      "endedAt": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

Maximum number of plan jobs to return (default: 20, max: 50)

Required range: 1 <= x <= 50
Example:

20

​
after
string<uuid>

Cursor for pagination - use the nextCursor value from a previous response

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
status
string

Filter by plan job status (PENDING, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING)

Example:

"COMPLETED"

​
simulationRunPlanId
string<uuid>

Filter by simulation run plan ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
labelId
string<uuid>

Filter by label ID attached to the plan job. Use this if you know the label ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
labelName
string

Filter by label name attached to the plan job. More user-friendly alternative to labelId. Case-insensitive.

Example:

"production-ready"

Response

Paginated list of simulation plan jobs

Paginated list of simulation run plan jobs

​
data
object[]
required
​
pagination
object
required