Skip to content

Collaboration API (1)

CDQ.POOL API for reviews

Download OpenAPI description
api-v1.json
api-v1.yaml
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/collaboration-api/api-v1/

Production SOAP

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

Production

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

Sharing

Everything about Business Partners

Operations

Matching

Everything about Business Partners

Reviews

Collaborative review of Business Partner updates

Maintenance

Operations

Start Maintenance Job

Request

Start a maintenance job.

Security
oAuth2
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username.

Example: johndoe
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/collaboration-api/api-v1/jobs/maintenancejobs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Credential-Username: johndoe'

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
progressinteger

Progress of the job.

Example: "100"
statusstring

Status of the job.

Example: "FINISHED"
statusMessagestring

Message describing the status of the job.

Example: "Successfully shared."
Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "progress": "100",
  "status": "FINISHED",
  "statusMessage": "Successfully shared."
}

Cache

Operations