Compare a Record

You can compare a record with its confirmed version.

HTTP Method
Endpoint URL See Endpoint
Resource /records/{repositoryName}/compareRecord/{id}
Request Parameters Specify the following parameters:
Name Description Type Data Type
Required
repositoryName Name of the repository. path string
id Unique ID of the record. path string
idExt Unique ID and extension of the record. query string
Optional
compareVersionMode Compares with the following record version modes: PREVIOUS_CONFIRMED_VERSION (Default) and PREVIOUS_VERSION query string
modVersion Base record version query string
compareVersion Compares with the version of a record.
Note: Either specify compareVersion or compareVersionMode.. If both are specified compareVersion is considered.
query string
bulkCompareMode Includes relationships. query boolean
fullCompare Set to true if you want to return all repository attributes. query boolean
Media Type application/json
Response Model 
{
  "productId": "string",
  "productIdExt": "string",
  "productKeyId": "string",
  "version": "string",
  "state": "string",
  "similarityScore":"string",
  "attributes": [
    {
      "name": "string",
      "value": "string",
      "displayName": "string",
      "multivalues": [
        {}
      ],
      "multivalue": false,
      "id": 0,
      "groupName": "string"
    }
  ],
  "repositoryName": "string",
  "relationships": {
    "relationshipAttributes": [
      {
        "name": "string",
        "value": "string",
        "displayName": "string",
        "multivalues": [
          {}
        ],
        "multivalue": false,
        "id": 0,
        "groupName": "string"
      }
    ],
    "targetRecord": {}
  },
  "deleted": false
}
Request Example 
Endpoint:http://localhost:8080
Resource:/eml/rest/records/Address/compareRecord/record1
Bulk Mode Request 
repositoryName: Parent1 {style : TEMPLATE}
id: Record_106
idExt: Record_106       {style: QUERY}
fullCompare: true		{style: QUERY}
bulkComapreMode: true	{style: QUERY}
Response Example The response returns the message that all the records matching the criteria are compared successfully. 
{
...
{
         "name": "Address",
         "value": "Australia",
         "displayName": "Address",
         "multivalues": null,
         "groupName": "Unassigned",
         "type": 0,
         "id": 0,
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "multivalue": false,
         "dataChanged": true,
         "oldValue": "IL USA",
         "oldMultiValues": null
      },
...
}
Bulk Mode Response 
{
   "productId": "Record_110",
   "productIdExt": "Record_110",
   "productKeyId": "14509",
   "version": "2",
   "state": "UNCONFIRMED",
   "key": 0,
   "effectiveDate": null,
   "similarityScore":null,
   "attributes":    [
            {
         "name": "PRODUCTID",
         "value": "Record_110",
         "displayName": "Record ID",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": false,
         "oldValue": null,
         "oldMultiValues": null,
         "multivalue": false
      },
            {
         "name": "PRODUCTIDEXT",
         "value": "Record_110",
         "displayName": "Record ID Extension",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": false,
         "oldValue": null,
         "oldMultiValues": null,
         "multivalue": false
      },
            {
         "name": "FIRSTNAME",
         "value": "Ashok",
         "displayName": "FirstName",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": false,
         "oldValue": null,
         "oldMultiValues": null,
         "multivalue": false
      },
            {
         "name": "LASTNAME",
         "value": "Kumar",
         "displayName": "LastName",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": false,
         "oldValue": null,
         "oldMultiValues": null,
         "multivalue": false
      },
            {
         "name": "ATTR1",
         "value": "Record_1101",
         "displayName": "Attr1",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": true,
         "oldValue": "Record_110",
         "oldMultiValues": null,
         "multivalue": false
      },
            {
         "name": "ATTR2",
         "value": "Record_110",
         "displayName": "Attr2",
         "multivalues": null,
         "type": 0,
         "id": 0,
         "groupName": "Unassigned",
         "associationName": null,
         "auxiliaryContent": null,
         "matchingAttribute": false,
         "dataChanged": false,
         "oldValue": null,
         "oldMultiValues": null,
         "multivalue": false
      }
   ],
   "repositoryName": "PARENT1",
   "classificationSchemeDetails": null,
   "relationships": {"P2C": [   {
      "relationshipAttributes": null,
      "targetRecord":       {
         "productId": "Record_110",
         "productIdExt": "Record_110",
         "productKeyId": "14510",
         "version": null,
         "state": null,
         "key": 0,
         "effectiveDate": null,
         "attributes": null,
         "repositoryName": "CHILD11",
         "classificationSchemeDetails": null,
         "relationships": null,
         "deleted": false
      }
   }]},
   "deleted": false
}
Success Response Example:

Code: 200 successful operation

Error Response If the response is unsuccessful, either of the following error code is displayed:

Example:

Code: 400 Bad request

OR

Code: 404 Record not found

OR

Code: 500 Invalid Request

For error code response, see Error Handling .