API docs by Redocly

OpenAPI definition (v0)

tenant

the tenant API

postTenant_1

Create tenant job (create, upgrade, delete)

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

Existing module ID. If omitted, the module is not enabled already

module_to
string

Target module ID. If omitted, the existing module is disabled

purge
boolean

On disable should data also be purged

Array of objects (parameter)

List of key/value parameters

Array
key
required
string

The key for this parameter

value
string

The value of this parameter

Responses

Request samples

Content type
application/json
{
  • "module_from": "string",
  • "module_to": "string",
  • "purge": true,
  • "parameters": [
    ]
}

Response samples

Content type
application/hal+json
"string"

getTenant

Does tenant id already exist

path Parameters
operationId
required
string

Operation ID

Responses

Response samples

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

deleteTenant

drop tenant id

path Parameters
operationId
required
string

Operation ID

Responses

Response samples

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

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
{ }

node-entity-controller

getCollectionResource-node-get_1

get-node

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-node-post

create-node

Request Body schema: application/json
required
id
string
name
required
string [ 3 .. 64 ] characters
description
string [ 0 .. 512 ] characters
identifier
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "identifier": "string"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "deserializeAs": "string",
  • "identifier": "string",
  • "_links": {
    }
}

getItemResource-node-get

get-node

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "deserializeAs": "string",
  • "identifier": "string",
  • "_links": {
    }
}

putItemResource-node-put

update-node

path Parameters
id
required
string
Request Body schema: application/json
required
id
string
name
required
string [ 3 .. 64 ] characters
description
string [ 0 .. 512 ] characters
identifier
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "identifier": "string"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "deserializeAs": "string",
  • "identifier": "string",
  • "_links": {
    }
}

deleteItemResource-node-delete

delete-node

path Parameters
id
required
string

Responses

patchItemResource-node-patch

patch-node

path Parameters
id
required
string
Request Body schema: application/json
required
id
string
name
required
string [ 3 .. 64 ] characters
description
string [ 0 .. 512 ] characters
identifier
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "identifier": "string"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "deserializeAs": "string",
  • "identifier": "string",
  • "_links": {
    }
}

profile-controller

listAllFormsOfMetadata_1

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    }
}

descriptor_1_1_1

Responses

Response samples

Content type
No sample

descriptor_1_1_2

Responses

Response samples

Content type
No sample

descriptor_1_1_3

Responses

Response samples

Content type
No sample

trigger-entity-controller

getCollectionResource-trigger-get_1

get-trigger

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-trigger-post

create-trigger

Request Body schema: application/json
required
id
string
name
required
string [ 4 .. 64 ] characters
description
string [ 0 .. 256 ] characters
pathPattern
required
string [ 2 .. 256 ] characters
method
required
string
Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET",
  • "_links": {
    }
}

getItemResource-trigger-get

get-trigger

path Parameters
id
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET",
  • "_links": {
    }
}

putItemResource-trigger-put

update-trigger

path Parameters
id
required
string
Request Body schema: application/json
required
id
string
name
required
string [ 4 .. 64 ] characters
description
string [ 0 .. 256 ] characters
pathPattern
required
string [ 2 .. 256 ] characters
method
required
string
Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET",
  • "_links": {
    }
}

deleteItemResource-trigger-delete

delete-trigger

path Parameters
id
required
string

Responses

patchItemResource-trigger-patch

patch-trigger

path Parameters
id
required
string
Request Body schema: application/json
required
id
string
name
required
string [ 4 .. 64 ] characters
description
string [ 0 .. 256 ] characters
pathPattern
required
string [ 2 .. 256 ] characters
method
required
string
Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET"
}

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "pathPattern": "string",
  • "method": "GET",
  • "_links": {
    }
}

trigger-search-controller

executeSearch-trigger-get

query Parameters
object

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

workflow-entity-controller

getCollectionResource-workflow-get_1

get-workflow

query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "page": {
    }
}

postCollectionResource-workflow-post

create-workflow

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
nodes
Array of strings
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/hal+json
{
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "setup": {
    },
  • "versionTag": "string",
  • "_links": {
    }
}

getItemResource-workflow-get_1

get-workflow

path Parameters
id
required
string
query Parameters
tenant
required
string
token
required
string

Responses

Response samples

Content type
{
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "setup": {
    },
  • "versionTag": "string",
  • "_links": {
    }
}

putItemResource-workflow-put

update-workflow

path Parameters
id
required
string
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
nodes
Array of strings
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/hal+json
{
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "setup": {
    },
  • "versionTag": "string",
  • "_links": {
    }
}

patchItemResource-workflow-patch

patch-workflow

path Parameters
id
required
string
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
nodes
Array of strings
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/hal+json
{
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "setup": {
    },
  • "versionTag": "string",
  • "_links": {
    }
}

workflow-search-controller

executeSearch-workflow-get

query Parameters
id
string
object

Responses

Response samples

Content type
application/hal+json
{
  • "active": true,
  • "deploymentId": "string",
  • "description": "string",
  • "historyTimeToLive": 0,
  • "initialContext": {
    },
  • "name": "string",
  • "setup": {
    },
  • "versionTag": "string",
  • "_links": {
    }
}

workflow-property-reference-controller

followPropertyReference-workflow-get_1

get-node-by-workflow-Id

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-workflow-put

update-node-by-workflow-Id

path Parameters
id
required
string
Request Body schema:
required
object
objects
Array of objects
object (Links)
additional property
object (Link)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

createPropertyReference-workflow-patch

patch-node-by-workflow-Id

path Parameters
id
required
string
Request Body schema:
required
object
objects
Array of objects
object (Links)
additional property
object (Link)

Responses

Request samples

Content type
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

followPropertyReference-workflow-get

get-node-by-workflow-Id

path Parameters
id
required
string
propertyId
required
string

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

workflow-controller

deactivateWorkflow

path Parameters
id
required
string
Request Body schema: application/json
tenant
string
token
string

Responses

Request samples

Content type
application/json
{
  • "tenant": "string",
  • "token": "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

path Parameters
id
required
string
Request Body schema: application/json
tenant
string
token
string

Responses

Request samples

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

Response samples

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

startWorkflow

path Parameters
id
required
string
Request Body schema: application/json
required
tenant
string
token
string
context
object (JsonNode)

Responses

Request samples

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

Response samples

Content type
application/json
{ }

importWorkflow

Request Body schema: multipart/form-data
file
required
string <binary>
tenant
string
token
string

Responses

Response samples

Content type
application/json
{ }

workflowHistory

path Parameters
id
required
string
query Parameters
tenant
required
string
token
required
string

Responses

Response samples

Content type
application/json
{ }

searchWorkflows

query Parameters
query
required
string
offset
integer <int64>
Default: 0
limit
integer <int32>
Default: 20
tenant
required
string

Responses

Response samples

Content type
application/json
{ }

deleteWorkflow

path Parameters
id
required
string
Request Body schema: application/json
tenant
string
token
string

Responses

Request samples

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

Response samples

Content type
application/hal+json
{ }

event-controller

postHandleEventsWithFile_1

query Parameters
path
required
string
Request Body schema:
file
required
string <binary>
tenant
string

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{ }

tenant-controller

postTenant_1

Create tenant job (create, upgrade, delete)

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

Existing module ID. If omitted, the module is not enabled already

module_to
string

Target module ID. If omitted, the existing module is disabled

purge
boolean

On disable should data also be purged

Array of objects (parameter)

List of key/value parameters

Array
key
required
string

The key for this parameter

value
string

The value of this parameter

Responses

Request samples

Content type
application/json
{
  • "module_from": "string",
  • "module_to": "string",
  • "purge": true,
  • "parameters": [
    ]
}

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
}

action-controller

getActions

query Parameters
tenant
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
{ }