TestRunWorkflowPackage

POST

/api/v1/t/{tenant}/workflows/packages/test-run

curl --request POST \
  --url https://example.com/api/v1/t/example/workflows/packages/test-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form package=@file

Authorizations

• ApiKey

Parameters

Path Parameters

tenant

required

string

Tenant slug

Query Parameters

realDocument

boolean

documentId

string format: uuid

Request Body^required

Media typemultipart/form-data

object

package

required

string format: binary

Responses

200

OK

Media typeapplication/json

object

runs

required

Array<object>

object

workflow

required

string

fixture

required

null | string

documentId

required

null | string format: uuid

stepName

required

string

passed

required

boolean

result

required

One of:

null

null

object

object

status

required

Allowed values: Running Succeeded Failed

branch

required

null | string

returns

required

Array<object>

object

key

required

string

value

required

null | string

effects

required

Array<object>

Any of: discriminator: kind

object

object

kind

required

string

Allowed values: setField

field

required

string

value

required

null | string

index

required

integer format: int32

object

object

kind

required

string

Allowed values: addTag

tag

required

string

index

required

integer format: int32

object

object

kind

required

string

Allowed values: fileInto

fileType

required

string

number

required

string

index

required

integer format: int32

object

object

kind

required

string

Allowed values: notify

recipients

required

Array<object>

object

kind

required

Allowed values: Member Role

key

required

string

text

required

string

index

required

integer format: int32

object

object

kind

required

string

Allowed values: hint

text

required

string

index

required

integer format: int32

logs

required

Array<object>

object

elapsedMs

required

integer format: int32

level

required

Allowed values: Info Log Warn Error

text

required

string

used

required

object

engineTimeMs

required

integer format: int32

wallClockMs

required

integer format: int32

memoryBytes

required

integer format: int64

resultBytes

required

integer format: int32

logLines

required

integer format: int32

logBytes

required

integer format: int32

sourceCalls

required

integer format: int32

brokerTimeMs

required

integer format: int32

tableLookups

required

integer format: int32

error

required

One of:

null

null

object

object

code

required

string

message

required

null | string

line

required

null | integer format: int32

column

required

null | integer format: int32

bridgeVersion

required

string

diagnostics

required

Array<object>

object

code

required

string

severity

required

Allowed values: Error Warning

message

required

string

line

required

integer format: int32

column

required

integer format: int32

endLine

required

integer format: int32

endColumn

required

integer format: int32

Example

{
  "runs": [
    {
      "result": {
        "status": "Running",
        "effects": [
          {
            "kind": "setField"
          }
        ],
        "logs": [
          {
            "level": "Info"
          }
        ]
      },
      "diagnostics": [
        {
          "severity": "Error"
        }
      ]
    }
  ]
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

413

Payload Too Large

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Unsupported Media Type

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

503

Service Unavailable

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}