Create a resolution request
/crmRestApi/resources/11.13.18.05/resolutionRequests
Request
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
- application/json
object
-
DuplicateParty: array
Duplicate Parties
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. -
RequestName: string
Maximum Length:
500
The name of the request. -
ResolutionDetail: array
Resolution Details
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. -
ResolutionType: string
Maximum Length:
30
Default Value:MERGE
The type of the resolution request.
array
Duplicate Parties
array
Resolution Details
object
-
MasterFlag: boolean
Maximum Length:
1
Indicates if the duplicate party is master. The default value is false. -
PartyId(required): integer
(int64)
The unique internal identifier of a duplicate party. Either the PartyId, PartyNumber, or SourceSystem and SourceSystemReferenceValue keys is required to uniquely identify the duplicate party.
-
PartyNumber(required): string
Maximum Length:
30
The unique primary identifier for the duplicate party. -
SourceSystem: string
The original system of the party.
-
SourceSystemReference: array
Source System References
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. -
SourceSystemReferenceValue: string
The original system reference of this party.
array
Source System References
object
object
-
EntityId: integer
(int64)
The unique identifier of the logical business entity associated with the record.
-
EntityNumber: string
The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
-
EntityObject: string
Maximum Length:
30
The name of the logical business entity associated with the record. -
MasterId: integer
The unique identifier of the master record.
-
MasterNumber: string
The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
Response
- application/json
Default Response
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
object
-
AssignedTo: string
Read Only:
true
Maximum Length:255
The name of the user to whom the request is assigned. -
AssignedToId: string
Read Only:
true
Maximum Length:64
The unique identifier of the user to whom the request is assigned. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the request. -
CreationDate: string
(date-time)
Read Only:
true
The date when the request was created. -
DuplicateParty: array
Duplicate Parties
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. -
HasBeenReviewedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the request has been reviewed by a data steward. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the request was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequestedBy: string
Read Only:
true
Maximum Length:255
The name of the user who requested the duplicate resolution. -
RequestedById: string
Read Only:
true
Maximum Length:255
The unique identifier of the user who requested the duplicate resolution. -
RequestId: integer
(int64)
Read Only:
true
The unique identifier of the resolution request. -
RequestName: string
Maximum Length:
500
The name of the request. -
RequestNumber: string
Read Only:
true
Maximum Length:64
The alternate key identifier of the resolution request. -
ResolutionDetail: array
Resolution Details
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. -
ResolutionStatus: string
Read Only:
true
Maximum Length:30
The status of the request. -
ResolutionStatusMessage: string
Read Only:
true
Maximum Length:255
The reason for the resolution status when the resolution status is ERROR or REJECT. -
ResolutionType: string
Maximum Length:
30
Default Value:MERGE
The type of the resolution request. -
ReviewRequiredFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the request has to be reviewed by a data steward. -
RuleBasedMasterFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the master record was set by rules. -
SubmittedBy: string
Read Only:
true
Maximum Length:255
The name of the user who submitted the request for completion. -
SubmittedById: string
Read Only:
true
Maximum Length:255
The unique identifier of the user who submitted the request for completion. -
SubmittedDate: string
(date-time)
Read Only:
true
The date when the duplicate resolution was submitted.
array
Duplicate Parties
array
Links
array
Resolution Details
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterFlag: boolean
Maximum Length:
1
Indicates if the duplicate party is master. The default value is false. -
PartyId: integer
(int64)
The unique internal identifier of a duplicate party. Either the PartyId, PartyNumber, or SourceSystem and SourceSystemReferenceValue keys is required to uniquely identify the duplicate party.
-
PartyName: string
Read Only:
true
The name of the duplicate party. -
PartyNumber: string
Maximum Length:
30
The unique primary identifier for the duplicate party. -
PartyType: string
Read Only:
true
The type of the duplicate party, such as ORGANIZATION or PERSON. -
SourceSystem: string
The original system of the party.
-
SourceSystemReference: array
Source System References
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. -
SourceSystemReferenceValue: string
The original system reference of this party.
array
Links
array
Source System References
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceSystem: string
Read Only:
true
Maximum Length:30
The name of external source system. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The unique identifier of the duplicate party in the external source system. -
SourceSystemReferenceValue: string
Read Only:
true
Maximum Length:255
The name of the external source system from where the duplicate party was imported.
array
Links
object
-
Action: string
Read Only:
true
Maximum Length:30
The action performed on the record, for example MERGE or RETAIN. -
EntityId: integer
(int64)
The unique identifier of the logical business entity associated with the record.
-
EntityNumber: string
The unique alternate identifier of the record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
-
EntityObject: string
Maximum Length:
30
The name of the logical business entity associated with the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the duplicate entity is master. The default value is false. -
MasterId: integer
The unique identifier of the master record.
-
MasterNumber: string
The unique alternate identifier of the master record for the entities HZ_PARTY_SITES and HZ_CUST_ACCOUNTS.
-
ParentId: integer
(int64)
Read Only:
true
The unique identifier of the parent record. -
ParentMasterId: integer
(int64)
Read Only:
true
The unique identifier of the master record associated with the parent record. -
ParentObject: string
Read Only:
true
Maximum Length:255
The name of the parent object.
array
Links
- DuplicateParty
-
Parameters:
- RequestId:
$request.path.RequestId
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. - RequestId:
- ResolutionDetail
-
Parameters:
- RequestId:
$request.path.RequestId
The resolution details resource is used to view and create a master record of the surviving entities after the resolution of duplicate records. - RequestId:
Examples
- 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" : }