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

Create Data Clinic Index

Request

Create a Data Clinic Index with the given partition keys.

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
organizationIdstring(OrganizationId)required

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
partitionKeysArray of objects(PartitionKeySchema)required

List of partition keys.

partitionKeys[].​keystringrequired

Define the key for the partition key.

Example: "STORAGE_ID"
partitionKeys[].​descriptionstring

Define the description for the partition key.

Example: "Storage ID"
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/dataclinicindexes \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "organizationId": "cdq_monitor",
    "partitionKeys": [
      {
        "key": "STORAGE_ID",
        "description": "Storage ID"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring(IndexId)

The ID of the index based on an autogenerated UUID (32 hex numbers).

Example: "297de304-bf4a-4812-b49e-4249d2ccf3e4"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
partitionKeysArray of objects(PartitionKeySchema)

List of partition keys.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "297de304-bf4a-4812-b49e-4249d2ccf3e4",
  "organizationId": "cdq_monitor",
  "partitionKeys": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444"
}

Read Data Clinic Index

Request

Read by Data Clinic Index with organization 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
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/index-api/api-v1/dataclinicindexes/cdq_monitor \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
idstring(IndexId)

The ID of the index based on an autogenerated UUID (32 hex numbers).

Example: "297de304-bf4a-4812-b49e-4249d2ccf3e4"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
partitionKeysArray of objects(PartitionKeySchema)

List of partition keys.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "297de304-bf4a-4812-b49e-4249d2ccf3e4",
  "organizationId": "cdq_monitor",
  "partitionKeys": [
    { … }
  ],
  "createdAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "modifiedBy": "76248934691294444"
}

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