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

List Job Run Results

Request

Read a page of job run results. The results are stored in the job and can be used to carry additional information.

Path
jobIdstring(JobId)required

Unique identifier of the job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Query
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: storageId=72d6900fce6b326088f5d9d91049e3e6
businessPartnerIdArray of strings(BusinessPartnerId)<= 500 items

Business Partner IDs, which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

ID of a data source.

Example: dataSourceId=648824a691d8d2503d65103e
externalIdArray of strings(BusinessPartnerExternalId)<= 500 items

Business Partner External IDs, which should be filtered.

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

Only records with an ID greater than this ID will be fetched.

Example: startAfter=5712566172571652
featuresOnArray of strings(JobResultsReadFeatureEnum)

Features to be used during reading the results (INTERNAL ONLY):

  • USE_NEXT_START_AFTER - consumes encrypted nextStartAfter from the page result. Required as startAfter is already used as pure id.
Items ValueDescription
USE_NEXT_START_AFTER

Use next start after.

Example: featuresOn=USE_NEXT_START_AFTER
jobResultStatusstring(ResultDataReadStatusEnum)

The status of the job results.

Enum ValueDescription
OK

OK

FAILED

FAILED

Example: jobResultStatus=OK
limitinteger(int32)

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

Default 500
Example: limit=500
includeResultDataFieldsArray of strings(ResultDataField)

List of result data fields to include in the result.

Example: includeResultDataFields=dataDefects
curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/jobs-management-api/api-v2/jobs/35f23c03-1c22-45fe-9484-3ffe769325de/results?storageId=72d6900fce6b326088f5d9d91049e3e6'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring

Available only when you used USE_NEXT_START_AFTER feature. Provides encrypted value to be used as a startAfter in next page request

Example: "5712566172571652"
limitinteger(int32)

Number of items per page.

Example: "100"
totalinteger(int32)

Total number of items, which can be paged.

Example: "67"
valuesArray of objects(JobResultData)

List of job result data.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ]
}

Delete Job Results

Request

Delete job results of a storage.

Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the storage as a path parameter.

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

Responses

OK

Insert Job ResultsDeprecated

Request

Add job results for an existing job run. This endpoint is deprecated in favor of result data queue client repository (InsertResultDataQueueSender). See https://github.com/cdqag/result-data-queue-client-starters/blob/master/README.md for details.

Path
jobIdstring(JobId)required

Unique identifier of the job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Query
storageIdstring(BusinessPartnerStorageId)required

ID of the storage or data mirror for which job results should be created.

Example: storageId=72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired

Add job results for an existing job run.

resultsArray of objects(JobResultDataUpsert)<= 1000 items

List of job results.

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/jobs/35f23c03-1c22-45fe-9484-3ffe769325de/results?storageId=72d6900fce6b326088f5d9d91049e3e6' \
  -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
        },
        "jobId": "35f23c03-1c22-45fe-9484-3ffe769325de"
      }
    ],
    "featuresOn": [
      "LAB_USE_QUEUES"
    ]
  }'

Responses

OK

Bodyapplication/json
createdinteger(int32)

Number of created job results.

Example: "1"
updatedinteger(int32)

Number of updated job results.

Example: "1"
failedinteger(in32)

Number of failed job results.

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

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

Scheduled Jobs

Operations