Task

Task for Batch Processing

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/cmn/task/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/task/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:34:47.464Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:34:47.464Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-02-10T16:34:47.464Z",
  "firstExecutionTime": "2026-02-10T16:34:47.464Z",
  "nextExecutionAt": "2026-02-10T16:34:47.464Z",
  "nextExecutionOverride": "2026-02-10T16:34:47.464Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {},
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {}
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

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:

jobBeanNamestringRequired

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:

dataPayloadJsonobjectOptional

Search-Dialog

singletonbooleanOptional

Is this task a singleton

Default: true

repetitionsinteger · int32Optional

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

processIdstringOptional

process id

customobjectOptional

Search-Dialog

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/task/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/task/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "firstExecutionTime": "2026-02-10T16:34:47.464Z",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {},
  "runAsUserRef": {
    "id": "text"
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {}
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:34:47.464Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:34:47.464Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-02-10T16:34:47.464Z",
  "firstExecutionTime": "2026-02-10T16:34:47.464Z",
  "nextExecutionAt": "2026-02-10T16:34:47.464Z",
  "nextExecutionOverride": "2026-02-10T16:34:47.464Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {},
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {}
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/cmn/task/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/task/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

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

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

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:

jobBeanNamestringRequired

bean-name/class-name to execute

statestring · enumOptional

Status

Default: ACTIVEPossible values:

dataPayloadJsonobjectOptional

Search-Dialog

singletonbooleanOptional

Is this task a singleton

Default: true

repetitionsinteger · int32Optional

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

processIdstringOptional

process id

customobjectOptional

Search-Dialog

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/cmn/task

HTTPcURLJavaScriptPython

POST /api/cmn/task HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "firstExecutionTime": "2026-02-10T16:34:47.464Z",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {},
  "runAsUserRef": {
    "id": "text"
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {}
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:34:47.464Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:34:47.464Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "cronExpression": "text",
  "lastExecutedAt": "2026-02-10T16:34:47.464Z",
  "firstExecutionTime": "2026-02-10T16:34:47.464Z",
  "nextExecutionAt": "2026-02-10T16:34:47.464Z",
  "nextExecutionOverride": "2026-02-10T16:34:47.464Z",
  "lastStatus": "CREATED",
  "jobBeanName": "text",
  "state": "ACTIVE",
  "dataPayloadJson": {},
  "runAsUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "singleton": true,
  "repetitions": 1,
  "processId": "text",
  "custom": {}
}

post

Path parameters

idinteger · int64Required

an identifier

Responses

200

OK

No content

post

/cmn/task/{id}/start

HTTPcURLJavaScriptPython

POST /api/cmn/task/{id}/start HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

Plant einen Support-Task als runOnce & now ein

post

Path parameters

identifierstringRequired

an identifier

Body

application/json

stringOptional

Responses

200

OK

No content

post

/cmn/task/support/{identifier}/run-now

HTTPcURLJavaScriptPython

POST /api/cmn/task/support/{identifier}/run-now HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

200

OK

No content

get

Path parameters

idinteger · int64Required

logIdinteger · int64Required

Responses

200

OK

application/json

get

/cmn/task/{id}/log/{logId}

HTTPcURLJavaScriptPython

GET /api/cmn/task/{id}/log/{logId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:34:47.464Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:34:47.464Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "executionId": "123e4567-e89b-12d3-a456-426614174000",
  "dueTime": "2026-02-10T16:34:47.464Z",
  "queueDurationInSeconds": 1,
  "startTime": "2026-02-10T16:34:47.464Z",
  "endTime": "2026-02-10T16:34:47.464Z",
  "durationInSeconds": 1,
  "status": "CREATED",
  "nodeName": "text",
  "logLines": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T16:34:47.464Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T16:34:47.464Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "logTime": "2026-02-10T16:34:47.464Z",
      "origin": "DEBUG",
      "message": {
        "messageCode": "text",
        "messageParameters": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "formattedMessage": "text"
      }
    }
  ]
}

delete

Path parameters

idinteger · int64Required

logIdinteger · int64Required

Responses

200

OK

application/json

delete

/cmn/task/{id}/log/{logId}

HTTPcURLJavaScriptPython

DELETE /api/cmn/task/{id}/log/{logId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

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

liefert alle 'supportfähigen' Tasks

get

Responses

200

OK

application/json

get

/cmn/task/support

HTTPcURLJavaScriptPython

GET /api/cmn/task/support HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "identifier": "text",
    "description": "text"
  }
]

liefert die Parameterstruktur für einen Task

get

Path parameters

identifierstringRequired

an identifier

Responses

200

OK

application/json

Responsestring

get

/cmn/task/support/{identifier}/parameter-meta

HTTPcURLJavaScriptPython

GET /api/cmn/task/support/{identifier}/parameter-meta HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

text