OpenAPI Documentation

OpenAPI v3 JSON - https://test.scoring.one/docs

https://test.scoring.one/swagger-ui/index.htmltest.scoring.one

Open scenario

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/open/{id}

Returns the development version for editing or the latest version.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Scenario ID

Query parameters

Responses

200

Scenario version returned

application/json

idstringOptional

userIdstringOptional

namestringOptional

createdAtstring · date-timeOptional

contentstringOptional

versionstringOptional

sourceVersionstringOptional

descriptionstringOptional

401

Unauthorized – valid JWT required

application/json

403

Forbidden – insufficient permissions

application/json

404

Scenario not found

application/json

get

/api/scenario/open/{id}

HTTPcURLJavaScriptPython

GET /api/scenario/open/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "userId": "text",
  "name": "text",
  "createdAt": "2026-03-27T00:40:54.437Z",
  "content": "text",
  "nodeProperties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "content": "text",
      "type": "text"
    }
  },
  "version": "text",
  "sourceVersion": "text",
  "description": "text",
  "testCases": [
    {
      "id": "text",
      "externalId": 1,
      "name": "text",
      "variables": [
        {
          "variableName": "text",
          "value": null
        }
      ],
      "expression": {
        "code": "text",
        "language": "text"
      },
      "ignore": true
    }
  ]
}

Get scenario versions

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{id}/version

Returns version history for the scenario.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Responses

200

Versions returned

application/json

idstringOptional

versionstringOptional

descriptionstringOptional

sourceVersionstringOptional

createdAtstring · date-timeOptional

401

Unauthorized – valid JWT required

application/json

404

Scenario not found

application/json

get

/api/scenario/{id}/version

HTTPcURLJavaScriptPython

GET /api/scenario/{id}/version?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "version": "text",
    "description": "text",
    "sourceVersion": "text",
    "createdAt": "2026-03-27T00:40:54.437Z"
  }
]

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{id}/input

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Responses

200

OK

application/json

get

/api/scenario/{id}/input

HTTPcURLJavaScriptPython

GET /api/scenario/{id}/input?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "ANY_ADDITIONAL_PROPERTY": {
    "name": "text",
    "type": {
      "type": "STRING"
    },
    "required": true,
    "description": "text",
    "tags": [
      "text"
    ]
  }
}

Get input variable names

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/data/inputvariables/{id}

Returns input variable names for the scenario.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Responses

200

Variable names returned

application/json

string[]Optional

401

Unauthorized – valid JWT required

application/json

404

Scenario not found

application/json

get

/api/scenario/data/inputvariables/{id}

HTTPcURLJavaScriptPython

GET /api/scenario/data/inputvariables/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Copy scenario

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/copy/{id}/{copiedScenarioName}

Copies a scenario with a new name.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

copiedScenarioNamestringRequired

Query parameters

Responses

200

Scenario copied

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

409

Scenario with name already exists

application/json

post

/api/scenario/copy/{id}/{copiedScenarioName}

HTTPcURLJavaScriptPython

POST /api/scenario/copy/{id}/{copiedScenarioName}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Debug scenario

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/debug/{id}

Debugs scenario with optional debugging data.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Body

application/json

Other propertiesanyOptional

Responses

200

Debug result returned

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

422

Compilation errors

application/json

post

/api/scenario/debug/{id}

HTTPcURLJavaScriptPython

POST /api/scenario/debug/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{}

Rename scenario

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/rename/{currentName}/{newName}

Renames a scenario.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

currentNamestringRequired

newNamestringRequired

Query parameters

Responses

200

Scenario renamed

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

409

Scenario with name already exists

application/json

post

/api/scenario/rename/{currentName}/{newName}

HTTPcURLJavaScriptPython

POST /api/scenario/rename/{currentName}/{newName}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Deploy scenario

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/deploy/{id}

Deploys scenario. Optional skip_validation and validation data.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

skip_validationbooleanOptionalDefault: false

Body

application/json

Other propertiesanyOptional

Responses

204

Scenario deployed

application/json

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

422

Validation error

application/json

post

/api/scenario/deploy/{id}

HTTPcURLJavaScriptPython

POST /api/scenario/deploy/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{}

Create input variables from CSV

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/data/inputvariables/create

Creates scenario input variables from uploaded CSV file.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Body

multipart/form-data

Responses

200

Variables created

application/json

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

post

/api/scenario/data/inputvariables/create

HTTPcURLJavaScriptPython

POST /api/scenario/data/inputvariables/create HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 3463

{
  "actors": {
    "requester": {
      "id": "text",
      "username": "text",
      "password": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "companyName": "text",
      "phoneNumber": "text",
      "authenticationToken": "text",
      "scoreToken": "text",
      "activationToken": "text",
      "resetPasswordToken": "text",
      "activationTokenExpires": "2026-03-27T00:40:54.437Z",
      "resetPasswordTokenExpires": "2026-03-27T00:40:54.437Z",
      "passwordValidityDuration": "2026-03-27T00:40:54.437Z",
      "isPasswordExpired": true,
      "lastSuccessfulLogin": "text",
      "lastUnsuccessfulLogin": "text",
      "accountNonExpired": true,
      "accountNonLocked": true,
      "credentialsNonExpired": true,
      "enabled": true,
      "registered": true,
      "agreePolicy": true,
      "agreeProcessing": true,
      "roles": [
        {
          "name": "text",
          "authority": "text"
        }
      ],
      "credentials": [
        {
          "id": "text",
          "businessId": 1,
          "name": "text",
          "credentialType": "DATABASE",
          "databaseType": "POSTGRES",
          "databaseName": "text",
          "schema": "text",
          "login": "text",
          "password": "text",
          "host": "text"
        }
      ],
      "isBeforeFirstLogin": true,
      "isLoginHasToBeReported": true,
      "identityProvider": "MICROSOFT",
      "attempts": 1,
      "passwordDurationLimited": true,
      "admin": true,
      "isAccountNonLocked": true,
      "authorities": [
        {
          "authority": "text"
        }
      ],
      "externalUser": true,
      "workspace": true
    },
    "resourceOwner": {
      "id": "text",
      "username": "text",
      "password": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "companyName": "text",
      "phoneNumber": "text",
      "authenticationToken": "text",
      "scoreToken": "text",
      "activationToken": "text",
      "resetPasswordToken": "text",
      "activationTokenExpires": "2026-03-27T00:40:54.437Z",
      "resetPasswordTokenExpires": "2026-03-27T00:40:54.437Z",
      "passwordValidityDuration": "2026-03-27T00:40:54.437Z",
      "isPasswordExpired": true,
      "lastSuccessfulLogin": "text",
      "lastUnsuccessfulLogin": "text",
      "accountNonExpired": true,
      "accountNonLocked": true,
      "credentialsNonExpired": true,
      "enabled": true,
      "registered": true,
      "agreePolicy": true,
      "agreeProcessing": true,
      "roles": [
        {
          "name": "text",
          "authority": "text"
        }
      ],
      "credentials": [
        {
          "id": "text",
          "businessId": 1,
          "name": "text",
          "credentialType": "DATABASE",
          "databaseType": "POSTGRES",
          "databaseName": "text",
          "schema": "text",
          "login": "text",
          "password": "text",
          "host": "text"
        }
      ],
      "isBeforeFirstLogin": true,
      "isLoginHasToBeReported": true,
      "identityProvider": "MICROSOFT",
      "attempts": 1,
      "passwordDurationLimited": true,
      "admin": true,
      "isAccountNonLocked": true,
      "authorities": [
        {
          "authority": "text"
        }
      ],
      "externalUser": true,
      "workspace": true
    }
  },
  "resourceOwnerOrRequester": {
    "id": "text",
    "username": "text",
    "password": "text",
    "email": "text",
    "firstName": "text",
    "lastName": "text",
    "companyName": "text",
    "phoneNumber": "text",
    "authenticationToken": "text",
    "scoreToken": "text",
    "activationToken": "text",
    "resetPasswordToken": "text",
    "activationTokenExpires": "2026-03-27T00:40:54.437Z",
    "resetPasswordTokenExpires": "2026-03-27T00:40:54.437Z",
    "passwordValidityDuration": "2026-03-27T00:40:54.437Z",
    "isPasswordExpired": true,
    "lastSuccessfulLogin": "text",
    "lastUnsuccessfulLogin": "text",
    "accountNonExpired": true,
    "accountNonLocked": true,
    "credentialsNonExpired": true,
    "enabled": true,
    "registered": true,
    "agreePolicy": true,
    "agreeProcessing": true,
    "roles": [
      {
        "name": "text",
        "authority": "text"
      }
    ],
    "credentials": [
      {
        "id": "text",
        "businessId": 1,
        "name": "text",
        "credentialType": "DATABASE",
        "databaseType": "POSTGRES",
        "databaseName": "text",
        "schema": "text",
        "login": "text",
        "password": "text",
        "host": "text"
      }
    ],
    "isBeforeFirstLogin": true,
    "isLoginHasToBeReported": true,
    "identityProvider": "MICROSOFT",
    "attempts": 1,
    "passwordDurationLimited": true,
    "admin": true,
    "isAccountNonLocked": true,
    "authorities": [
      {
        "authority": "text"
      }
    ],
    "externalUser": true,
    "workspace": true
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "name": "text",
    "type": {
      "type": "STRING"
    },
    "required": true,
    "description": "text",
    "tags": [
      "text"
    ]
  }
}

Validate scenario

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/validate/{id}

Validates scenario with optional validation data.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Body

application/json

Other propertiesanyOptional

Responses

204

Validation passed

application/json

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

422

Validation error

application/json

post

/api/scenario/validate/{id}

HTTPcURLJavaScriptPython

POST /api/scenario/validate/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{}

Import scenarios

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/import

Imports scenarios from JSON/YAML. Supports overwrite flags for develop and deploy versions.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Query parameters

overwrite_developbooleanOptionalDefault: false

overwrite_deploybooleanOptionalDefault: false

Body

application/jsonapplication/yaml

stringOptional

Responses

200

Import completed

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

post

/api/scenario/import

HTTPcURLJavaScriptPython

POST /api/scenario/import?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

application/jsonapplication/yaml

{}

Export scenarios (YAML)

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/export

Exports scenarios as YAML. Use type=yaml query param.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Query parameters

namestringOptional

Responses

200

Scenarios exported

application/json

idstringOptional

userIdstringOptional

namestringOptional

createdAtstring · date-timeOptional

contentstringOptional

versionstringOptional

sourceVersionstringOptional

descriptionstringOptional

401

Unauthorized – valid JWT required

application/json

get

/api/scenario/export

HTTPcURLJavaScriptPython

GET /api/scenario/export?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "userId": "text",
    "name": "text",
    "createdAt": "2026-03-27T00:40:54.437Z",
    "content": "text",
    "nodeProperties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "text",
        "content": "text",
        "type": "text"
      }
    },
    "version": "text",
    "sourceVersion": "text",
    "description": "text",
    "testCases": [
      {
        "id": "text",
        "externalId": 1,
        "name": "text",
        "variables": [
          {
            "variableName": "text",
            "value": null
          }
        ],
        "expression": {
          "code": "text",
          "language": "text"
        },
        "ignore": true
      }
    ]
  }
]

Save test case

put

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{scenarioId}/tests/{id}

Updates an existing test case.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

scenarioIdstringRequired

idinteger · int64Required

Query parameters

Body

application/json

Scenario test case – input variables and expected outcome

idinteger · int64Optional

Test case ID

namestringOptional

Test case name

ignorebooleanOptional

Whether to ignore this test

Responses

200

Test case saved

application/json

objectOptional

400

Validation error

application/json

401

Unauthorized – valid JWT required

application/json

403

Forbidden – insufficient permissions

application/json

put

/api/scenario/{scenarioId}/tests/{id}

HTTPcURLJavaScriptPython

PUT /api/scenario/{scenarioId}/tests/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "id": 1,
  "name": "text",
  "variables": [
    {
      "variableName": "text",
      "value": null
    }
  ],
  "expression": {
    "code": "text",
    "language": "text"
  },
  "ignore": true
}

{}

Remove test case

delete

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{scenarioId}/tests/{id}

Deletes a test case.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

scenarioIdstringRequired

idinteger · int64Required

Query parameters

Responses

204

Test case removed

401

Unauthorized – valid JWT required

403

Forbidden – insufficient permissions

delete

/api/scenario/{scenarioId}/tests/{id}

HTTPcURLJavaScriptPython

DELETE /api/scenario/{scenarioId}/tests/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get graph

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/graph/{id}

Returns scenario graph by ID.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Scenario ID

Query parameters

Responses

200

Graph returned

application/json

Resource wrapped with granted permissions for the current user

401

Unauthorized – valid JWT required

application/json

404

Scenario not found

application/json

get

/api/scenario/graph/{id}

HTTPcURLJavaScriptPython

GET /api/scenario/graph/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resource": {
    "id": "text",
    "userId": "text",
    "name": "text",
    "createdAt": "2026-03-27T00:40:54.437Z",
    "content": "text",
    "nodeProperties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "text",
        "content": "text",
        "type": "text"
      }
    },
    "version": "text",
    "sourceVersion": "text",
    "description": "text",
    "testCases": [
      {
        "id": "text",
        "externalId": 1,
        "name": "text",
        "variables": [
          {
            "variableName": "text",
            "value": null
          }
        ],
        "expression": {
          "code": "text",
          "language": "text"
        },
        "ignore": true
      }
    ]
  },
  "permissions": [
    "read"
  ]
}

Update graph

put

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/graph/{id}

Updates scenario graph content.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Scenario ID

Query parameters

Body

application/json

idstringOptional

userIdstringOptional

namestringOptional

createdAtstring · date-timeOptional

contentstringOptional

versionstringOptional

sourceVersionstringOptional

descriptionstringOptional

Responses

200

Graph updated

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

put

/api/scenario/graph/{id}

HTTPcURLJavaScriptPython

PUT /api/scenario/graph/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "id": "text",
  "userId": "text",
  "name": "text",
  "createdAt": "2026-03-27T00:40:54.437Z",
  "content": "text",
  "nodeProperties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "content": "text",
      "type": "text"
    }
  },
  "version": "text",
  "sourceVersion": "text",
  "description": "text",
  "testCases": [
    {
      "id": "text",
      "externalId": 1,
      "name": "text",
      "variables": [
        {
          "variableName": "text",
          "value": null
        }
      ],
      "expression": {
        "code": "text",
        "language": "text"
      },
      "ignore": true
    }
  ]
}

{}

Create test case

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{scenarioId}/tests

Creates a new scenario test case.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

scenarioIdstringRequired

Query parameters

Body

application/json

Scenario test case – input variables and expected outcome

idinteger · int64Optional

Test case ID

namestringOptional

Test case name

ignorebooleanOptional

Whether to ignore this test

Responses

200

Test case created

application/json

objectOptional

400

Validation error

application/json

401

Unauthorized – valid JWT required

application/json

403

Forbidden – insufficient permissions

application/json

post

/api/scenario/{scenarioId}/tests

HTTPcURLJavaScriptPython

POST /api/scenario/{scenarioId}/tests?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "id": 1,
  "name": "text",
  "variables": [
    {
      "variableName": "text",
      "value": null
    }
  ],
  "expression": {
    "code": "text",
    "language": "text"
  },
  "ignore": true
}

{}

Restore version

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/restore/{id}

Restores scenario to a previous version.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

idstringRequired

Query parameters

Responses

204

Version restored

application/json

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

404

Scenario not found

application/json

post

/api/scenario/restore/{id}

HTTPcURLJavaScriptPython

POST /api/scenario/restore/{id}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Create node

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/node/{nodeType}

Creates a new node of given type.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

nodeTypestringRequired

Node type

Query parameters

Responses

200

Node returned successfully

application/json

idstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

userIdstringOptional

401

Unauthorized – valid JWT required

application/json

post

/api/scenario/node/{nodeType}

HTTPcURLJavaScriptPython

POST /api/scenario/node/{nodeType}?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2026-03-27T00:40:54.437Z",
  "updatedAt": "2026-03-27T00:40:54.437Z",
  "userId": "text"
}

List graphs

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/graph

Returns list of scenario graphs.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Query parameters

Responses

200

Graphs returned

application/json

idstringOptional

userIdstringOptional

namestringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deployedAtstring · date-timeOptional

deployedVersionstringOptional

401

Unauthorized – valid JWT required

application/json

get

/api/scenario/graph

HTTPcURLJavaScriptPython

GET /api/scenario/graph?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "userId": "text",
    "name": "text",
    "createdAt": "2026-03-27T00:40:54.437Z",
    "updatedAt": "2026-03-27T00:40:54.437Z",
    "deployedAt": "2026-03-27T00:40:54.437Z",
    "deployedVersion": "text"
  }
]

Create graph

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/graph

Creates a new scenario graph.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Query parameters

Responses

200

Graph created

application/json

objectOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

post

/api/scenario/graph

HTTPcURLJavaScriptPython

POST /api/scenario/graph?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Async score

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/code/scoreasync/{name}

Submits async scoring request. Callback URL required.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

namestringRequired

Scenario code name

Body

application/json

stringOptional

Responses

202

Request accepted

*/*

400

Invalid request

*/*

401

Unauthorized – valid JWT required

*/*

post

/api/scenario/code/scoreasync/{name}

HTTPcURLJavaScriptPython

POST /api/scenario/code/scoreasync/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

text

Score scenario code

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/code/score

Scores scenario code. JWT or score-token header required.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Query parameters

namestringRequired

Scenario code name

Body

application/json

Other propertiesanyOptional

Responses

200

Scoring result returned

application/json

stringOptional

401

Unauthorized – valid JWT required

application/json

post

/api/scenario/code/score

HTTPcURLJavaScriptPython

POST /api/scenario/code/score?name=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

text

Run single test

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/{scenarioId}/tests/{id}/query

Executes a single test case and returns results.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

scenarioIdstringRequired

Scenario ID

idinteger · int64Required

Test case ID

Query parameters

Responses

200

Test result returned

application/json

beginTimestring · date-timeOptional

endTimestring · date-timeOptional

401

Unauthorized – valid JWT required

application/json

404

Test case not found

application/json

get

/api/scenario/{scenarioId}/tests/{id}/query

HTTPcURLJavaScriptPython

GET /api/scenario/{scenarioId}/tests/{id}/query?context=[object+Object] HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "beginTime": "2026-03-27T00:40:54.437Z",
  "endTime": "2026-03-27T00:40:54.437Z",
  "results": [
    {
      "name": "text",
      "errors": [
        "text"
      ],
      "output": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Process scenario code

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/code/process/{scenarioCodeName}

Processes scenario code with callback support. Score token required.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

Path parameters

scenarioCodeNamestringRequired

Scenario code name

Body

application/json

Other propertiesanyOptional

Responses

200

Process result returned

application/json

stringOptional

401

Unauthorized – valid JWT required

application/json

post

/api/scenario/code/process/{scenarioCodeName}

HTTPcURLJavaScriptPython

POST /api/scenario/code/process/{scenarioCodeName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

text

Remote score (POST)

post

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/code/remote/score

Scores scenario code via score token (key query param). Public CORS.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

cookie

sceuidstringOptional

Query parameters

namestringRequired

Scenario code name

keystringRequired

Score token

Body

application/json

Other propertiesanyOptional

Responses

200

Scoring result returned

application/json

stringOptional

401

Unauthorized – valid JWT required

application/json

403

Insufficient permissions

application/json

post

/api/scenario/code/remote/score

HTTPcURLJavaScriptPython

POST /api/scenario/code/remote/score?name=text&key=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

text

Remote score (GET)

get

https://api.example.comhttps://staging-api.example.comhttp://localhost:8080

/api/scenario/code/remote/score

Scores scenario code via score token (key query param). Input as query params.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer token (authorization token)

cookie

sceuidstringOptional

Query parameters

namestringRequired

Scenario code name

keystringRequired

Score token

Responses

200

Scoring result returned

application/json

stringOptional

401

Unauthorized – valid JWT required

application/json

get

/api/scenario/code/remote/score

HTTPcURLJavaScriptPython

GET /api/scenario/code/remote/score?name=text&key=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text