Search a Record

The various details of how to search a record is explained in this section.

HTTP Method

POST

Endpoint URL

See Endpoint.

Resource

/records/{repositoryName}/search

Request Parameters

Specify the following parameters:

Name Description Type Data Type
repositoryName Specify the repository name.

This field is Mandatory.

path string
includeSystemAttributes Specify whether you want to include system attributes. The default value is false. query boolean
findRootRecord Specify whether you want to find root record only. The default value is false. query boolean

Request Model

Media Type: application/json. 

{
   "name": "string",
   "productKey": 0,
   "attributes": [
      {
         "name": "string",
         "value": [
            {}
         ],
         "operator": "string",
         "caseSensitive": false
      }
   ],
   "relationships": [
      {
         "name": "string",
         "count": 0,
         "checkExistence": false,
         "relationshipAttributes": [
            {
               "name": "string",
               "value": [
                  {}
               ],
               "operator": "string",
               "caseSensitive": false
            }
         ],
         "repository": {}
      }
   ],
}

Response Model

The server sends response 200 OK with HTTP status code for each successfully completed request. The success response format is as follows: 

{
   "records": [
      {
         "productId": "string",
         "productIdExt": "string",
         "productKeyId": "string",
         "version": "string",
         "state": "string",
         "key": 0,
         "effectiveDate": "string",
         "attributes": [
            {
               "name": "string",
               "value": "string",
               "displayName": "string",
               "multivalues": [
                  {}
               ],
               "type": 0,
               "id": 0,
               "groupName": "string",
               "associationName": "string",
               "auxiliaryContent": {},
               "multivalue": false
            }
         ],
         "repositoryName": "string",
         "relationships": {
            "": [
               {
                  "relationshipAttributes": [
                     {
                        "name": "string",
                        "value": "string",
                        "displayName": "string",
                        "multivalues": [
                           {}
                        ],
                        "type": 0,
                        "id": 0,
                        "groupName": "string",
                        "associationName": "string",
                        "auxiliaryContent": {},
                        "multivalue": false
                     }
                  ],
                  "targetRecord": {
                     "productId": "string",
                     "productIdExt": "string",
                     "productKeyId": "string",
                     "version": "string",
                     "state": "string",
                     "key": 0,
                     "effectiveDate": "string",
                     "attributes": [
                        {
                           "name": "string",
                           "value": "string",
                           "displayName": "string",
                           "multivalues": [
                              {}
                           ],
                           "type": 0,
                           "id": 0,
                           "groupName": "string",
                           "associationName": "string",
                           "auxiliaryContent": {},
                           "multivalue": false
                        }
                     ],
                     "repositoryName": "string",
                     "relationships": {
                        "": [
                           {
                              "relationshipAttributes": [
                                 {
                                    "name": "string",
                                    "value": "string",
                                    "displayName": "string",
                                    "multivalues": [
                                       {}
                                    ],
                                    "type": 0,
                                    "id": 0,
                                    "groupName": "string",
                                    "associationName": "string",
                                    "auxiliaryContent": {},
                                    "multivalue": false
                                 }
                              ],
                              "targetRecord": {}
                           }
                        ]
                     },
                     "deleted": false
                  }
               }
            ]
         },
         "deleted": false
      }
   ],
   "totalCount": 0
}

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

  • 400 Bad Request
  • 404 Not Found
  • 500 Internal Server Error

For error code response, see Error Handling .