Loading
Documentation Powered by ReDoc

DFS Task Automation API (latest)

Download OpenAPI specification:Download

Contains methods to execute/schedule background jobs

Jobs

Modifies a background job that is executed recurringly

Authorizations:
Bearer
Request Body schema:
application/json

The parameter DTO

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

jobId
string Nullable

The unique ID of the Job

cronExpression
string Nullable

The Cron expression that defines the recurring schedule

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Creates a background job that is executed recurringly

Authorizations:
Bearer
Request Body schema:
application/json

The parameter DTO

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

jobId
string Nullable

The unique ID of the Job

cronExpression
string Nullable

The Cron expression that defines the recurring schedule

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Enqueues a background job for immediate execution

Authorizations:
Bearer
Request Body schema:
application/json

The parameter DTO

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "jobId": "string"
}

Schedules a background job for delayed execution

Authorizations:
Bearer
Request Body schema:
application/json

The parameter DTO

jobParameters
object (JobParameters)

The actual parameters passed to a job when executed

delay
object (TimeSpan)
enqueueAt
string <date-time> Nullable

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "jobParameters":
    {
    },
  • "delay": { },
  • "enqueueAt": "2021-06-25T14:01:52Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "jobId": "string"
}