Skip to content

CX Pool API (1)

API for CX.POOL reviews

Overview
URL

https://www.cdq.com/about-cdq#cdq-team

Michał Malinka

michal.malinka@cdq.com

Languages
Servers
Mock server

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

Production SOAP

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

Production

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

Sharing

Everything about Business Partners

Operations

Pool

Everything about the Pool

Operations

Read Sharing Target Storage Metadata

Request

Read metadata of a sharing target storage.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

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

  • username (e.g. "johndoe")
  • 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/cx-pool-api/api-v1/sharing/target \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
clientIdstring(ClientId)

Uniquely identifying ID of the client.

Example: "12345678-1234-5678-1234-567812345678"
Response
application/json
{
  "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  "clientId": "12345678-1234-5678-1234-567812345678"
}

Update Sharing Target Storage Metadata

Request

Update metadata of a sharing target storage. Dedicated only for development environments where there is only one instance of cx-pool-api.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a 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)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
clientIdstring(ClientId)

Uniquely identifying ID of the client.

Example: "12345678-1234-5678-1234-567812345678"
curl -i -X PATCH \
  https://idp.cdq.com/_mock/apis/cx-pool-api/api-v1/sharing/target \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "clientId": "12345678-1234-5678-1234-567812345678"
  }'

Responses

OK

Bodyapplication/json
storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
clientIdstring(ClientId)

Uniquely identifying ID of the client.

Example: "12345678-1234-5678-1234-567812345678"
Response
application/json
{
  "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  "clientId": "12345678-1234-5678-1234-567812345678"
}

Cache

Everything about the Cache

Operations