API docs by Redocly

OpenAPI definition (v0)

Actuator

Monitor and interact

Spring Boot Actuator Web API Documentation

Actuator web endpoint 'info'

Responses

Response samples

Content type
{ }

Actuator web endpoint 'health'

Responses

Response samples

Content type
{ }

Actuator web endpoint 'health-path'

Responses

Response samples

Content type
{ }

workflow-controller

deactivateWorkflow

Request Body schema: application/json
required
id
string
active
boolean
deploymentId
string
description
string [ 0 .. 512 ] characters
historyTimeToLive
integer <int32> >= 0
object
property name*
additional property
object (JsonNode)
name
required
string [ 4 .. 64 ] characters
Array of objects (Node)
Array
id
string
name
required
string [ 3 .. 64 ] characters
description
string [ 0 .. 512 ] characters
identifier
string
object (Setup)
asyncAfter
boolean
asyncBefore
boolean
versionTag
required
string [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "setup": {
    },
  • "versionTag": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "setup": {
    },
  • "versionTag": "string"
}

activateWorkflow

Request Body schema: application/json
required
object (Workflow)
id
string
active
boolean
deploymentId
string
description
string [ 0 .. 512 ] characters
historyTimeToLive
integer <int32> >= 0
object
name
required
string [ 4 .. 64 ] characters
Array of objects (Node)
object (Setup)
versionTag
required
string [ 1 .. 64 ] characters
tenant
string

Responses

Request samples

Content type
application/json
{
  • "workflow": {
    },
  • "tenant": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "nodes": [
    ],
  • "setup": {
    },
  • "versionTag": "string"
}

tenant-controller

create

header Parameters
accept
string
Request Body schema: application/json
required
tenant
string
object (TenantAttributes)
moduleTo
string
moduleFrom
string

Responses

Request samples

Content type
application/json
{
  • "tenant": "string",
  • "attributes": {
    }
}

Response samples

Content type
application/hal+json
"string"

delete

header Parameters
accept
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/hal+json
{
  • "errors": [
    ],
  • "total_records": 0
}

ramls-controller

getRamls

query Parameters
path
string
header Parameters
x-okapi-url
required
string
accept
string

Responses

Response samples

Content type
application/hal+json
{ }

json-schemas-controller

getSchemas

query Parameters
path
string
header Parameters
x-okapi-url
required
string
accept
string

Responses

Response samples

Content type
application/hal+json
{ }