Create a resolution request

post

/crmRestApi/resources/11.13.18.05/resolutionRequests

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Duplicate Parties
Type: array
Title: Duplicate Parties
The duplicate parties resource is used to view and create duplicate parties in a resolution request. The duplicate parties resource include details of the duplicate party, such as its name, identifier, and so on.
Show Source
Nested Schema : Resolution Details
Type: array
Title: Resolution Details
The resolution details resource is used to view and create a master record of the surviving entities after the resolution of duplicate records.
Show Source
Nested Schema : resolutionRequests-DuplicateParty-item-post-request
Type: object
Show Source
Nested Schema : Source System References
Type: array
Title: Source System References
The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.
Show Source
Nested Schema : resolutionRequests-DuplicateParty-SourceSystemReference-item-post-request
Type: object
Show Source
Nested Schema : resolutionRequests-ResolutionDetail-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : resolutionRequests-item-response
Type: object
Show Source
Nested Schema : Duplicate Parties
Type: array
Title: Duplicate Parties
The duplicate parties resource is used to view and create duplicate parties in a resolution request. The duplicate parties resource include details of the duplicate party, such as its name, identifier, and so on.
Show Source
Nested Schema : Resolution Details
Type: array
Title: Resolution Details
The resolution details resource is used to view and create a master record of the surviving entities after the resolution of duplicate records.
Show Source
Nested Schema : resolutionRequests-DuplicateParty-item-response
Type: object
Show Source
Nested Schema : Source System References
Type: array
Title: Source System References
The source system references resource is used to view the unique identifier of the duplicate record in the source system. Source system is the system from the duplicate record originated.
Show Source
Nested Schema : resolutionRequests-DuplicateParty-SourceSystemReference-item-response
Type: object
Show Source
Nested Schema : resolutionRequests-ResolutionDetail-item-response
Type: object
Show Source
Back to Top

Examples

You can create a resolution request by referencing the details of the duplicate parties that you wish to resolve. Depending on the details, you can create a request payload by,
  • Using the Party Number
  • Using the Party ID and Specifying the Master Record
  • Using the Source System Reference

Note:

When you create a Resolution Request, a duplicate resolution work item is also created which is processed by the Oracle Fusion Data Quality system.

The following examples show how to create a resolution request by submitting a POST request on the REST resource using cURL.

Using the Party Number

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"RequestName": "API Merge Request 001",
"ResolutionType": "MERGE",
"DuplicateParty": [
    {"PartyNumber": "CDRM_3102" },
    {"PartyNumber": "CDRM_3109" }
  ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "RequestId" : 300100177252448,
  "RequestNumber" : "300100177252448",
  "RequestName" : "API Merge Request 001",
  "ResolutionStatus" : "PENDING",
  "ResolutionStatusMessage" : null,
  "ResolutionType" : "MERGE",
  "CreationDate" : "2019-05-02T09:14:10+00:00",
  "CreatedBy" : "MDM_ADMIN_V1",
  "LastUpdateDate" : "2019-05-02T09:14:10.321+00:00",
  "LastUpdatedBy" : "MDM_ADMIN_V1",
  "DuplicateParty" : [ {
    "PartyId" : 300100011634984,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3102",
    "PartyName" : "QuickCustomer82820121231262637129",
    "MasterFlag" : true,
    "SourceSystem" : null,
    "SourceSystemReferenceValue" : null,
    "links" : 
  }, {
    "PartyId" : 300100011635048,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3109",
    "PartyName" : "QuickCustomer82820121231262637129_01",
    "MasterFlag" : false,
    "SourceSystem" : null,
    "SourceSystemReferenceValue" : null,
    "links" : ...
  } ],
  "links" : ...
}

Using the Party ID and Specifying the Master Record

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"RequestName": "API Merge Request 002",
"ResolutionType": "MERGE",
"DuplicateParty": [
    {"PartyId": "300100011634984", "MasterFlag":true },
    {"PartyId": "300100011635048", "MasterFlag":false }
  ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "RequestId" : 300100177252459,
  "RequestNumber" : "300100177252459",
  "RequestName" : "API Merge Request 002",
  "ResolutionStatus" : "PENDING",
  "ResolutionStatusMessage" : null,
  "ResolutionType" : "MERGE",
  "CreationDate" : "2019-05-02T09:19:20+00:00",
  "CreatedBy" : "MDM_ADMIN_V1",
  "LastUpdateDate" : "2019-05-02T09:19:20.050+00:00",
  "LastUpdatedBy" : "MDM_ADMIN_V1",
  "DuplicateParty" : [ {
    "PartyId" : 300100011634984,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3102",
    "PartyName" : "QuickCustomer82820121231262637129",
    "MasterFlag" : true,
    "SourceSystem" : null,
    "SourceSystemReferenceValue" : null,
    "links" : 
  }, {
    "PartyId" : 300100011635048,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3109",
    "PartyName" : "QuickCustomer82820121231262637129_01",
    "MasterFlag" : false,
    "SourceSystem" : null,
    "SourceSystemReferenceValue" : null,
    "links" : ... 
  } ],
  "links" : ...
}

Using the Source System Reference

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"RequestName": "API Merge Request 003",
"ResolutionType": "MERGE",
"DuplicateParty": [
    {"SourceSystem": "Vision", "SourceSystemReferenceValue": "432432" },
    { "SourceSystem": "Vision", "SourceSystemReferenceValue": "321321"  }
  ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "RequestId" : 300100177252470,
  "RequestNumber" : "300100177252470",
  "RequestName" : "API Merge Request 002",
  "ResolutionStatus" : "PENDING",
  "ResolutionStatusMessage" : null,
  "ResolutionType" : "MERGE",
  "CreationDate" : "2019-05-02T09:19:20+00:00",
  "CreatedBy" : "MDM_ADMIN_V1",
  "LastUpdateDate" : "2019-05-02T09:19:20.050+00:00",
  "LastUpdatedBy" : "MDM_ADMIN_V1",
  "DuplicateParty" : [ {
    "PartyId" : 300100011634984,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3102",
    "PartyName" : "QuickCustomer82820121231262637129",
    "MasterFlag" : true,
    "SourceSystem" : "Vision",
    "SourceSystemReferenceValue" : "432432",
    "links" : 
  }, {
    "PartyId" : 300100011635048,
    "PartyType" : "ORGANIZATION",
    "PartyNumber" : "CDRM_3109",
    "PartyName" : "QuickCustomer82820121231262637129_01",
    "MasterFlag" : false,
    "SourceSystem" : "Vision",
    "SourceSystemReferenceValue" : "321321",
    "links" : 
  } ],
  "links" : 
}
Back to Top