Skip to content

Index API (1)

This API provides service index data.

Languages
Servers
Mock server

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

Production SOAP

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

Production

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

Address Index

Groups endpoints that manage address index data by creating, reading, updating, and removing address index entries.

Operations

Addresses

Groups endpoints that manage address data by searching for and collecting detailed information regarding addresses. These endpoints ensure the readiness and manageability of address information for a multitude of business requirements.

Operations

Administrative Area Index

Groups endpoints related to administrative area data, such as searching and details retrieval. Such endpoints ensure that information related to the administrative areas is easy to get and manage for various business needs.

Operations

Business Partner Index

Groups endpoints that manage Business Partner index data by creating, reading, updating, and removing Business Partner index entries. These endpoints ensure that Business Partner information is indexed and easily retrievable for various business processes.

Operations

Business Partner Index Entry

Endpoints used to deal with single entries within the Business Partner index. This includes create, read, update, and delete operations for individual Business Partner entries. These endpoints ensure that in-depth details of Business Partners are kept orderly and are well accessible to suit different business requirements.

Operations

Classify Terms

Request

Classify terms from an input string. The classification is based on the given index id and the partition keys.

Path
index_idstring(IndexId)required

ID of the index.

Example: 297de304-bf4a-4812-b49e-4249d2ccf3e4
Headers
X-Credential-Usernamestringrequired

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

  • username (e.g. "john.doe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
inputsArray of objects(NameClassificationInput)

List of name classification items.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/businesspartnersindexes/297de304-bf4a-4812-b49e-4249d2ccf3e4/businesspartnerindexentries/names/classify \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "inputs": [
      {
        "countryShortName": "CH",
        "input": "Corporate Data Quality AG"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
resultsArray of objects(NameClassificationItemResult)

List of name classification items.

Response
application/json
{
  "results": [
    { … }
  ]
}

Search Business Partners

Request

Allows searching of Business Partners in index by multiple fields. The search is based on the given index id and the partition keys.

Path
index_idstring(IndexId)required

ID of the index.

Example: 297de304-bf4a-4812-b49e-4249d2ccf3e4
Headers
X-Credential-Usernamestringrequired

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

  • username (e.g. "john.doe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
businessPartnerobject(BusinessPartnerQuery)

The Business Partner Query.

partitionKeysArray of objects(PartitionKey)

List of partition keys.

excludedPartitionKeysArray of objects(PartitionKey)

List of excluded partition keys.

featuresOnArray of strings(BusinessPartnerQueryFeatureParam)

Features:

  • EXCLUDE_INDIVIDUALS - Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.
Items ValueDescription
EXCLUDE_INDIVIDUALS

Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.

Example: ["EXCLUDE_INDIVIDUALS"]
featuresOffArray of strings(BusinessPartnerQueryFeatureParam)

Features:

  • EXCLUDE_INDIVIDUALS - Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.
Items ValueDescription
EXCLUDE_INDIVIDUALS

Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.

Example: ["EXCLUDE_INDIVIDUALS"]
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/businesspartnersindexes/297de304-bf4a-4812-b49e-4249d2ccf3e4/businesspartnerindexentries/search \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "businessPartner": {
      "names": [
        {
          "value": "Corporate Data Quality AG",
          "type": {
            "name": "No example available.",
            "technicalKey": "No example available."
          }
        }
      ],
      "identifiers": [
        {
          "value": "CHE-218.608.886 HR/MWST",
          "type": {
            "name": "No example available.",
            "technicalKey": "No example available."
          },
          "issuingBody": {
            "name": "No example available.",
            "technicalKey": "No example available."
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "mainAbbreviation": "AG"
      },
      "categories": [
        {
          "name": "No example available.",
          "technicalKey": "No example available."
        }
      ],
      "status": {
        "name": "No example available.",
        "technicalKey": "No example available."
      },
      "address": {
        "careOf": {
          "value": "CDQ GmbH c/o Product Department"
        },
        "administrativeArea": {
          "value": "Sankt Gallen",
          "shortName": "SG"
        },
        "thoroughfare": {
          "value": "Lukasstraße 4",
          "number": "4"
        },
        "postCode": {
          "value": "9000"
        },
        "locality": {
          "value": "Sankt Gallen"
        },
        "country": {
          "shortName": "CH",
          "value": "Switzerland"
        },
        "types": [
          {
            "name": "No example available.",
            "technicalKey": "No example available."
          }
        ]
      },
      "record": [
        {
          "path": "name/0/value",
          "value": "{ content: '\''SAP SE'\'' }"
        }
      ],
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "externalContext": {
        "identifiers": [
          {
            "value": "7250017031",
            "type": {
              "technicalKey": "KUNNR"
            }
          }
        ]
      },
      "profile": {
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ]
      },
      "bankAccount": {
        "bankAccountIdentifier": "CH8800781619278412000"
      },
      "dataInsights": {
        "sharingQualityGate": {
          "excludedResultStatuses": [
            "FAILED"
          ]
        }
      }
    },
    "partitionKeys": [
      {
        "key": "STORAGE_ID",
        "value": "6ecd22476b95347e8a0d215589a1110"
      }
    ],
    "excludedPartitionKeys": [
      {
        "key": "STORAGE_ID",
        "value": "6ecd22476b95347e8a0d215589a1110"
      }
    ],
    "featuresOn": [
      "EXCLUDE_INDIVIDUALS"
    ],
    "featuresOff": [
      "EXCLUDE_INDIVIDUALS"
    ],
    "pageSize": "100",
    "page": "1"
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalsinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(BusinessPartnerIndexEntry)

List of Business Partners.

Response
application/json
{
  "pageSize": "100",
  "totals": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

Fetch Business Partners

Request

Allows fetching of business partners in index by id. The search is based on the given index id and the partition keys.

Path
index_idstring(IndexId)required

ID of the index.

Example: 297de304-bf4a-4812-b49e-4249d2ccf3e4
Headers
X-Credential-Usernamestringrequired

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

  • username (e.g. "john.doe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
idstring

Business Partner identifier within a storage. Autogenerated.

Example: "0"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/businesspartnersindexes/297de304-bf4a-4812-b49e-4249d2ccf3e4/businesspartnerindexentries/fetch \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "id": "0"
  }'

Responses

OK

Bodyapplication/json
businessPartnerobject(BusinessPartnerIndexEntry)

Index metadata saved as collection of key-value pairs. Contains information about STORAGE_ID and DATA_SOURCE_VALUE.

Response
application/json
{
  "businessPartner": {
    "partitionKeys": [ … ],
    "id": "63e635235c06b7396330fe40",
    "names": [ … ],
    "metadata": { … },
    "identifiers": [ … ],
    "legalForm": { … },
    "externalId": "The ID managed in the customer's SAP systems.",
    "categories": [ … ],
    "types": [ … ],
    "profile": { … },
    "status": { … },
    "addresses": [ … ],
    "externalContext": { … },
    "additionalInformation": [ … ],
    "bankAccounts": [ … ],
    "dataInsights": { … }
  }
}

Search Business Partners

Request

Allows searching of business partners in index by multiple fields. Values are returned with relevance score, which is calculated based on query string. Note that such search has its limitations. Some analizers are unavailable during multifield search, for example special characters such as 'ł' will not be normalized to 'l'.

Path
index_idstring(IndexId)required

ID of the index.

Example: 297de304-bf4a-4812-b49e-4249d2ccf3e4
Headers
X-Credential-Usernamestringrequired

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

  • username (e.g. "john.doe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
querystring

The query string.

Example: "SAP SE"
partitionKeysArray of objects(PartitionKey)

List of partition keys.

excludedPartitionKeysArray of objects(PartitionKey)

List of excluded partition keys.

featuresOnArray of strings(BusinessPartnerQueryFeatureParam)

Features:

  • EXCLUDE_INDIVIDUALS - Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.
Items ValueDescription
EXCLUDE_INDIVIDUALS

Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.

Example: ["EXCLUDE_INDIVIDUALS"]
featuresOffArray of strings(BusinessPartnerQueryFeatureParam)

Features:

  • EXCLUDE_INDIVIDUALS - Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.
Items ValueDescription
EXCLUDE_INDIVIDUALS

Exclude Business Partners which has category businessPartner.category.technicalKey REGISTERED_INDIVIDUAL or NATURAL_PERSON.

Example: ["EXCLUDE_INDIVIDUALS"]
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/businesspartnersindexes/297de304-bf4a-4812-b49e-4249d2ccf3e4/businesspartnerindexentries/multifieldsearch \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "query": "SAP SE",
    "partitionKeys": [
      {
        "key": "STORAGE_ID",
        "value": "6ecd22476b95347e8a0d215589a1110"
      }
    ],
    "excludedPartitionKeys": [
      {
        "key": "STORAGE_ID",
        "value": "6ecd22476b95347e8a0d215589a1110"
      }
    ],
    "featuresOn": [
      "EXCLUDE_INDIVIDUALS"
    ],
    "featuresOff": [
      "EXCLUDE_INDIVIDUALS"
    ],
    "pageSize": "100",
    "page": "1"
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalsinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
valuesArray of objects(ScoredBusinessPartner)

List of scored Business Partners.

Response
application/json
{
  "pageSize": "100",
  "totals": "67",
  "page": "1",
  "values": [
    { … }
  ]
}

Business Partner Index Entries

Useful for classifying endpoints concerned with multiple entries within the Business Partner index, such as create, update, and remove multiple entries in a Business Partner index in one step. This will help to ensure the efficient and well-streamlined bulk management of the Business Partner information for various business needs.

Operations

CEDEX Lookup

Groups endpoints that manage CEDEX data by searching for and collecting detailed information regarding CEDEX codes. These endpoints ensure the readiness and manageability of CEDEX information for a multitude of business requirements.

Operations

Customer Indexes

Used for grouping API endpoints related to customer index data management, like creating, reading, or updating index entries of customers. These endpoints organize information about a customer in an organized form and make it easily accessible for further use in multiple business needs.

Operations

Data Clinic Index

Groups endpoints related to managing Data Clinic index data through create, read, update, and remove Data Clinic index entries. These endpoints ensure that Data Clinic information is indexed for easy retrieval for a large number of business processes.

Operations

Data Clinic Index Entry

Groups endpoints that deal with single entries in the Data Clinic index. This would pertain to reading, writing, updating, and removing of a particular entry of Data Clinics. These endpoints make sure that all information regarding Data Clinics is kept neat and easily accessible for many business needs.

Operations

Data Clinic Index Entries

Used to group API endpoints related to processing a number of entries in the Data Clinic Index, such as creating, updating, and removing many data clinic entries. These endpoints become crucial in allowing fast and smooth bulk management of Data Clinic information for various business purposes.

Operations

Maintenance Window Management

Groups endpoints within the scheduling and management of maintenance windows. This will feature Create, Read, and Update of maintenance windows to give stability to a system with very minimal downtime. Such endpoints allow the smooth running of services by efficient management of planned maintenance activities.

Operations

System Indexes

Groups endpoints that manage system index data by creating, reading, updating, and removing system index entries. These endpoints ensure that system information is indexed and easily retrievable for various business processes.

Operations