ROroarkhq
Simulation Run Plan Job

List simulation plan jobs

Changed on

Returns a paginated list of simulation run plan jobs. Filter by status, plan ID, or label to find specific simulation batches.

get/v1/simulation/plan/jobs

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/plan/jobs
  • Auth
    HTTP bearer

Query parameters

limitinteger

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

Example:20
afterstring uuid

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

Example:550e8400-e29b-41d4-a716-446655440000
status'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'PREPARING_CAPACITY' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING' | 'ENDING_SIMULATIONS'

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

Example:COMPLETED
simulationRunPlanIdstring uuid

Filter by simulation run plan ID

Example:550e8400-e29b-41d4-a716-446655440000
labelIdstring uuid

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

Example:550e8400-e29b-41d4-a716-446655440000
labelNamestring

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

Changes

  • 6a09e09bd1caRevision changes
    • info

      added the non-success response with the status

  • 9080f2313118Revision changes
    • warning

      added the new PREPARING_CAPACITY enum value to the // response property for the response status

    • info

      added the new enum value PREPARING_CAPACITY to the query request parameter status