Retrieve Records by ID and IDEXT

The various details of how to retrieve root records by Record ID and ID extension. Classification is not supported.

HTTP Method
Endpoint URL See Endpoint
Resource /records/{repositoryName}/{id}
Request Parameters Specify the following parameters:
Name Description Type Data Type
Required
repositoryName Name of the repository. The repository name is not case sensitive. path string
id Unique ID of the record. path string
Optional
idExt Unique ID and extension of the record. query string
workItemId Unique ID of the work item.
Note: To retrieve records which are in the workflow, you must use the workItemId parameter with the recordState parameter.
query string
includeSystemAttributes Set to true if you want to include system attributes. The default value is false. query boolean
findRootRecord Set to true if you want to find only the root records. The default value is false. query boolean
recordState The state of a record that is being searched. You can specify the following values:
  • CONFIRMED: includes the confirmed records. This is the default value.
  • UNCONFIRMED: includes the unconfirmed records.
  • LATEST: includes the confirmed or unconfirmed records.
  • DELETED: includes the deleted records.
  • ALL: includes all records with any state.
query string
relationshipDepth Relationship depth. The default relationship depth level is 2. query integer (int32)
Active Specifies whether or not the deleted records are retrieved. Use Active with recordState = ALL. The valid values are Y, N, and ANY. The default value is Y.
  • Active=Y: the deleted records are not retrieved
  • Active=N: deleted records are retrieved
  • Active=ANY: either deleted or non deleted records are retrieved
query string
relationshipType Type of relationship.
  • FORWARD: This is the default value.
  • REVERSE
  • ALL

For information on relationships, refer to the section, "Relationships" in TIBCO MDM User's Guide.

query string
perspectiveName Name of the perspective. query string
Media Type application/json
Response Model 
{
  "records": [
    {
      "productId": "string",
      "productIdExt": "string",
      "productKeyId": "string",
      "version": "string",
      "state": "string",
      "attributes": [
        {
          "name": "string",
          "value": "string",
          "displayName": "string",
          "multivalues": [
            {}
          ],
          "multivalue": false,
          "id": 0,
          "groupName": "string"
        }
      ],
      "repositoryName": "string",
      "relationships": {
        "relationshipAttributes": [
          {
            "name": "string",
            "value": "string",
            "displayName": "string",
            "multivalues": [
              {}
            ],
            "multivalue": false,
            "id": 0,
            "groupName": "string"
          }
        ],
        "targetRecord": {}
      },
      "deleted": false
    }
  ],
  "totalCount": 1
}
Request Example Retrieving records by record ID and extensions where record ID is REC1 and extension is REC1in the repository named "Company". 
Endpoint:http://localhost:8080
Resource:/eml/rest/records/Company/REC1
Response Example The response returns all the records matching the criteria. 
{
   "records": [   {
      "productId": "REC1",
      "productIdExt": "REC1",
      "productKeyId": "14004",
      "version": "1",
      "state": "CONFIRMED",
      "isDeleted": false,
      "attributes":       [
                  {
            "name": "PRODUCTID",
            "value": "REC1",
            "displayName": "Record ID",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "PRODUCTIDEXT",
            "value": "REC1",
            "displayName": "Record ID Extension",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "CONTAINS",
            "value": "",
            "displayName": "Related Records",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "Name",
            "value": "TIBCO",
            "displayName": "Name",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "Address",
            "value": "IL USA",
            "displayName": "Address",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "Street",
            "value": null,
            "displayName": "Street",
            "multivalues":             [
               "11th St",
               "Rockford"
            ],
            "groupName": "Unassigned",
            "multivalue": true
         },
                  {
            "name": "Website",
            "value": "https://www.google.co.in/",
            "displayName": "Website",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "Rating",
            "value": "10.10",
            "displayName": "Rating",
            "multivalues": null,
            "groupName": "Unassigned",
            "multivalue": false
         },
                  {
            "name": "CompanySource",
            "value": "IT SOURCE",
            "displayName": "CompanySource",
            "multivalues": null,
            "groupName": "CompanyType",
            "multivalue": false
         },
                  {
            "name": "CompanyRating",
            "value": "9",
            "displayName": "CompanyRating",
            "multivalues": null,
            "groupName": "CompanyType",
            "multivalue": false
         }
      ],
      "repositoryName": "COMPANY",
      "relationships": {"companycustomer": [      {
         "relationshipAttributes":          [
                        {
               "name": "RCustomerType",
               "value": "IT",
               "displayName": null,
               "multivalues": null,
               "groupName": null,
               "multivalue": false
            },
                        {
               "name": "RCompanyType",
               "value": "IT PVT",
               "displayName": null,
               "multivalues": null,
               "groupName": null,
               "multivalue": false
            }
         ],
         "targetRecord":          {
            "productId": "REC2",
            "productIdExt": "REC2",
            "productKeyId": "14005",
            "version": "1",
            "state": "CONFIRMED",
            "isDeleted": false,
            "attributes":             [
                              {
                  "name": "PRODUCTID",
                  "value": "REC2",
                  "displayName": "Record ID",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "PRODUCTIDEXT",
                  "value": "REC2",
                  "displayName": "Record ID Extension",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "CONTAINS",
                  "value": "",
                  "displayName": "Related Records",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "CustName",
                  "value": "daniel reichard",
                  "displayName": "CustName",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "CustAddress",
                  "value": "UK",
                  "displayName": "CustAddress",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "DOB",
                  "value": "03/10/1986",
                  "displayName": "DOB",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "Salary",
                  "value": "45000",
                  "displayName": "Salary",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "Gender",
                  "value": "M",
                  "displayName": "Gender",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               },
                              {
                  "name": "CustRating",
                  "value": "7",
                  "displayName": "CustRating",
                  "multivalues": null,
                  "groupName": "Unassigned",
                  "multivalue": false
               }
            ],
            "repositoryName": "CUSTOMER",
            "relationships": {},
            "deleted": false
         }
      }]},
      "deleted": false
   }],
   "totalCount": 1
}
Success Response Example:

Code: 200 successful operation

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

Example:

Code: 400 Parameters required are missing

OR

Code: 404 Record not found

OR

Code: 500 Invalid Request

For error code response, see Error Handling .