User Feedback

Clear User Feedback

Remove all links from the Matching Decision Log identified by ID. !Warning! action cannot be reverted!

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Matching Decision Log.

Example: 9cfa14e7-51f5-4490-88e4-667501575b41
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/userfeedbacks/{id}/clear
Request samples

Create Identity Link

Add Identity Links to the Matching Decision Log identified by ID.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Matching Decision Log.

Example: 9cfa14e7-51f5-4490-88e4-667501575b41
Request Body schema: application/json
required
required
Array of objects (IdentityLinkCreate) [ 1 .. 1000 ] items

List of identity links to be created.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/userfeedbacks/{id}
Request samples
application/json
{
  • "links": [
    ]
}
Response samples
application/json
{
  • "values": [
    ]
}

Create User Feedback

Create Matching Decision Log where decisions will be stored.

SecurityapiKey
Request
Request Body schema: application/json
required
name
string

Name of the matching decision log.

Example: "decisionLogOne"
Responses
200

OK

401

Unauthorized

403

Forbidden

post/userfeedbacks
Request samples
application/json
{
  • "name": "decisionLogOne"
}
Response samples
application/json
{
  • "id": "65dcc3c60cecd503bcc88c92",
  • "createdAt": "2024-07-11T07:22:19Z",
  • "name": "decisionLogOne",
  • "organization": "12345678-1234-5678-1234-567812345678"
}

Delete User Feedback

Delete the Matching Decision Log identified by ID. !Warning! action cannot be reverted!

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Matching Decision Log.

Example: 9cfa14e7-51f5-4490-88e4-667501575b41
Responses
200

OK

400

The sent request is malformed.

403

Permission denied.

delete/userfeedbacks/{id}
Request samples
Response samples
application/json
{
  • "status": "400",
  • "path": "/v2/businesspartners/lookup",
  • "timestamp": "2024-07-11T07:22:19Z",
  • "error": "BAD_REQUEST",
  • "message": "This user is not allowed to access this service."
}

Poll Matching Decision Import Job Status

Polls the status of the matching decision import job.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Matching Decision Import Job.

Example: 65dcc3c60cecd503bcc88c92
Responses
200

OK

401

Unauthorized

403

Forbidden

get/matchingdecisionjobs/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "domain": "https://cdq.com",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-07-11T07:22:19Z",
  • "modifiedAt": "2024-07-11T07:22:19Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "decisionLogId": "65dcb1d68f01e37c2cf9bbb2",
  • "result": {
    }
}

Read Identity Links

Read Identity Links from the Matching Decision Log identified by ID.

SecurityapiKey
Request
query Parameters
businessPartnerId
string (BusinessPartnerId)

Business Partner ID provided by CDQ that is unique across all stored Business Partners in CDQ Cloud. Used to filter results by this ID.

Example: businessPartnerId=63e635235c06b7396330fe40
dataSourceId
string (BusinessPartnerStorageDataSourceId)

Unique Storage's Data Source identifier.

Example: dataSourceId=648824a691d8d2503d65103e
limit
integer <int32> >= 1
Default: 20

Number of items to be returned.

Example: limit=100
linkStorageId
required
string

Link Storage Id.

Example: linkStorageId=72d6900fce6b326088f5d9d91049e3e6
startAfter
string (StartAfter)

Indicator for the next page. Used together with nextStartAfter from the result.

Example: startAfter=5712566172571652
storageId
string (BusinessPartnerStorageId)

Unique Storage identifier.

Example: storageId=72d6900fce6b326088f5d9d91049e3e6
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

get/userfeedbacks/identitylinks
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}

Read User Feedback by ID

Read Matching Decision Logs details provided by ID.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Matching Decision Log.

Example: 9cfa14e7-51f5-4490-88e4-667501575b41
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

get/userfeedbacks/{id}
Request samples
Response samples
application/json
{
  • "matchingDecisionLog": {
    },
  • "status": "OK",
  • "message": "Decision log has been fetched successfully"
}

Read User Feedbacks

Read available Matching Decision Logs across your organization.

SecurityapiKey
Request
query Parameters
limit
integer <int32> >= 1
Default: 20

Number of items to be returned.

Example: limit=100
startAfter
string (StartAfter)

Indicator for the next page. Used together with nextStartAfter from the result.

Example: startAfter=5712566172571652
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

get/userfeedbacks
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}

Start Matching Decision Import Job

To start importing an Identity Linkage Decision import file, use the following request.

POST https://api.corporate-data-league.ch/data-matching/rest/jobs/matchingdecisionjobs
  ?file=@{YOUR FILE}
  ?decisionLogId={YOUR MatchingDecisionLog ID}

With using output file from duplication or linkage job. Please remember not to remove the mandatory columns when modifying this file: No Match Feedback, Matching Group, Storage ID, Data Source ID, Record ID.

The response is shown below. Use the returned id to poll the import job status.

{
    "id" : "{YOUR JOB ID}"
    ...
}

This import leads to the following link in the MatchingDecisionLog.

{
   "id" : "{AUTO GENERATED}",
   "decisionLogId" : "b7d528eace273a10aeb00825f48b5b18",
   "entities" : [{
       "storageId": "b7d528eace273a10aeb00825f48b5b18",
       "dataSourceId": "5f9fc1b97e1e490001fcfc9e",
       "businessPartnerId": "5e60dfdbd5fa2d000166ab4a"
     },
     {
       "storageId": "b7d528eace273a10aeb00825f48b5b18",
       "dataSourceId": "5f9fc1b97e1e490001fcfc9e",
       "businessPartnerId": "5e60dfdbd5fa2d000166ab4b"
     }]
 }
SecurityapiKey
Request
Request Body schema: multipart/form-data
decisionLogId
required
string

Target MatchingDecisionLog ID for this import.

Example: "5e60dfdbd5fa2d000166ab4a"
file
required
string <binary>

XLSX or CSV file to be uploaded (SOAP currently only supports CSV).

Example: "file.xlsx"
Responses
200

OK

400

The sent request is malformed.

post/matchingdecisionjobs
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "domain": "https://cdq.com",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-07-11T07:22:19Z",
  • "modifiedAt": "2024-07-11T07:22:19Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "decisionLogId": "65dcb1d68f01e37c2cf9bbb2",
  • "result": {
    }
}