Skip to content

Jobs Management API (2)

The Job Management API allows for the management and execution of asynchronous jobs within CDQ services. This API enables the creation, monitoring, and management of jobs, allowing developers to automate and streamline complex workflows and tasks.

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/

Production SOAP

https://job-management-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v2/

Production

https://job-management-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

Jobs

The Jobs resource represents a job executed asynchronously. Jobs are used to perform long-running tasks that can be monitored and managed through the API. Jobs can be created, updated, and deleted, and their status can be monitored and queried.

Operations

Job Results

The Job Results resource represents the results of a job that has been executed. Job results can be created, updated, and deleted, and their status can be monitored and queried.

Operations

Processing logs

The Job Results resource represents the results of data monitors that has been executed. Processing log results can be created, updated, and deleted, and their status can be monitored and queried.

Operations

List Processing Log Data

Request

Read a page of processing log data by next after approach. The results are stored in the processing log and can be used to carry additional information.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
processingLogIdstring(ProcessingLogIdEnum)required

Unique identifier of the processing log.

Enum ValueDescription
CURATION_LOG

Curation processing log identifier.

VALIDATION_LOG

Validation processing log identifier.

VALIDATION_SHARING_LOG

Validation sharing processing log identifier.

SANCTION_AND_WATCHLISTS_LOG

Sanction and Watchlists monitoring log identifier.

BANK_ACCOUNT_DATA_VERIFICATION_LOG

Bank Account verification processing log identifier.

OVERLAP_LOG

Overlap processing log identifier.

DUPLICATE_LOG

Duplicate processing log identifier.

QUALIFICATION_LOG

Qualification processing log identifier.

Example: CURATION_LOG
Query
businessPartnerIdArray of strings(BusinessPartnerId)<= 100 items

Business Partner IDs, which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)<= 500 items

Unique identifiers of the data sources.

Example: dataSourceIds=648824a691d8d2503d65103e
externalIdArray of strings(BusinessPartnerExternalId)<= 100 items

Business Partner External IDs, which should be filtered.

Example: externalId=The ID managed in the customer's SAP systems.
startAfterstring(StartAfter)

Indicator for the next page.

Example: startAfter=5712566172571652
featuresOffArray of strings(ProcessingLogResultsReadFeatureEnum)

Features to not use during reading the results (INTERNAL ONLY):

  • FETCH_RESULT_DATA - Don’t return result data, only result metadata.
  • NUMBER_OF_TOTAL - Don’t return total.
Items Enum ValueDescription
FETCH_RESULT_DATA

Fetch result data.

NUMBER_OF_TOTAL

Number of totals.

Example: featuresOff=FETCH_RESULT_DATA
includeResultDataFieldsArray of strings(ResultDataField)

List of result data fields to include in the result.

Example: includeResultDataFields=dataDefects
resultStatusstring(ResultDataReadStatusEnum)

The status of the processing log result.

Enum ValueDescription
OK

OK

FAILED

FAILED

Example: resultStatus=OK
limitinteger(int32)

Number of results that should be fetched. Maximum 5000 results can be returned in one page.

Default 100
Example: limit=100
fromstring

ISO 8601 representation of the timestamp when the result data was created.

Example: from=2019-09-07T00:00:00Z
tostring

ISO 8601 representation of the timestamp when the result data was created.

Example: to=2019-09-07T00:00:00Z
currentProcessingStatusstring(ProcessingStatusTechnicalKey)

The current processing status of the processing log result.

Example: currentProcessingStatus=IN_PROGRESS
dataSourceIdstring(BusinessPartnerStorageDataSourceId)Deprecated

Unique identifier of the data source. Remove in https://cdqcom.atlassian.net/browse/CDLD-50932.

Example: dataSourceId=648824a691d8d2503d65103e
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/CURATION_LOG/results

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(int32)

Number of items per page.

Example: "100"
fromstring

ISO 8601 representation of the timestamp when the result data was created.

Example: "2019-09-07T-15:50+00"
tostring

ISO 8601 representation of the timestamp when the result data was created.

Example: "2019-09-07T-15:50+00"
totalinteger(int32)

Total number of processing log data, which can be paged.

Example: "67"
valuesArray of objects(ProcessingLogData)

List of processing log data.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "from": "2019-09-07T-15:50+00",
  "to": "2019-09-07T-15:50+00",
  "total": "67",
  "values": [
    { … }
  ]
}

Count Processing Log Data

Request

Read a page of processing log data by next after approach. The results are stored in the processing log and can be used to carry additional information.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
processingLogIdstring(ProcessingLogIdEnum)required

Unique identifier of the processing log.

Enum ValueDescription
CURATION_LOG

Curation processing log identifier.

VALIDATION_LOG

Validation processing log identifier.

VALIDATION_SHARING_LOG

Validation sharing processing log identifier.

SANCTION_AND_WATCHLISTS_LOG

Sanction and Watchlists monitoring log identifier.

BANK_ACCOUNT_DATA_VERIFICATION_LOG

Bank Account verification processing log identifier.

OVERLAP_LOG

Overlap processing log identifier.

DUPLICATE_LOG

Duplicate processing log identifier.

QUALIFICATION_LOG

Qualification processing log identifier.

Example: CURATION_LOG
Query
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)<= 10 items

Unique identifiers of the data sources.

Example: dataSourceIds=648824a691d8d2503d65103e
currentProcessingStatusstring(ProcessingStatusTechnicalKey)

The current processing status of the processing log result.

Example: currentProcessingStatus=IN_PROGRESS
fromstring

ISO 8601 representation of the timestamp when the result data was created.

Example: from=2019-09-07T00:00:00Z
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/CURATION_LOG/results/total

Responses

OK

Bodyapplication/json
totalinteger(int64)(ProcessingLogDataTotal)

Total number of processing log data, which can be paged.

Example: "67"
Response
application/json
{
  "total": "67"
}

Initialize Job Result Storage

Request

Initialize a new job result storage.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/initialize

Responses

OK

Bodyapplication/json
idstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
Response
application/json
{
  "id": "72d6900fce6b326088f5d9d91049e3e6"
}

Upserts Log Entries ListDeprecated

Request

Upserts a list of log entries. No check for an existing job is done. This endpoint is deprecated in favor of result data queue client repository (UpsertResultDataQueueSender). See https://github.com/cdqag/result-data-queue-client-starters/blob/master/README.md for details.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
processingLogIdstring(ProcessingLogIdEnum)required

Unique identifier of the processing log.

Enum ValueDescription
CURATION_LOG

Curation processing log identifier.

VALIDATION_LOG

Validation processing log identifier.

VALIDATION_SHARING_LOG

Validation sharing processing log identifier.

SANCTION_AND_WATCHLISTS_LOG

Sanction and Watchlists monitoring log identifier.

BANK_ACCOUNT_DATA_VERIFICATION_LOG

Bank Account verification processing log identifier.

OVERLAP_LOG

Overlap processing log identifier.

DUPLICATE_LOG

Duplicate processing log identifier.

QUALIFICATION_LOG

Qualification processing log identifier.

Example: CURATION_LOG
Bodyapplication/jsonrequired

Add processing log entries.

resultsArray of objects(ProcessingLogDataUpsert)<= 1000 items

List of processing log entries.

featuresOnArray of strings(UseQueueFeatureParam)

List of features to be activated.

Items ValueDescription
LAB_USE_QUEUES

Use queues.

Example: ["LAB_USE_QUEUES"]
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/CURATION_LOG/results \
  -H 'Content-Type: application/json' \
  -d '{
    "results": [
      {
        "dataSourceId": "648824a691d8d2503d65103e",
        "businessPartnerId": "63e635235c06b7396330fe40",
        "addressId": "address-id",
        "externalId": "The ID managed in the customer'\''s SAP systems.",
        "addressExternalId": "1",
        "addressVersion": {
          "characterSet": {
            "technicalKey": "INTERNATIONAL"
          },
          "language": {
            "technicalKey": "DE"
          }
        },
        "jobType": "DATA_CURATION_JOB",
        "resultData": "{'\''param1'\'': '\''value1'\''}",
        "status": "OK",
        "message": "Missing storageId.\"",
        "countryShortName": "CH",
        "processingStatus": {
          "technicalKey": "IN_PROGRESS",
          "modifiedAt": "2020-08-31T16:47+00:00"
        },
        "configuration": {
          "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
          "version": 1
        },
        "type": {
          "technicalKey": "technical-key"
        },
        "executedAt": "2019-09-07T00:00:00Z"
      }
    ],
    "featuresOn": [
      "LAB_USE_QUEUES"
    ]
  }'

Responses

OK

Bodyapplication/json
upsertedinteger(int32)

Number of upserted processing log entries.

Example: "1"
failedinteger(in32)

Number of failed processing log entries.

Example: "1"
Response
application/json
{
  "upserted": "1",
  "failed": "1"
}

Deletes Log DataDeprecated

Request

Deletes processing log data. This endpoint is deprecated in favor of result data queue client repository (ResultDataQueueSender#sendTask(DeleteResultDataChunkTask)). See https://github.com/cdqag/result-data-queue-client-starters/blob/master/README.md for details.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
processingLogIdstring(ProcessingLogIdEnum)required

Unique identifier of the processing log.

Enum ValueDescription
CURATION_LOG

Curation processing log identifier.

VALIDATION_LOG

Validation processing log identifier.

VALIDATION_SHARING_LOG

Validation sharing processing log identifier.

SANCTION_AND_WATCHLISTS_LOG

Sanction and Watchlists monitoring log identifier.

BANK_ACCOUNT_DATA_VERIFICATION_LOG

Bank Account verification processing log identifier.

OVERLAP_LOG

Overlap processing log identifier.

DUPLICATE_LOG

Duplicate processing log identifier.

QUALIFICATION_LOG

Qualification processing log identifier.

Example: CURATION_LOG
Bodyapplication/jsonrequired

Processing log data delete request.

idsArray of strings(ProcessingLogDataId)<= 1000 items

IDs of ProcessingLogData.

Example: ["5daef6fe65bafb00012901e6"]
businessPartnerIdsArray of strings(BusinessPartnerId)<= 1000 items

IDs of Business Partners.

Example: ["63e635235c06b7396330fe40"]
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)<= 100 items

IDs of data sources.

Example: ["648824a691d8d2503d65103e"]
featuresOnArray of strings(UseQueueFeatureParam)

List of features to be activated.

Items ValueDescription
LAB_USE_QUEUES

Use queues.

Example: ["LAB_USE_QUEUES"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/CURATION_LOG/results/delete \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "5daef6fe65bafb00012901e6"
    ],
    "businessPartnerIds": [
      "63e635235c06b7396330fe40"
    ],
    "dataSourceIds": [
      "648824a691d8d2503d65103e"
    ],
    "featuresOn": [
      "LAB_USE_QUEUES"
    ]
  }'

Responses

OK

Bodyapplication/json
deletedinteger(int32)

Number of deleted processing log entries.

Example: "1"
failedinteger(in32)

Number of failed processing log entries.

Example: "1"
Response
application/json
{
  "deleted": "1",
  "failed": "1"
}

Delete ContentDeprecated

Request

Delete all the content of the processing log. This endpoint is deprecated in favor of result data queue client repository (ResultDataQueueSender#sendTask(DeleteResultDataChunkTask)). See https://github.com/cdqag/result-data-queue-client-starters/blob/master/README.md for details.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

Example: 72d6900fce6b326088f5d9d91049e3e6
processingLogIdstring(ProcessingLogIdEnum)required

Unique identifier of the processing log.

Enum ValueDescription
CURATION_LOG

Curation processing log identifier.

VALIDATION_LOG

Validation processing log identifier.

VALIDATION_SHARING_LOG

Validation sharing processing log identifier.

SANCTION_AND_WATCHLISTS_LOG

Sanction and Watchlists monitoring log identifier.

BANK_ACCOUNT_DATA_VERIFICATION_LOG

Bank Account verification processing log identifier.

OVERLAP_LOG

Overlap processing log identifier.

DUPLICATE_LOG

Duplicate processing log identifier.

QUALIFICATION_LOG

Qualification processing log identifier.

Example: CURATION_LOG
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/processinglogs/72d6900fce6b326088f5d9d91049e3e6/CURATION_LOG/results/clear

Responses

OK

Bodyapplication/json
deletedinteger(int32)

Number of deleted processing log entries.

Example: "1"
failedinteger(in32)

Number of failed processing log entries.

Example: "1"
Response
application/json
{
  "deleted": "1",
  "failed": "1"
}

Scheduled Jobs

Operations