Loading
Documentation Powered by ReDoc

additiv Task Automation (v1)

Download OpenAPI specification:Download

Contains methods to execute/schedule background jobs

DispatchJobTask

DispatchedJobTaskResult

path Parameters
contextId
required
string
header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:
application/json-patch+json
isHeartbeat
boolean
isSuccessful
boolean
resultCode
integer <int32>
message
string

Responses

200

Success

post/DispatchJobTask/DispatchedJobTaskResult/{contextId}
https://example-host/DispatchJobTask/DispatchedJobTaskResult/{contextId}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "isHeartbeat": true,
  • "isSuccessful": true,
  • "resultCode": 0,
  • "message": "string"
}

Jobs

Enqueues a background job for immediate execution

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:
application/json-patch+json

The parameter DTO

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

Responses

200

Success

422

Incorrect/missing parameters

post/api/Jobs/enqueue
https://example-host/api/Jobs/enqueue

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "jobParameters":
    {
    }
}

Response samples

Content type
text/plain
No sample

Schedules a background job for delayed execution

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:
application/json-patch+json

The parameter DTO

delay
string

The timespan to delay until the job gets executed

enqueueAt
string <date-time>

The specific time when the job should get executed. Given in UTC.

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

Responses

200

Success

422

Incorrect/missing parameters

post/api/Jobs/schedule
https://example-host/api/Jobs/schedule

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "delay": "string",
  • "enqueueAt": "2020-11-23T16:28:42Z",
  • "jobParameters":
    {
    }
}

Response samples

Content type
text/plain
No sample

Creates a background job that is executed recurringly

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:
application/json-patch+json

The parameter DTO

jobId
string

The unique ID of the Job

cronExpression
string

The Cron expression that defines the recurring schedule

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

Responses

200

Success

422

Incorrect/missing parameters

post/api/Jobs/recurring
https://example-host/api/Jobs/recurring

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "jobId": "string",
  • "cronExpression": "string",
  • "jobParameters":
    {
    }
}

Response samples

Content type
text/plain
No sample

Modifies a background job that is executed recurringly

header Parameters
Authorization
required
string

The BasicAuth token

Request Body schema:
application/json-patch+json

The parameter DTO

jobId
string

The unique ID of the Job

cronExpression
string

The Cron expression that defines the recurring schedule

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

Responses

200

Success

422

Incorrect/missing parameters

patch/api/Jobs/recurring
https://example-host/api/Jobs/recurring

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "jobId": "string",
  • "cronExpression": "string",
  • "jobParameters":
    {
    }
}