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

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

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.

clusterinput

Lists the details of the cluster for which you want to retrieve all the records that belong to the cluster.

Use the following format to specify the cluster details:

"<Name of the column that stores cluster identifiers >":"<Cluster ID>"

In the configuration file, under the MetaData section, the

CLUSTER_COLUMN_NAME

parameter displays the name of the column that stores the cluster identifier.

completeDetails

Indicates whether to retrieve the complete details of each record or only the source and the primary key value of each record. Set to true to retrieve the complete details of each record. Default is false.

searchToken

Optional. Indicates whether to enable pagination for the search results when you perform a search for the first time. If you enable pagination, the search request returns a token with the search results. You can use the token in the subsequent requests to get the search results from cache to avoid performing the search again.

When you run a search request for the first time, set

searchToken=0

to enable pagination. In the subsequent requests, you can use the token that the search request returns. For example,

searchToken=1994262671816343815

. Set

searchToken=-1

to disable pagination. By default, pagination is disabled.

pageLimit

Optional. Maximum number of search results to return. The

pageLimit

parameter is applicable if you enable pagination. For example,

pageLimit=20

returns 20 search results. Default is 10.

pageOffset

Optional. Number of search results to skip. The

pageOffset

parameter is applicable if you enable pagination. For example,

pageOffset=40

indicates to skip the first 40 search results and return search results starting from 41. Default is 0.

sortField

Optional. Column name based on which you want to sort the search results lexicographically. You can use one of the columns that you define in the PZMAP section of the configuration file to sort the search results. You can also use the parameter value as

score

to sort the results in the descending order of the search result scores. For example,

"sortField":"score"

.

{  
   "sortField":"ID",
   "searchType":"",
   "resultlimit":0,
   "scoreThreshold":0,
   "ignoreMatch":false,
   "searchinput":{  

   },
   "searchlayout":{  

   },
   "searchResults":[  
      {  
         "SALARY":"10001",
         "CITY":"Bangalore",
         "CLUSTERNUMBER":"ffcdf6d7-4122-4813-86ea-7999dda4f481 ",
         "ADDRESS":"Bagmane TechPark",
         "PHONE":"08040201000",
         "SOURCE":"SAP",
         "ID":" 1",
         "PINCODE":"560103",
         "DOJ":"2012",
         "NAME":"John Smith",
         "COMPANY":"INFA"
      },
      {  
         "SALARY":"10000",
         "CITY":"Bangalore",
         "CLUSTERNUMBER":"ffcdf6d7-4122-4813-86ea-7999dda4f481 ",
         "ADDRESS":"Bagmane TechPark",
         "PHONE":"08040201001",
         "SOURCE":"Salesforce",
         "ID":" 2",
         "PINCODE":"560103",
         "DOJ":"2012",
         "NAME":"John Smith",
         "COMPANY":"INFA",
         "AGE":"30"
      },
      {  
         "SALARY":"10000",
         "CITY":"Bangalore",
         "CLUSTERNUMBER":"ffcdf6d7-4122-4813-86ea-7999dda4f481 ",
         "ADDRESS":"Bagmane TechPark",
         "PHONE":"08040201000",
         "SOURCE":"Baan",
         "ID":" 3",
         "PINCODE":"560103",
         "DOJ":"2013",
         "NAME":"John Smith",
         "COMPANY":"INFA",
         "AGE":"30"
      },
      {  
         "SALARY":"10001",
         "CITY":"Bangalore",
         "CLUSTERNUMBER":"ffcdf6d7-4122-4813-86ea-7999dda4f481 ",
         "ADDRESS":"Bagmane TechPark",
         "PHONE":"08040201001",
         "SOURCE":"SAP",
         "ID":" 4",
         "PINCODE":"560103",
         "DOJ":"2012",
         "NAME":"John Smith",
         "COMPANY":"INFA",
         "AGE":"31"
      }
   ],
   "searchToken":1837122831,
   "pageLimit":4,
   "pageOffset":0,
   "totalCount":30,
   "prSearchType":"",
   "completeDetails":true,
   "debug":false,
   "resultCount":4,
   "messages":{  
      "Message.1":"Fresh Token generated"
   }
}