Loading
Documentation Powered by ReDoc

DFS Task Automation API (latest)

Download OpenAPI specification:Download

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/api/job-task
https://example-host/api/job-task

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/api/background-job
https://example-host/api/background-job

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 38,
  • "key": "BuildFlatTransaction",
  • "jobGroup": "BuildFlat",
  • "retryInterval": 86400,
  • "isActive": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/api/background-job
https://example-host/api/background-job

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "SyncDaily",
  • "jobGroup": "EoDProcess",
  • "cronExpression": "0 0 30 2 *",
  • "retryInterval": 86400
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

items
Array of objects (BulkCreateBackgroundJobRequestItem) Nullable

The list of background jobs

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/api/background-job/bulk
https://example-host/api/background-job/bulk

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/api/background-job/job-task
https://example-host/api/background-job/job-task

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "backgroundJobId": 36,
  • "jobTaskId": 30,
  • "customAttributes": "{\"ExecuteLegalEntitySync\": false }",
  • "maxRunningInstances": 0,
  • "initiatorId": -1
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

items
Array of objects (BulkCreateBackgroundJobJobTaskRequestItem) Nullable

The list of background job-job task relations

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/api/background-job/job-task/bulk
https://example-host/api/background-job/job-task/bulk

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/api/Jobs/{id}
https://example-host/api/Jobs/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/api/Jobs/{id}
https://example-host/api/Jobs/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "18360",
  • "status": "Processing",
  • "data":
    [
    ]
}

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:
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",
  • "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:
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",
  • "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:
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
header Parameters
Accept-Language
string

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

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": "2023-09-15T09:10:07Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

The parameter DTO

batchId
string Nullable

The Batch ID of an existing batch

description
string Nullable

The batch description

items
Array of objects (BulkScheduleJobsRequestItem) Nullable

The batch jobs

canUseDefaultParametersData
boolean Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "batchId": "274bd87f-3e75-4eb7-b72c-c3990800795b",
  • "description": "Funding ReSchedule",
  • "items":
    [
    ],
  • "canUseDefaultParametersData": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "batchId": "9353bfc1-e5bc-448d-82a8-db8b78d8bd9f",
  • "items":
    [
    ]
}