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

Payload

Content type

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": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

Payload

Content type

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

Payload

Content type

Copy

Expand all Collapse all


{"items": 
[
{"key": "SyncDaily",
"jobGroup": "EoDProcess",
"cronExpression": "0 0 30 2 *",
"retryInterval": 86400
},
{"key": "ProcessFunding",
"jobGroup": "Dfs",
"retryInterval": 0
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"backgroundJobId": 3,
"backgroundJobKey": "SyncDaily"
},
{"backgroundJobId": 31,
"backgroundJobKey": "ProcessFunding"
}
]
}

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

Payload

Content type

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

Payload

Content type

Copy

Expand all Collapse all


{"items": 
[
{"backgroundJobId": 36,
"jobTaskId": 30,
"customAttributes": "{\"ExecuteLegalEntitySync\": false }",
"maxRunningInstances": 0,
"initiatorId": -1
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"backgroundJobId": 36,
"jobTaskId": 30
}
]
}

Jobs

Deletes the job by its id

Authorizations:

Bearer

path Parameters

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": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Gets the job details by its id

Authorizations:

Bearer

path Parameters

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": 
[
{"backgroundJobId": 39,
"name": "ProcessFunding-133",
"canUseDefaultParametersData": true
}
],
"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:
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

Payload

Content type

Copy

Expand all Collapse all


{"jobParameters": 
{"backgroundJobId": 0,
"backgroundJobKey": "string",
"name": "string",
"data": "string",
"canUseDefaultParametersData": true
},
"jobId": "string",
"cronExpression": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

Payload

Content type

Copy

Expand all Collapse all


{"jobParameters": 
{"backgroundJobId": 0,
"backgroundJobKey": "string",
"name": "string",
"data": "string",
"canUseDefaultParametersData": true
},
"jobId": "string",
"cronExpression": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

Payload

Content type

Copy

Expand all Collapse all


{"jobParameters": 
{"backgroundJobId": 0,
"backgroundJobKey": "string",
"name": "string",
"data": "string",
"canUseDefaultParametersData": true
}
}

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

Payload

Content type

Copy

Expand all Collapse all


{"jobParameters": 
{"backgroundJobId": 0,
"backgroundJobKey": "string",
"name": "string",
"data": "string",
"canUseDefaultParametersData": true
},
"delay": 
{"ticks": 0
},
"enqueueAt": "2024-04-10T13:50:47Z"
}

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

Payload

Content type

Copy

Expand all Collapse all


{"batchId": "4d04ed2f-2a35-4969-8151-eac668897010",
"description": "Funding ReSchedule",
"items": 
[
{"name": "Process Funding (Funding ID: 141, BackgroundJobId: 41, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-141",
"enqueueAt": "2024-04-11T13:44:05.2350225+00:00"
},
{"name": "Process Funding (Funding ID: 145, BackgroundJobId: 42, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-145",
"enqueueAt": "2024-04-11T14:06:05.2366804+00:00"
},
{"name": "Process Funding (Funding ID: 137, BackgroundJobId: 37, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-137",
"enqueueAt": "2024-04-11T16:44:05.2849406+00:00"
}
],
"canUseDefaultParametersData": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"batchId": "50a5629c-33c7-4e12-8a8d-e9070aa4c2f3",
"items": 
[
{"jobId": "28359",
"name": "Process Funding (Funding ID: 141, BackgroundJobId: 41, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-141"
},
{"jobId": "28229",
"name": "Process Funding (Funding ID: 145, BackgroundJobId: 42, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-145"
},
{"jobId": "28366",
"name": "Process Funding (Funding ID: 137, BackgroundJobId: 37, JobTaskId: 31)",
"jobTaskKey": "ProcessFunding",
"backgroundJobKey": "ProcessFunding-137"
}
]
}

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:
application/json

The parameter DTO

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/api/Jobs/search

https://example-host/api/Jobs/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"ids": 
[0
],
"statuses": 
["string"
],
"createDateFrom": "2024-04-10T13:50:47Z",
"createDateTo": "2024-04-10T13:50:47Z",
"expiryDateFrom": "2024-04-10T13:50:47Z",
"expiryDateTo": "2024-04-10T13:50:47Z",
"data": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"status": "string",
"data": null,
"createDate": "2024-04-10T13:50:47Z",
"expiryDate": "2024-04-10T13:50:47Z"
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

DFS Task Automation API (latest)

JobManagement

Gets a job task by key

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Modifies a background job information

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Creates a background job

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Bulk create of the background jobs

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Creates a background job-job task relations

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Bulk create of the background job-job task relations

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Jobs

Deletes the job by its id

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Gets the job details by its id

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Modifies a background job that is executed recurringly

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Creates a background job that is executed recurringly

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enqueues a background job for immediate execution

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Schedules a background job for delayed execution

Authorizations:

header Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json