Retrieve Related Records by Parent Record ID and ID Extension

The various details of how to retrieve related records by parent record ID and ID extension are explained in this section.

HTTP Method

GET

Endpoint URL

See Endpoint.

Resource

GET/records/{repositoryName}/{id}/relatedrecords/{relationshipName}

Request Parameters

Specify the following parameters:

Name Description Type Data Type
repositoryName Specify the repository name. This field is not case sensitive. This field is Mandatory. path string
relationshipName Specify the relationship name. This field is case sensitive. This field is Mandatory. path string
id Specify the parent record ID. This field is Mandatory. path string
idExt Specify the parent record ID extension. query string
sortBy Specify if you want to sort by column names. This field works along with ascending order field. query string
ascending Specify if you want to sort by ascending or descending order. This field works along with the sortBy column. query boolean
perspectiveName Specify the perspective name. query string
includeSystemAttributes Specify if you want to include system attributes. The default value is false. query boolean

Request Model

Media Type: application/json. 

Endpoint:http://localhost:8080
Resource:/eml/rest/records/Company/REC1_1/relatedrecords/companycustomer

Response Model

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

{
  "relationshipRecords": [
    {
      "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",
        "classificationSchemeDetails": [
          {
            "csName": "string",
            "classCode": "string",
            "schemeAction": "string",
            "classificationCodes": [
              "string"
            ]
          }
        ],
        "relationships": {},
        "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 .