Start a Run

POST 
/api/v1/runs/:resource

Start a Run

Request

Path Parameters

resource stringrequired

application/json

Body

cluster string
directorId string

input

object

property name* any

runs

object[]

Array [

inputs object[]

validators

object[]

Array [

jpath string

regex string

resource string

]

]

runtimeConnectors string[]
tenantId string
testSuiteId string

validators

object[]

Array [

jpath string

regex string

resource string

]

Responses

200

OK

application/json

Schema

Schema

cluster string
createdAt date-time
directorId string
error string
id string

input

object

property name* any
isBatch boolean
logs string

output

object

property name* any
parentId string
resourceId string
resourceType string
status ModelsRunStatus (string)

Possible values: [completed, failed, running]

updatedAt date-time

validationResults

object[]

Array [

error string

passed boolean

validator

object

jpath string

regex string

resource string

]

validationSummary

object

failed integer

passed integer

percentage number

Example (from schema)

{
  "cluster": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "directorId": "string",
  "error": "string",
  "id": "string",
  "input": {},
  "isBatch": true,
  "logs": "string",
  "output": {},
  "parentId": "string",
  "resourceId": "string",
  "resourceType": "string",
  "status": "completed",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "validationResults": [
    {
      "error": "string",
      "passed": true,
      "validator": {
        "jpath": "string",
        "regex": "string",
        "resource": "string"
      }
    }
  ],
  "validationSummary": {
    "failed": 0,
    "passed": 0,
    "percentage": 0
  }
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...