Delete Job

Job

Operations for creating and querying reporting jobs.

Operations

List Jobs

Request

Security

APIKeyHeader or authorization

Query

reportTypestring(Reporttype)

storageIdstring(Storageid)

pageinteger(Page)

Default 0

pageSizeinteger(Pagesize)> 0

Default 100

curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/list?reportType=string&storageId=string&page=0&pageSize=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

pageinteger(Page)required

The number of requested page. Starts from 0.

Example: 0

pageSizeinteger(Pagesize)required

The number or items to include in a single page. If the resulting number of items will be lower than the input, page size will show the number of returned items.

Example: 17

totalinteger(Total)required

Describes the number of all jobs available for the user.

Example: 150

valuesArray of objects(Values)required

values[].jobIdstring(Jobid)required

Example: "c045414ed53943e19794ce6353c0459a"

values[].statusobject(JobStatus)required

values[].status.codeinteger(Code)required

values[].status.technicalKeystring(Technicalkey)required

values[].status.detailsArray of objects(Details)required

values[].status.details[].idinteger(Id)required

values[].status.details[].technicalKeystring(Technicalkey)required

values[].status.details[].messagestring(Message)required

values[].configJobConfig (object)required

JobConfig (object)

values[].startedAtstring(Startedat)

Example: "2023-10-11T10:49:00.201006+00:00"

values[].finishedAtstring(Finishedat)

Example: "2023-10-11T10:49:20.548907+00:00"

values[].expiresAtstring(Expiresat)read-onlyrequired

Returns the job expiration date based on its configured ttl. If None is returned, it means the job does not have a ttl set and does not expire.

Response

application/json

{
  "page": 0,
  "pageSize": 17,
  "total": 150,
  "values": [
    { … }
  ]
}

Create Standard Report

Request

Submits a standard reporting job for execution.

Security

APIKeyHeader or authorization

Bodyapplication/jsonrequired

mirrorIdstring(Mirrorid)

Example: "48fe040682813e8e8873ca1bfec05b21"

artifactIdArtifactIdEnum (string)required

Id of the report or chart

Example: "data_defects_report"

ArtifactIdEnum (string)

Id of the report or chart

titlestring(Title)required

Report or chart title to be used when preparing the result file

Example: "Data Defects Report"

columnsJobConfigColumns (string)(Columns)required

Columns to be included in the report. User can pass all, required or a coma delimited column names to be included on top of required columns

Example: "all"

JobConfigColumns (string)(Columns)

Columns to be included in the report. User can pass all, required or a coma delimited column names to be included on top of required columns

formatJobConfigFileFormat (string)

The target file format of the requested report artifact

Example: "xlsx"

JobConfigFileFormat (string)

The target file format of the requested report artifact

filtersFilters (object)(Filters)

Key value mapping representing filter conditions that will be applied during data extraction.

Filters (object)(Filters)

Key value mapping representing filter conditions that will be applied during data extraction.

includeRecordsWithNoInsightsboolean(Includerecordswithnoinsights)

Flag controlling whether the report should include business partner records that have no insights data. Applicable only to complex reports using business partner and insights collections to combine the underlying view.

Default false

Example: true

dnbStorageTypeDnbStorageTypes (string)

The type of DnB storage dnb_dump_report should be generated for. Applied only if artifactId body param is set to dnb_dump_report.

DnbStorageTypes (string)

The type of DnB storage dnb_dump_report should be generated for. Applied only if artifactId body param is set to dnb_dump_report.

storageIdstring(Storageid)

Id of the storage. If provided, it will override the mirror_id parameter value.

Example: "48fe040682813e8e8873ca1bfec05b21"

validationJobIdstring(Validationjobid)

Alternative job ID to use with data quality reports. If not provided, VALIDATION_LOG is used as fallback.

dataTransformationDefinitionIdstring(Datatransformationdefinitionid)

Id of the data transformation definition to be used when generating Content Pack Report.

Default "SAP.ODM"

includeDatasetsboolean(Includedatasets)

Controls whether datasets should be included in the job response attachments attribute

Default false

ttlJobTTL (string)

Job time to live value

JobTTL (string)

Job time to live value

featuresOnArray of strings(Featureson)

Extra features to be applied during report generation

Items Enum"SHOW_MATCHING_EXPLANATION""SHOW_RETRACTED_LINKS""SHOW_COVER_PAGE""SHOW_ADDITIONAL_ATTRIBUTES"

quickFiltersArray of strings(Quickfilters)

Quick filters to be applied during report generation

Items Enum"OPEN_CASES_ONLY""ONLY_WITH_DECISIONS""ONLY_WITH_CONFIRMED_CASES""ONLY_WITH_CLEARED_CASES"

additionalAttributesArray of objects(Additionalattributes)

List of additional columns to be included on the report where each attribute instructs the backend how to display and source given column from the data mirror using provided name and path

Example: [{"name":"Business Partner City (Record)","path":"record.city"},{"name":"Business Partner Name (CDQ Model)","path":"businessPartner.names[0].value"}]

countriesArray of strings(Countries)Deprecated

Country filter to be applied during data extraction

Example: ["PL"]

dataSourceIdsArray of strings(Datasourceids)Deprecated

Data source filter to be applied during data extraction

Example: ["c045414ed53943e19794ce6353c0459a"]

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mirrorId": "48fe040682813e8e8873ca1bfec05b21",
    "artifactId": "data_defects_report",
    "title": "Data Defects Report",
    "columns": "all",
    "countries": [
      "PL"
    ],
    "dataSourceIds": [
      "c045414ed53943e19794ce6353c0459a"
    ],
    "format": "xlsx",
    "filters": {
      "countries": [
        "PL",
        "DE"
      ],
      "dataSources": [
        "c045414ed53943e19794ce6353c0459a"
      ],
      "duplicateMatchingDataMonitorIds": [
        "6842de1a29c164433a09cd1c"
      ],
      "violations": [
        "ERROR"
      ],
      "provenanceNames": [
        "VIES"
      ],
      "provenanceNamesSubscriptions": [
        "VIES"
      ],
      "provenanceNamesHcpHco": [
        "CH_MEDREG"
      ],
      "changeTypes": [
        "ADDED"
      ],
      "updatesSummaryClassifications": [
        "MAJOR"
      ],
      "updatesSummaryClassificationsCurationV3": [
        "MAJOR"
      ],
      "changeClassifications": [
        "MAJOR"
      ],
      "createdAtRange": [
        "2024-01-01",
        "2024-01-31"
      ],
      "amlCaseListTypes": [
        "WL",
        "PEP"
      ]
    },
    "includeRecordsWithNoInsights": true,
    "dnbStorageType": "DNB",
    "storageId": "48fe040682813e8e8873ca1bfec05b21",
    "validationJobId": "string",
    "dataTransformationDefinitionId": "SAP.ODM",
    "includeDatasets": false,
    "ttl": "1d",
    "featuresOn": [
      "SHOW_MATCHING_EXPLANATION"
    ],
    "quickFilters": [
      "OPEN_CASES_ONLY"
    ],
    "additionalAttributes": [
      {
        "name": "Business Partner City (Record)",
        "path": "record.city"
      },
      {
        "name": "Business Partner Name (CDQ Model)",
        "path": "businessPartner.names[0].value"
      }
    ]
  }'

Responses

Successful Response

Bodyapplication/json

jobIdstring(Jobid)required

Example: "c045414ed53943e19794ce6353c0459a"

statusobject(JobStatus)required

status.codeinteger(Code)required

status.technicalKeystring(Technicalkey)required

status.detailsArray of objects(Details)required

status.details[].idinteger(Id)required

status.details[].technicalKeystring(Technicalkey)required

status.details[].messagestring(Message)required

configJobConfig (object)required

JobConfig (object)

startedAtstring(Startedat)

Example: "2023-10-11T10:49:00.201006+00:00"

finishedAtstring(Finishedat)

Example: "2023-10-11T10:49:20.548907+00:00"

expiresAtstring(Expiresat)read-onlyrequired

Returns the job expiration date based on its configured ttl. If None is returned, it means the job does not have a ttl set and does not expire.

Response

application/json

{
  "jobId": "c045414ed53943e19794ce6353c0459a",
  "status": {
    "code": 0,
    "technicalKey": "string",
    "details": [ … ]
  },
  "config": {
    "mirrorId": "48fe040682813e8e8873ca1bfec05b21",
    "artifactId": "data_defects_report",
    "title": "Data Defects Report",
    "columns": "all",
    "countries": [ … ],
    "dataSourceIds": [ … ],
    "format": "xlsx",
    "filters": { … },
    "includeRecordsWithNoInsights": true,
    "dnbStorageType": "DNB",
    "storageId": "48fe040682813e8e8873ca1bfec05b21",
    "validationJobId": "string",
    "dataTransformationDefinitionId": "SAP.ODM",
    "includeDatasets": false,
    "ttl": "1d",
    "featuresOn": [ … ],
    "quickFilters": [ … ],
    "additionalAttributes": [ … ]
  },
  "startedAt": "2023-10-11T10:49:00.201006+00:00",
  "finishedAt": "2023-10-11T10:49:20.548907+00:00",
  "expiresAt": "string"
}

Create Content Pack Report

Request

Triggers reporting job generating Content Pack Report.

Security

APIKeyHeader or authorization

Bodyapplication/jsonrequired

titlestring(Title)

Default "Content Pack Report"

dataTransformationDefinitionIdstring(Datatransformationdefinitionid)

Default "SAP.ODM"

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/contentPackReport/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "title": "Content Pack Report",
    "dataTransformationDefinitionId": "SAP.ODM"
  }'

Responses

Successful Response

Bodyapplication/json

jobIdstring(Jobid)required

Example: "c045414ed53943e19794ce6353c0459a"

statusobject(JobStatus)required

status.codeinteger(Code)required

status.technicalKeystring(Technicalkey)required

status.detailsArray of objects(Details)required

status.details[].idinteger(Id)required

status.details[].technicalKeystring(Technicalkey)required

status.details[].messagestring(Message)required

configJobConfig (object)required

JobConfig (object)

startedAtstring(Startedat)

Example: "2023-10-11T10:49:00.201006+00:00"

finishedAtstring(Finishedat)

Example: "2023-10-11T10:49:20.548907+00:00"

expiresAtstring(Expiresat)read-onlyrequired

Returns the job expiration date based on its configured ttl. If None is returned, it means the job does not have a ttl set and does not expire.

Response

application/json

{
  "jobId": "c045414ed53943e19794ce6353c0459a",
  "status": {
    "code": 0,
    "technicalKey": "string",
    "details": [ … ]
  },
  "config": {
    "mirrorId": "48fe040682813e8e8873ca1bfec05b21",
    "artifactId": "data_defects_report",
    "title": "Data Defects Report",
    "columns": "all",
    "countries": [ … ],
    "dataSourceIds": [ … ],
    "format": "xlsx",
    "filters": { … },
    "includeRecordsWithNoInsights": true,
    "dnbStorageType": "DNB",
    "storageId": "48fe040682813e8e8873ca1bfec05b21",
    "validationJobId": "string",
    "dataTransformationDefinitionId": "SAP.ODM",
    "includeDatasets": false,
    "ttl": "1d",
    "featuresOn": [ … ],
    "quickFilters": [ … ],
    "additionalAttributes": [ … ]
  },
  "startedAt": "2023-10-11T10:49:00.201006+00:00",
  "finishedAt": "2023-10-11T10:49:20.548907+00:00",
  "expiresAt": "string"
}

Create Bank Account Trust Scores Report

Request

Triggers reporting job generating Bank Account Trust Scores Report.

Security

APIKeyHeader or authorization

Bodyapplication/jsonrequired

storageIdstring(Storageid)required

titlestring(Title)

Default "Bank Account Trust Scores Report"

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/bankAccountTrustScoresReport/create \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "storageId": "string",
    "title": "Bank Account Trust Scores Report"
  }'

Responses

Successful Response

Bodyapplication/json

jobIdstring(Jobid)required

Example: "c045414ed53943e19794ce6353c0459a"

statusobject(JobStatus)required

status.codeinteger(Code)required

status.technicalKeystring(Technicalkey)required

status.detailsArray of objects(Details)required

status.details[].idinteger(Id)required

status.details[].technicalKeystring(Technicalkey)required

status.details[].messagestring(Message)required

configJobConfig (object)required

JobConfig (object)

startedAtstring(Startedat)

Example: "2023-10-11T10:49:00.201006+00:00"

finishedAtstring(Finishedat)

Example: "2023-10-11T10:49:20.548907+00:00"

expiresAtstring(Expiresat)read-onlyrequired

Returns the job expiration date based on its configured ttl. If None is returned, it means the job does not have a ttl set and does not expire.

Response

application/json

{
  "jobId": "c045414ed53943e19794ce6353c0459a",
  "status": {
    "code": 0,
    "technicalKey": "string",
    "details": [ … ]
  },
  "config": {
    "mirrorId": "48fe040682813e8e8873ca1bfec05b21",
    "artifactId": "data_defects_report",
    "title": "Data Defects Report",
    "columns": "all",
    "countries": [ … ],
    "dataSourceIds": [ … ],
    "format": "xlsx",
    "filters": { … },
    "includeRecordsWithNoInsights": true,
    "dnbStorageType": "DNB",
    "storageId": "48fe040682813e8e8873ca1bfec05b21",
    "validationJobId": "string",
    "dataTransformationDefinitionId": "SAP.ODM",
    "includeDatasets": false,
    "ttl": "1d",
    "featuresOn": [ … ],
    "quickFilters": [ … ],
    "additionalAttributes": [ … ]
  },
  "startedAt": "2023-10-11T10:49:00.201006+00:00",
  "finishedAt": "2023-10-11T10:49:20.548907+00:00",
  "expiresAt": "string"
}

Get Job Status

Request

Fetches a single job including status and results.

Security

APIKeyHeader or authorization

Path

idstring(Id)required

Job UUID

curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

jobobject(Job)required

Describes a single reporting job instance.

job.jobIdstring(Jobid)required

Example: "c045414ed53943e19794ce6353c0459a"

job.statusobject(JobStatus)required

job.status.codeinteger(Code)required

job.status.technicalKeystring(Technicalkey)required

job.status.detailsArray of objects(Details)required

job.status.details[].idinteger(Id)required

job.status.details[].technicalKeystring(Technicalkey)required

job.status.details[].messagestring(Message)required

job.configJobConfig (object)required

JobConfig (object)

job.startedAtstring(Startedat)

Example: "2023-10-11T10:49:00.201006+00:00"

job.finishedAtstring(Finishedat)

Example: "2023-10-11T10:49:20.548907+00:00"

job.expiresAtstring(Expiresat)read-onlyrequired

Returns the job expiration date based on its configured ttl. If None is returned, it means the job does not have a ttl set and does not expire.

attachmentsArray of objects(Attachments)

Response

application/json

{
  "job": {
    "jobId": "c045414ed53943e19794ce6353c0459a",
    "status": { … },
    "config": { … },
    "startedAt": "2023-10-11T10:49:00.201006+00:00",
    "finishedAt": "2023-10-11T10:49:20.548907+00:00",
    "expiresAt": "string"
  },
  "attachments": [
    { … }
  ]
}

Delete Job

Request

Deletes job's metadata and artifacts.

Security

APIKeyHeader or authorization

Path

idstring(Id)required

Job UUID

curl -i -X DELETE \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Response

No content

Get Job Attachment Url

Request

Generates a download url for a single job attachment. The url is currently valid for two hours.

Security

APIKeyHeader or authorization

Path

idstring(Id)required

Job UUID

ticketstring(Ticket)required

Name and extension of the job result file.

curl -i -X GET \
  'https://idp.cdq.com/_mock/apis/cdq-analytics-api/api-v1/jobs/{id}/attachments/{ticket}/url' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

ticketstring(Ticket)required

Identifier of the generated artifact available for download.

Example: "Report.zip"

pathstring(Path)required

Normalized path to the resulting artifact.

urlstring(Url)

Optional download url for the artifact file. The reason why it's optional is that, the urls a generated dynamically and are a time constrained.

Response

application/json

{
  "ticket": "Report.zip",
  "path": "string",
  "url": "string"
}

Artifact

Operations for querying artifact related metadata.

Operations

CDQ Analytics API (1.0.0)

Job

List Jobs

Request

Responses

Share the feedback!

Create Standard Report

Request

Responses

Share the feedback!

Create Content Pack Report

Request

Responses

Share the feedback!

Create Bank Account Trust Scores Report

Request

Responses

Share the feedback!

Get Job Status

Request

Responses

Share the feedback!

Delete Job

Request

Responses

Share the feedback!

Get Job Attachment Url

Request

Responses

Share the feedback!

Artifact

CDQ Analytics API (1.0.0)

Job

List Jobs

Request

Responses

Share the feedback!

Create Standard Report

RequestExpand all

Responses

Share the feedback!

Create Content Pack Report

Request

Responses

Share the feedback!

Create Bank Account Trust Scores Report

Request

Responses

Share the feedback!

Get Job Status

Request

Responses

Share the feedback!

Delete Job

Request

Responses

Share the feedback!

Get Job Attachment Url

Request

Responses

Share the feedback!

Artifact

Request