Get all resolution requests
get
/crmRestApi/resources/11.13.18.05/resolutionRequests
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find a resolution request with the specified RequestId.
Finder Variables:- RequestId; integer; The unique identifier of the resolution request.
- RequestByNumber: Finds a resolution request with the specified request number.
Finder Variables:
- PrimaryKey: Find a resolution request with the specified RequestId.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssignedTo; string; The name of the user to whom the request is assigned.
- AssignedToId; string; The unique identifier of the user to whom the request is assigned.
- CreatedBy; string; The user who created the request.
- CreationDate; string; The date when the request was created.
- HasBeenReviewedFlag; boolean; Indicates if the request has been reviewed by a data steward.
- LastUpdateDate; string; The date when the request was last updated.
- LastUpdatedBy; string; The user who last updated the request.
- RequestId; integer; The unique identifier of the resolution request.
- RequestName; string; The name of the request.
- RequestNumber; string; The alternate key identifier of the resolution request.
- RequestedBy; string; The name of the user who requested the duplicate resolution.
- RequestedById; string; The unique identifier of the user who requested the duplicate resolution.
- ResolutionStatus; string; The status of the request.
- ResolutionStatusMessage; string; The reason for the resolution status when the resolution status is ERROR or REJECT.
- ResolutionType; string; The type of the resolution request.
- ReviewRequiredFlag; boolean; Indicates if the request has to be reviewed by a data steward.
- RuleBasedMasterFlag; boolean; Indicates if the master record was set by rules.
- SubmittedBy; string; The name of the user who submitted the request for completion.
- SubmittedById; string; The unique identifier of the user who submitted the request for completion.
- SubmittedDate; string; The date when the duplicate resolution was submitted.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : resolutionRequests
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : resolutionRequests-item-response
Type:
Show Source
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : resolutionRequests-DuplicateParty-SourceSystemReference-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : resolutionRequests-ResolutionDetail-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all resolution requests by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resolutionRequests
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "RequestId": 300100007080506, "RequestNumber": "300100007080506", "RequestName": "Merge_32478846201244841417465", "ResolutionStatus": "COMPLETED", "ResolutionStatusMessage": null, "ResolutionType": "MERGE", "CreationDate": "2012-04-06T04:48:51+00:00", "CreatedBy": "DATA_STEWARD_MGR", "LastUpdateDate": "2012-04-06T05:26:18.606+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": }, { "RequestId": 300100007012081, "RequestNumber": "300100007012081", "RequestName": "M_32486546201253856562715", "ResolutionStatus": "NEW", "ResolutionStatusMessage": null, "ResolutionType": "MERGE", "CreationDate": "2012-04-06T05:39:04+00:00", "CreatedBy": "DATA_STEWARD_MGR", "LastUpdateDate": "2012-04-06T05:45:55.869+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "links": }, ...