If something’s missing or unclear, let us know.
Send feedback
Ctrlk
npmGitHubAdmin-Center
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Task

Manage VARIO Cloud batch-processing tasks via API, including scheduling, execution, cancellation, status tracking, logs, and support tasks.

Task for Batch Processing

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · min: 1Required

label of this task

descriptionstringOptional

description of this task

cronExpressionstringRequired

valid cron expression (UNIX style)

lastExecutedAtstring · date-timeRead-onlyOptional

last execution date-time

firstExecutionTimestring · date-timeRequired

first execution date-time

nextExecutionAtstring · date-timeRead-onlyOptional

next execution date-time

nextExecutionOverridestring · date-timeRead-onlyOptional

Wann eine bevorzugte Abarbeitung angefragt wurde

lastStatusstring · enumRead-onlyOptional

lastStatus

Possible values:
jobBeanNamestring · min: 1Required

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:
categorystring · enumRead-onlyOptional

Category

Default: NORMALPossible values:
singletonbooleanOptional

Is this task a singleton

Default: true
repetitionsinteger · int32Optional

How often will this task run? (null -> forever)

processIdstringOptional

process id

traceActivebooleanRead-onlyOptional

Aktiviert Call-Tracing fuer diesen Task

Default: false
get/cmn/task/{id}
GET /cmn/task/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-01-01T00:00:00.000Z",
  "firstExecutionTime": "2026-01-01T00:00:00.000Z",
  "nextExecutionAt": "2026-01-01T00:00:00.000Z",
  "nextExecutionOverride": "2026-01-01T00:00:00.000Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "category": "NORMAL",
  "dataPayloadJson": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  },
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "traceActive": false,
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  }
}

Update existing Resource

put
Path parameters
idinteger · int64Required

an identifier

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · min: 1Required

label of this task

descriptionstringOptional

description of this task

cronExpressionstringRequired

valid cron expression (UNIX style)

lastExecutedAtstring · date-timeRead-onlyOptional

last execution date-time

firstExecutionTimestring · date-timeRequired

first execution date-time

nextExecutionAtstring · date-timeRead-onlyOptional

next execution date-time

nextExecutionOverridestring · date-timeRead-onlyOptional

Wann eine bevorzugte Abarbeitung angefragt wurde

lastStatusstring · enumRead-onlyOptional

lastStatus

Possible values:
jobBeanNamestring · min: 1Required

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:
categorystring · enumRead-onlyOptional

Category

Default: NORMALPossible values:
singletonbooleanOptional

Is this task a singleton

Default: true
repetitionsinteger · int32Optional

How often will this task run? (null -> forever)

processIdstringOptional

process id

traceActivebooleanRead-onlyOptional

Aktiviert Call-Tracing fuer diesen Task

Default: false
Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · min: 1Required

label of this task

descriptionstringOptional

description of this task

cronExpressionstringRequired

valid cron expression (UNIX style)

lastExecutedAtstring · date-timeRead-onlyOptional

last execution date-time

firstExecutionTimestring · date-timeRequired

first execution date-time

nextExecutionAtstring · date-timeRead-onlyOptional

next execution date-time

nextExecutionOverridestring · date-timeRead-onlyOptional

Wann eine bevorzugte Abarbeitung angefragt wurde

lastStatusstring · enumRead-onlyOptional

lastStatus

Possible values:
jobBeanNamestring · min: 1Required

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:
categorystring · enumRead-onlyOptional

Category

Default: NORMALPossible values:
singletonbooleanOptional

Is this task a singleton

Default: true
repetitionsinteger · int32Optional

How often will this task run? (null -> forever)

processIdstringOptional

process id

traceActivebooleanRead-onlyOptional

Aktiviert Call-Tracing fuer diesen Task

Default: false
put/cmn/task/{id}
PUT /cmn/task/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 1022

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "firstExecutionTime": "2026-01-01T00:00:00.000Z",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  },
  "runAsUserRef": {
    "id": "text"
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  }
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-01-01T00:00:00.000Z",
  "firstExecutionTime": "2026-01-01T00:00:00.000Z",
  "nextExecutionAt": "2026-01-01T00:00:00.000Z",
  "nextExecutionOverride": "2026-01-01T00:00:00.000Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "category": "NORMAL",
  "dataPayloadJson": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  },
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "traceActive": false,
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  }
}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/cmn/task/{id}
DELETE /cmn/task/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Aktiviert das Call-Tracing für diesen Task

put

Bewusst ein eigener Endpunkt, damit das Flag bei einer gewöhnlichen Task-Bearbeitung nicht versehentlich mitwandert.

Path parameters
idinteger · int64Required

an identifier

Responses
200

OK

No content
put/cmn/task/{id}/tracing
PUT /cmn/task/{id}/tracing HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

No content

Deaktiviert das Call-Tracing für diesen Task

delete

Bewusst ein eigener Endpunkt, damit das Flag bei einer gewöhnlichen Task-Bearbeitung nicht versehentlich mitwandert.

Path parameters
idinteger · int64Required

an identifier

Responses
200

OK

No content
delete/cmn/task/{id}/tracing
DELETE /cmn/task/{id}/tracing HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

No content

Create new Resource

post
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · min: 1Required

label of this task

descriptionstringOptional

description of this task

cronExpressionstringRequired

valid cron expression (UNIX style)

lastExecutedAtstring · date-timeRead-onlyOptional

last execution date-time

firstExecutionTimestring · date-timeRequired

first execution date-time

nextExecutionAtstring · date-timeRead-onlyOptional

next execution date-time

nextExecutionOverridestring · date-timeRead-onlyOptional

Wann eine bevorzugte Abarbeitung angefragt wurde

lastStatusstring · enumRead-onlyOptional

lastStatus

Possible values:
jobBeanNamestring · min: 1Required

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:
categorystring · enumRead-onlyOptional

Category

Default: NORMALPossible values:
singletonbooleanOptional

Is this task a singleton

Default: true
repetitionsinteger · int32Optional

How often will this task run? (null -> forever)

processIdstringOptional

process id

traceActivebooleanRead-onlyOptional

Aktiviert Call-Tracing fuer diesen Task

Default: false
Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · min: 1Required

label of this task

descriptionstringOptional

description of this task

cronExpressionstringRequired

valid cron expression (UNIX style)

lastExecutedAtstring · date-timeRead-onlyOptional

last execution date-time

firstExecutionTimestring · date-timeRequired

first execution date-time

nextExecutionAtstring · date-timeRead-onlyOptional

next execution date-time

nextExecutionOverridestring · date-timeRead-onlyOptional

Wann eine bevorzugte Abarbeitung angefragt wurde

lastStatusstring · enumRead-onlyOptional

lastStatus

Possible values:
jobBeanNamestring · min: 1Required

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:
categorystring · enumRead-onlyOptional

Category

Default: NORMALPossible values:
singletonbooleanOptional

Is this task a singleton

Default: true
repetitionsinteger · int32Optional

How often will this task run? (null -> forever)

processIdstringOptional

process id

traceActivebooleanRead-onlyOptional

Aktiviert Call-Tracing fuer diesen Task

Default: false
post/cmn/task
POST /cmn/task HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 1022

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "firstExecutionTime": "2026-01-01T00:00:00.000Z",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  },
  "runAsUserRef": {
    "id": "text"
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  }
}
{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-01-01T00:00:00.000Z",
  "firstExecutionTime": "2026-01-01T00:00:00.000Z",
  "nextExecutionAt": "2026-01-01T00:00:00.000Z",
  "nextExecutionOverride": "2026-01-01T00:00:00.000Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "category": "NORMAL",
  "dataPayloadJson": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  },
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "traceActive": false,
  "custom": {
    "empty": true,
    "array": true,
    "null": true,
    "object": true,
    "float": true,
    "nodeType": "ARRAY",
    "string": true,
    "integralNumber": true,
    "floatingPointNumber": true,
    "missingNode": true,
    "valueNode": true,
    "pojo": true,
    "short": true,
    "int": true,
    "long": true,
    "double": true,
    "bigDecimal": true,
    "bigInteger": true,
    "boolean": true,
    "binary": true,
    "container": true,
    "number": true,
    "embeddedValue": true
  }
}
post
Path parameters
idinteger · int64Required

an identifier

Responses
200

OK

No content
post/cmn/task/{id}/start
POST /cmn/task/{id}/start HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

No content

Cancel a running task

post

Requests cancellation of a currently running task. The running job is aborted cooperatively at its next interaction and ends with status CANCELLED.

Path parameters
idinteger · int64Required

an identifier

Responses
200

OK

No content
post/cmn/task/{id}/cancel
POST /cmn/task/{id}/cancel HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

No content

Plant einen Support-Task als runOnce & now ein

post
Path parameters
identifierstringRequired

an identifier

Body

Search-Dialog

emptybooleanOptional
arraybooleanOptional
nullbooleanOptional
objectbooleanOptional
floatbooleanOptional
nodeTypestring · enumOptionalPossible values:
stringbooleanOptional
integralNumberbooleanOptional
floatingPointNumberbooleanOptional
missingNodebooleanOptional
valueNodebooleanOptional
pojobooleanOptional
shortbooleanOptional
intbooleanOptional
longbooleanOptional
doublebooleanOptional
bigDecimalbooleanOptional
bigIntegerbooleanOptional
textualbooleanOptionalDeprecated
booleanbooleanOptional
binarybooleanOptional
containerbooleanOptional
numberbooleanOptional
embeddedValuebooleanOptional
Responses
200

OK

No content
post/cmn/task/support/{identifier}/run-now
POST /cmn/task/support/{identifier}/run-now HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 363

{
  "empty": true,
  "array": true,
  "null": true,
  "object": true,
  "float": true,
  "nodeType": "ARRAY",
  "string": true,
  "integralNumber": true,
  "floatingPointNumber": true,
  "missingNode": true,
  "valueNode": true,
  "pojo": true,
  "short": true,
  "int": true,
  "long": true,
  "double": true,
  "bigDecimal": true,
  "bigInteger": true,
  "boolean": true,
  "binary": true,
  "container": true,
  "number": true,
  "embeddedValue": true
}
200

OK

No content
get
Path parameters
idinteger · int64Required
logIdinteger · int64Required
Responses
200

OK

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

executionIdstring · uuidRead-onlyOptional

description of this task

dueTimestring · date-timeRead-onlyOptional

start time (geplant)

queueDurationInSecondsinteger · int64Read-onlyOptional

queue zeit

startTimestring · date-timeRead-onlyOptional

start time

endTimestring · date-timeRead-onlyOptional

end time

durationInSecondsinteger · int64Read-onlyOptional

duration

statusstring · enumRead-onlyOptional

result of run

Possible values:
nodeNamestringRead-onlyOptional

node-name

get/cmn/task/{id}/log/{logId}
GET /cmn/task/{id}/log/{logId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "executionId": "123e4567-e89b-12d3-a456-426614174000",
  "dueTime": "2026-01-01T00:00:00.000Z",
  "queueDurationInSeconds": 1,
  "startTime": "2026-01-01T00:00:00.000Z",
  "endTime": "2026-01-01T00:00:00.000Z",
  "durationInSeconds": 1,
  "status": "CREATED",
  "nodeName": "text",
  "logLines": []
}
delete
Path parameters
idinteger · int64Required
logIdinteger · int64Required
Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/cmn/task/{id}/log/{logId}
DELETE /cmn/task/{id}/log/{logId} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "context": "text",
  "messageValue": "text"
}

liefert alle 'supportfähigen' Tasks

get
Responses
200

OK

application/json
identifierstring · min: 1Required

identifier

descriptionstringOptional

description

get/cmn/task/support
GET /cmn/task/support HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[]

liefert die Parameterstruktur für einen Task

get
Path parameters
identifierstringRequired

an identifier

Responses
200

OK

application/json
stringOptional
get/cmn/task/support/{identifier}/parameter-meta
GET /cmn/task/support/{identifier}/parameter-meta HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

text
PreviousTags
NextTax Ewu Delivery Limits

Last updated

Was this helpful?