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

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

Remove Data Clinic Index Entries

Request

Removes entries by a given partition ids and given organization id. The entries are identified by the partition keys and the Data Clinic index id.

Path
organizationstring(OrganizationId)required

ID of the organization.

Example: cdq_monitor
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
partitionKeysArray of objects(PartitionKey)

List of partition keys.

businessPartnerIdsArray of strings(BusinessPartnerId)

List of business partner IDs.

Example: ["63e635235c06b7396330fe40"]
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/dataclinicindexes/cdq_monitor/dataclinicindexentries/removeByPartitionId \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "partitionKeys": [
      {
        "key": "STORAGE_ID",
        "value": "6ecd22476b95347e8a0d215589a1110"
      }
    ],
    "businessPartnerIds": [
      "63e635235c06b7396330fe40"
    ]
  }'

Responses

OK

Bodyapplication/json
entriesToRemoveinteger(int64)

Number of entries removed.

Example: "10"
Response
application/json
{
  "entriesToRemove": "10"
}

Upsert Data Clinics Index Entries

Request

Creates or updates many Data Clinics Index Entries. The entries are identified by the partition keys and the Data Clinic index id.

Path
organizationstring(OrganizationId)required

ID of the organization.

Example: cdq_monitor
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
businessPartnersArray of objects(DataClinicIndexEntry)[ 1 .. 1000 ] itemsrequired

List of Business Partners

businessPartners[].​partitionKeysArray of objects(PartitionKey)

List of partition keys.

businessPartners[].​augmentedBusinessPartnerobject(AugmentedBusinessPartner)required

The Augmented Business Partner.

businessPartners[].​augmentedBusinessPartner.​idstring(BusinessPartnerId)required

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
businessPartners[].​augmentedBusinessPartner.​externalIdstring(BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."
businessPartners[].​augmentedBusinessPartner.​typesArray of objects(TypeEntry)

List of Business Partner types.

businessPartners[].​augmentedBusinessPartner.​summaryobject(UpdateSummary)

Summarizes the applied updates for easy consumption.

businessPartners[].​metadataobject(AugmentedMetadata)

The Augmented Metadata.

businessPartners[].​resultSummaryobject(AugmentedResultSummary)Deprecated

The Augmented Result Summary.

curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/dataclinicindexes/cdq_monitor/dataclinicindexentries \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "businessPartners": [
      {
        "partitionKeys": [
          {
            "key": "STORAGE_ID",
            "value": "6ecd22476b95347e8a0d215589a1110"
          }
        ],
        "augmentedBusinessPartner": {
          "id": "63e635235c06b7396330fe40",
          "externalId": "The ID managed in the customer'\''s SAP systems.",
          "types": [
            {
              "technicalKey": "LEGAL_ENTITY"
            }
          ],
          "summary": {
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "conceptClassifications": [
              "MAJOR"
            ],
            "tagWithClassifications": [
              {
                "tag": "IDENTIFIER_ADDED",
                "classification": "MAJOR"
              }
            ],
            "tagClassificationProvenanceTriples": [
              {
                "tag": "IDENTIFIER_ADDED",
                "classification": "MAJOR",
                "provenance": {}
              }
            ],
            "classification": {
              "technicalKey": "MAJOR"
            },
            "provenances": [
              {
                "technicalKey": "VIES"
              }
            ]
          }
        },
        "metadata": {
          "executedAt": "2021-01-01T00:00:00Z",
          "country": {
            "shortName": "CH"
          },
          "trigger": {
            "type": {
              "technicalKey": "JOB"
            },
            "provenance": {
              "technicalKey": "VIES"
            }
          },
          "processingStatus": {
            "technicalKey": "IN_PROGRESS",
            "modifiedAt": "2020-08-31T16:47+00:00"
          }
        },
        "resultSummary": {
          "overallClassification": "MAJOR",
          "identifierUpdated": "true",
          "identifierTypeTechnicalKeysUpdated": [
            "CH_VAT_ID"
          ],
          "identifierCreated": "true",
          "identifierTypeTechnicalKeysCreated": [
            "CH_VAT_ID"
          ],
          "registeredAddressUpdated": "true",
          "registeredAddressConceptsUpdated": [
            "locality"
          ],
          "registeredAddressCreated": "true",
          "vatAddressUpdated": "true",
          "vatAddressConceptsUpdated": [
            "locality"
          ],
          "vatAddressCreated": "true",
          "localAddressUpdated": "true",
          "localAddressConceptsUpdated": [
            "locality"
          ],
          "localAddressCreated": "true",
          "registeredNameUpdated": "true",
          "registeredNameCreated": "true",
          "vatNameUpdated": "true",
          "vatNameCreated": "true",
          "localNameUpdated": "true",
          "localNameCreated": "true",
          "legalFormUpdated": "true",
          "legalFormCreated": "true"
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfUpsertsinteger(int64)

Number of upserts.

Example: "10"
numberOfFailedinteger(int64)

Number of failed upserts.

Example: "0"
failuresArray of objects(UpsertFailureLog)

List of failed upserts.

Response
application/json
{
  "numberOfUpserts": "10",
  "numberOfFailed": "0",
  "failures": [
    { … }
  ]
}

Patch Data Clinics Index Entries

Request

Patches many Data Clinics Index Entries. The entries are identified by the partition keys and the Data Clinic index id.

Path
organizationstring(OrganizationId)required

ID of the organization.

Example: cdq_monitor
Bodyapplication/json
businessPartnersArray of objects(DataClinicIndexEntryPatch)[ 1 .. 1000 ] itemsrequired

List of Business Partners

businessPartners[].​partitionKeysArray of objects(PartitionKey)

List of partition keys.

businessPartners[].​augmentedBusinessPartnerobject(AugmentedBusinessPartnerPatch)required

The Augmented Business Partner.

businessPartners[].​augmentedBusinessPartner.​idstring(BusinessPartnerId)required

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
businessPartners[].​augmentedBusinessPartner.​summaryobject(UpdateSummaryPatch)

Summarizes the applied updates for PATCH operations.

businessPartners[].​metadataobject(AugmentedMetadataPatch)

The Augmented Metadata.

curl -i -X PATCH \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/dataclinicindexes/cdq_monitor/dataclinicindexentries \
  -H 'Content-Type: application/json' \
  -d '{
    "businessPartners": [
      {
        "partitionKeys": [
          {
            "key": "STORAGE_ID",
            "value": "6ecd22476b95347e8a0d215589a1110"
          }
        ],
        "augmentedBusinessPartner": {
          "id": "63e635235c06b7396330fe40",
          "summary": {
            "provenances": [
              {
                "technicalKey": "VIES"
              }
            ]
          }
        },
        "metadata": {
          "processingStatus": {
            "technicalKey": "IN_PROGRESS",
            "modifiedAt": "2020-08-31T16:47+00:00"
          }
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
statusobject(Status)

Details about status or error of a service

numberOfAcceptedinteger(int64)

Number of accepted patches.

Example: "10"
Response
application/json
{
  "status": {
    "code": "200",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2019-08-31T16:47+00:00"
  },
  "numberOfAccepted": "10"
}

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