Job Scheduler API (2)

The Job Scheduler API provides a comprehensive interface for managing and scheduling various types of jobs related to data monitoring, storage maintenance, and briefing events within a CDQ services. This API is designed to facilitate the automation of routine tasks, enhance data integrity through validation and duplication jobs, and support the efficient management of storage resources by scheduling deletion of outdated storages.

Servers

Mock server

https://idp.cdq.com/_mock/apis/job-scheduler-api/api-v1/

Production SOAP

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

Production

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

Job Schedules

Contains a set of endpoints created to manage and automate to schedule different types of jobs. These jobs are crucial for maintaining the efficiency and reliability of data within the system. The endpoints in this category enable users to schedule jobs for specific tasks, such as deleting old storage data, validating and duplicating data mirrors, and initiating data monitoring jobs. Each type of job serves a specific purpose, contributing to the overall data management strategy by automating routine maintenance tasks, ensuring data accuracy, and optimizing storage usage.

Operations

Data Monitors

Data monitors are essential tools for ensuring data quality and integrity within the system. They provide real-time monitoring of data sources, alerting users to any discrepancies or anomalies that may arise. The endpoints of the Data Monitors allow users to schedule and run data monitor jobs, enabling them to monitor specific data sources and receive timely notifications of any issues. By leveraging data monitors, users can proactively identify and address data quality issues, ensuring the accuracy and reliability of their data.

Operations

Run Job Data Monitor

Request

Schedule a job for a specific data monitor. By scheduling a data monitor job, users can specify, which data sources to monitor, the criteria for monitoring, and the actions to be taken based on the monitoring results.

Headers

X-Credential-Usernamestring

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

username (e.g. "johndoe")
user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")

Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3

Bodyapplication/jsonrequired

storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"

dataMonitorobject(DataMonitor)required

A monitoring service that can be activated for a Data Storage/Data Mirror.

dataMonitor.idstring(DataMonitorId)required

Unique alpha-numeric number of the Data Monitor.

Example: "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"

dataMonitor.typeobject(DataMonitorType)required

Data monitor type.

dataMonitor.type.technicalKeystring(DataMonitorTypeTechnicalKey)required

Technical key of a data monitor.

Example: "AUGMENTATION"

dataMonitor.clientIdstring(ClientId)

Client ID of the data monitor.

Example: "12345678-1234-5678-1234-567812345678"

dataMonitor.dataSourcesArray of objects(DataMonitorDataSource)required

List of data sources to be monitored.

dataMonitor.dataSources[].idstring(BusinessPartnerStorageDataSourceId)required

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"

dataMonitor.configurationobject(DataMonitorConfiguration)

Configuration for the data monitor.

dataMonitor.featuresOnArray of strings(DataMonitorFeature)

List of features to be monitored.

Example: ["data_monitor_feature"]

countryShortNamesArray of strings(CountryShortNames)

List of country short names.

Example: ["DE"]

modifiedAfterstring(ModifiedAfterBusinessPartners)

Makes the job evaluate business partners which were modified after given date described in ISO-8601 format.

Example: "2023-07-06T12:14:03.204Z"

processingLogTriggerobject(ProcessingLogTrigger)

Processing log trigger.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/job-scheduler-api/api-v1/datamonitors/schedule \
  -H 'Content-Type: application/json' \
  -d '{
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "dataMonitor": {
      "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
      "type": {
        "technicalKey": "AUGMENTATION"
      },
      "clientId": "12345678-1234-5678-1234-567812345678",
      "dataSources": [
        {
          "id": "648824a691d8d2503d65103e"
        }
      ],
      "configuration": {
        "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
      },
      "featuresOn": [
        "data_monitor_feature"
      ]
    },
    "countryShortNames": [
      "DE"
    ],
    "modifiedAfter": "2023-07-06T12:14:03.204Z",
    "processingLogTrigger": {
      "type": "INITIALIZED"
    }
  }'

Responses

Bodyapplication/json

statusstring

Determines whether a job has been started or not.

Possible values:

OK

Example: "OK"

jobobject(DataMonitorJob)

Data monitor job.

Response

application/json

{
  "status": "OK",
  "job": {
    "id": "35f23c03-1c22-45fe-9484-3ffe769325de"
  }
}