Retrieve records by ID and IDEXT

HTTP Method

GET

Endpoint URL

Resource

GET/records/{repositoryName}/{id}

Request Parameters

Specify the following parameters:

Name	Description	Type	Data Type
repositoryName	Specify the repository name. This is not case sensitive. This field is Mandatory.	path	string
id	Specify the record ID. This field is Mandatory.	path	string
idExt	Specify the record ID extension.	path	string
workItemId	Specify the work item ID.	query	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 records only. The default value is false.	query	boolean
recordState	Specify the record state. The available options are: CONFIRMED,UNCONFIRMED,DELETED, and LATEST. The default value is CONFIRMED.	query	string
relationshipDepth	Specify the relationship depth. The default relationship depth level is 2.	query	integer (int32)

Request Model

Media Type: application/json.

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

Response Model

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

{
  "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": {
    "relationshipAttributes": [
      {
        "name": "string",
        "value": "string",
        "displayName": "string",
        "multivalues": [
          {}
        ],
        "type": 0,
        "id": 0,
        "groupName": "string",
        "associationName": "string",
        "auxiliaryContent": {},
        "multivalue": false
      }
    ],
    "targetRecord": {}
  },
  "deleted": false
}

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 .

Contents

Index