User Guide

Back Next

Get Preferred Record Web Service

The Get Preferred Record web service gets the preferred record for the specified cluster. The web service can also generate the preferred record for the cluster in the run time based on the specified consolidation rules.

Before you run the Get Preferred Record web service, run the Get Preferred Record Layout web service to get the layout details for the preferred record. Based on the layout details, you can configure the input parameters for the Get Preferred Record web service.

Request URL

Use the POST method to run the Get Preferred Record web service.

To run the Get Preferred Record web service, use the following URL format:

http://<Host>:<Port>/<WAR File Name>/<Version Number>/<Configuration File Identifier>/GetPreferredRecord

For example:

http://localhost:8080/MDMBDRMSYS/v5.0/SYS/GetPreferredRecord

Request Header

Use the request header to specify the following headers:

Token: Required if you secure the RESTful web services. Authentication token that the Authenticate web service returns. If the token is not valid or you do not specify the
Token
header, the web service request uses the
Authorization
header.
Authorization: Required if you have secured the RESTful web services, but optional if you specify the
Token
header.
Type of authentication and the user credentials in the Base64 format. The RESTful web services use the HTTP basic authentication. Use the following format to specify the value for the
Authorization
header:
Basic <Encoded User Credentials>
Basic
indicates the HTTP basic authentication, and
Encoded User Credentials
indicates the Base64 format of the user name and password separated by a colon. For example,
Authorization: Basic dGVzdDpUZXN0
Accept: Format of the response. The supported response format is JSON. Specify
application/json
as the header value.
Content-Type: Format of the request body. The supported format is JSON. Specify
application/json
as the header value.

Request Body

Use the request body to specify the input parameters for the Get Preferred Record web service based on the layout details that the Get Preferred Record Layout web service returns.

The following sample body contains the condition based on which you want to retrieve the preferred records:

{  
   "keyDataList":[  
      {  
         "SOURCE":"SAP",
         "ID":"41"
      },
      {  
         "SOURCE":"Salesforce",
         "ID":"        42"
      },
      {  
         "SOURCE":"SAP",
         "ID":"201"
      }
   ],
   "defaultRules":{  

   },
   "searchToken":-1,
   "pageLimit":10,
   "pageOffset":0,
   "totalCount":0,
   "debug":false,
   "resultCount":0,
   "messages":{  

   }
}

Sample Response

The following sample response shows the preferred record for the specified cluster:

{  
   "getResults":[  
      {  
         "keyData":{  
            "SOURCE":"SAP",
            "ID":"41"
         },
         "record":{  
            "ROW_RULE":"SINGLE_RECORD_CLUSTER",
            "LMT_CREATE_DATE":"20181221090143",
            "PHONE":"08040201001",
            "LMT_DIRTY_IND":"0",
            "PINCODE":"",
            "NAME":"Nani",
            "COMPANY":"Valencia F.C.",
            "COLUMN_RULE":"ALL:SINGLE_RECORD_CLUSTER",
            "SALARY":"10001",
            "CITY":"Valencia",
            "CLUSTERNUMBER":"e219cfe0-8aa9-451e-8ee0-99a75d9c7ed3    ",
            "ADDRESS":"ChurchStreet",
            "SOURCE":"SAP",
            "ID":"        41",
            "DOJ":"2012",
            "AGE":"30"
         }
      },
      {  
         "keyData":{  
            "SOURCE":"Salesforce",
            "ID":"        42"
         },
         "record":{  
            "ROW_RULE":"SINGLE_RECORD_CLUSTER",
            "LMT_CREATE_DATE":"20181221090143",
            "PHONE":"08040201002",
            "LMT_DIRTY_IND":"0",
            "PINCODE":"560104",
            "NAME":"Nani",
            "COMPANY":"",
            "COLUMN_RULE":"ALL:SINGLE_RECORD_CLUSTER",
            "SALARY":"10000",
            "CITY":"Valenci",
            "CLUSTERNUMBER":"deccf2b2-6585-4c0f-ae46-9b95b84a1de2    ",
            "ADDRESS":"ForumMall",
            "SOURCE":"Salesforce",
            "ID":"        42",
            "DOJ":"",
            "AGE":"29"
         }
      },
      {  
         "keyData":{  
            "SOURCE":"SAP",
            "ID":"201"
         },
         "record":{  
            "ROW_RULE":"DEFAULT_RULE_MAX_COLUMN_VALUES",
            "LMT_CREATE_DATE":"20181221090143",
            "PHONE":"08040201000",
            "LMT_DIRTY_IND":"0",
            "PINCODE":"560103",
            "NAME":"John Smith",
            "COMPANY":"INFA",
            "COLUMN_RULE":"CITY:RANK",
            "SALARY":"10001",
            "CITY":"Bangalore",
            "CLUSTERNUMBER":"250ef6e6-ec3d-40fc-87ea-7ca63a0c19d8    ",
            "ADDRESS":"Bagmane TechPark",
            "SOURCE":"SAP",
            "ID":"       201",
            "DOJ":"2012",
            "AGE":"30"
         }
      }
   ],
   "rowRules":{  
      "rowRule":[  

      ]
   },
   "columnRules":{  
      "columnRule":[  

      ],
      "columnGroup":[  

      ]
   },
   "searchToken":-1,
   "pageLimit":10,
   "pageOffset":0,
   "totalCount":3,
   "debug":false,
   "resultCount":3,
   "messages":{  
      "Response Time":"75 ms"
   }
}

Rename Saved Search

Table of Contents

User Guide

User Guide

Get Preferred Record Web Service

Get Preferred Record Web Service

Request URL

Request Header

Request Body

Sample Response