Download OpenAPI specification:Download
Contains methods to execute/schedule background jobs
key | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "id": 32,
- "name": "Process Funding",
- "webHookUrl": "/api/tasks/process-funding/execute",
- "jobTaskUId": "2856f34d-e020-4832-863a-6e344997e06d"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
id | integer <int32> |
key | string Nullable |
jobGroup | string (JobGroup) Enum: "Dfs" "BuildFlat" "EoDProcess" |
cronExpression | string Nullable |
retryInterval | integer <int32> |
isActive | boolean |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "id": 38,
- "key": "BuildFlatTransaction",
- "jobGroup": "BuildFlat",
- "retryInterval": 86400,
- "isActive": false
}
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
key | string Nullable |
jobGroup | string (JobGroup) Enum: "Dfs" "BuildFlat" "EoDProcess" |
cronExpression | string Nullable |
retryInterval | integer <int32> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "key": "SyncDaily",
- "jobGroup": "EoDProcess",
- "cronExpression": "0 0 30 2 *",
- "retryInterval": 86400
}
{- "backgroundJobId": 3,
- "backgroundJobKey": "SyncDaily"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
items | Array of objects (BulkCreateBackgroundJobRequestItem) Nullable The list of background jobs |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "items": [
- {
- "key": "SyncDaily",
- "jobGroup": "EoDProcess",
- "cronExpression": "0 0 30 2 *",
- "retryInterval": 86400
}, - {
- "key": "ProcessFunding",
- "jobGroup": "Dfs",
- "retryInterval": 0
}
]
}
{- "items": [
- {
- "backgroundJobId": 3,
- "backgroundJobKey": "SyncDaily"
}, - {
- "backgroundJobId": 31,
- "backgroundJobKey": "ProcessFunding"
}
]
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
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> |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "backgroundJobId": 36,
- "jobTaskId": 30,
- "customAttributes": "{\"ExecuteLegalEntitySync\": false }",
- "maxRunningInstances": 0,
- "initiatorId": -1
}
{- "backgroundJobId": 36,
- "jobTaskId": 30
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
items | Array of objects (BulkCreateBackgroundJobJobTaskRequestItem) Nullable The list of background job-job task relations |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "items": [
- {
- "backgroundJobId": 36,
- "jobTaskId": 30,
- "customAttributes": "{\"ExecuteLegalEntitySync\": false }",
- "maxRunningInstances": 0,
- "initiatorId": -1
}
]
}
{- "items": [
- {
- "backgroundJobId": 36,
- "jobTaskId": 30
}
]
}
id required | string The internal id of the job |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
id required | string The internal id of the job |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "id": "18360",
- "status": "Processing",
- "data": [
- {
- "backgroundJobId": 39,
- "name": "ProcessFunding-133",
- "canUseDefaultParametersData": true
}
]
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "backgroundJobKey": "string",
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "jobId": "string",
- "cronExpression": "string"
}
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "backgroundJobKey": "string",
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "jobId": "string",
- "cronExpression": "string"
}
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "backgroundJobKey": "string",
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}
{- "jobId": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
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. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "backgroundJobKey": "string",
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "delay": {
- "ticks": 0
}, - "enqueueAt": "2023-09-15T09:10:07Z"
}
{- "jobId": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "batchId": "274bd87f-3e75-4eb7-b72c-c3990800795b",
- "description": "Funding ReSchedule",
- "items": [
- {
- "name": "Process Funding (Funding ID: 141, BackgroundJobId: 41, JobTaskId: 31)",
- "jobTaskKey": "ProcessFunding",
- "backgroundJobKey": "ProcessFunding-141",
- "enqueueAt": "2023-09-16T07:10:01.3561306+00:00"
}, - {
- "name": "Process Funding (Funding ID: 145, BackgroundJobId: 42, JobTaskId: 31)",
- "jobTaskKey": "ProcessFunding",
- "backgroundJobKey": "ProcessFunding-145",
- "enqueueAt": "2023-09-16T07:32:01.356147+00:00"
}, - {
- "name": "Process Funding (Funding ID: 137, BackgroundJobId: 37, JobTaskId: 31)",
- "jobTaskKey": "ProcessFunding",
- "backgroundJobKey": "ProcessFunding-137",
- "enqueueAt": "2023-09-16T10:10:01.3561576+00:00"
}
], - "canUseDefaultParametersData": true
}
{- "batchId": "9353bfc1-e5bc-448d-82a8-db8b78d8bd9f",
- "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"
}
]
}