Loading
API docs by Redocly

DFS Task Automation API (latest)

Download OpenAPI specification:

Contains methods to execute/schedule background jobs

JobManagement

Gets a job task by key

Authorizations:
Bearer
query Parameters
key
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 32,
  • "name": "Process Funding",
  • "webHookUrl": "/api/tasks/process-funding/execute",
  • "jobTaskUId": "2856f34d-e020-4832-863a-6e344997e06d"
}

Modifies a background job information

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

id
integer <int32>
key
string or null
jobGroup
string (JobGroup)
Enum: "Dfs" "BuildFlat" "EoDProcess"
cronExpression
string or null
retryInterval
integer <int32>
isActive
boolean

Responses

Request samples

Content type
{
  • "id": 38,
  • "key": "BuildFlatTransaction",
  • "jobGroup": "BuildFlat",
  • "retryInterval": 86400,
  • "isActive": false
}

Response samples

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

Creates a background job

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

key
string or null
jobGroup
string (JobGroup)
Enum: "Dfs" "BuildFlat" "EoDProcess"
cronExpression
string or null
retryInterval
integer <int32>

Responses

Request samples

Content type
{
  • "key": "SyncDaily",
  • "jobGroup": "EoDProcess",
  • "cronExpression": "0 0 30 2 *",
  • "retryInterval": 86400
}

Response samples

Content type
application/json
{
  • "backgroundJobId": 3,
  • "backgroundJobKey": "SyncDaily"
}

Bulk create of the background jobs

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

Array of objects or null (BulkCreateBackgroundJobRequestItem)

The list of background jobs

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a background job-job task relations

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

backgroundJobId
integer <int32>
jobTaskId
integer <int32>
executionOrder
integer or null <int32>
renderTemplateMetadataId
integer or null <int32>
customAttributes
string or null
defaultParametersData
string or null
maxRunningInstances
integer <int32>
initiatorId
integer <int32>

Responses

Request samples

Content type
{
  • "backgroundJobId": 36,
  • "jobTaskId": 30,
  • "customAttributes": "{\"ExecuteLegalEntitySync\": false }",
  • "maxRunningInstances": 0,
  • "initiatorId": -1
}

Response samples

Content type
application/json
{
  • "backgroundJobId": 36,
  • "jobTaskId": 30
}

Bulk create of the background job-job task relations

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

Array of objects or null (BulkCreateBackgroundJobJobTaskRequestItem)

The list of background job-job task relations

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Jobs

Deletes the job by its id

Authorizations:
Bearer
path Parameters
id
required
string

The internal id of the job

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

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

Gets the job details by its id

Authorizations:
Bearer
path Parameters
id
required
string

The internal id of the job

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": "18360",
  • "status": "Processing",
  • "data": [
    ],
  • "createDate": "0001-01-01T00:00:00"
}

Modifies a background job that is executed recurringly

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

object (JobParameters)

The actual parameters passed to a job when executed

jobId
string or null

The unique ID of the Job

cronExpression
string or null

The Cron expression that defines the recurring schedule

Responses

Request samples

Content type
{
  • "jobParameters": {
    },
  • "jobId": "string",
  • "cronExpression": "string"
}

Response samples

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

Creates a background job that is executed recurringly

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

object (JobParameters)

The actual parameters passed to a job when executed

jobId
string or null

The unique ID of the Job

cronExpression
string or null

The Cron expression that defines the recurring schedule

Responses

Request samples

Content type
{
  • "jobParameters": {
    },
  • "jobId": "string",
  • "cronExpression": "string"
}

Response samples

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

Enqueues a background job for immediate execution

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

object (JobParameters)

The actual parameters passed to a job when executed

Responses

Request samples

Content type
{
  • "jobParameters": {
    }
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Schedules a background job for delayed execution

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

object (JobParameters)

The actual parameters passed to a job when executed

delay
string or null <date-span>

The timespan to delay until the job gets executed

enqueueAt
string or null <date-time>

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

Responses

Request samples

Content type
{
  • "jobParameters": {
    },
  • "delay": "string",
  • "enqueueAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Bulk schedule of background jobs for delayed execution

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

batchId
string or null

The Batch ID of an existing batch

description
string or null

The batch description

Array of objects or null (BulkScheduleJobsRequestItem)

The batch jobs

canUseDefaultParametersData
boolean or null

Responses

Request samples

Content type
{
  • "batchId": "d4ce0121-04ef-426c-9086-239ace6a9599",
  • "description": "Funding ReSchedule",
  • "items": [
    ],
  • "canUseDefaultParametersData": true
}

Response samples

Content type
application/json
{
  • "batchId": "39c831ce-9731-461b-8bb9-a4339cc51260",
  • "items": [
    ]
}

Search jobs

Searches for jobs and returns a list with jobs (and key attributes) matching the passed request parameters.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO

page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
ids
Array of integers or null <int64> [ items <int64 > ]
statuses
Array of strings or null
createDateFrom
string or null <date-time>
createDateTo
string or null <date-time>
expiryDateFrom
string or null <date-time>
expiryDateTo
string or null <date-time>
data
string or null

Responses

Request samples

Content type
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "ids": [
    ],
  • "statuses": [
    ],
  • "createDateFrom": "2019-08-24T14:15:22Z",
  • "createDateTo": "2019-08-24T14:15:22Z",
  • "expiryDateFrom": "2019-08-24T14:15:22Z",
  • "expiryDateTo": "2019-08-24T14:15:22Z",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}