Retrieve Records from a Repository

The various details of how to retrieve records from a repository are explained in this section. Only the root level records are retrieved. Classification, GroupName, and EffectiveDate are not supported.

HTTP Method
Endpoint URL See Endpoint
Resource /records/{repositoryName}
Request Parameters Specify the following parameters:
Name Description Type Data Type
Required
repositoryName Name of the repository. path string
Optional
startIndex Starting index of the start record. This is used for pagination. The default value is 1. query integer (int32)
recordCount Number of records to be retrieved. This is used for pagination. query integer (int32)
includeSystemAttributes Set to true if you want to include system attributes. The default value is false. query boolean
sortBy Column name on which you want to sort the data. The sortBy works with the ascending field. query string
ascending Set to true if you want to sort by the ascending order. The ascending field works with the sortBy field. 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
Media Type application/json
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
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
Response Model 
{
  "records": [
    {
      "productId": "string",
      "productIdExt": "string",
      "productKeyId": "string",
      "version": "string",
      "state": "string",
      "effectiveDate": "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": 0
}
Request Example 
Endpoint:http://localhost:8080
Resource:/eml/rest/records/Company
Response Example 
{
   "records":    [
            {
         "productId": "REC1",
         "productIdExt": "REC1",
         "productKeyId": "12799",
         "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": {},
         "deleted": false
      },
            {
         "productId": "record1-1",
         "productIdExt": "record1-1",
         "productKeyId": "12798",
         "version": "1",
         "state": "CONFIRMED",
         "isDeleted": false,
         "attributes":          [
                        {
               "name": "PRODUCTID",
               "value": "record1-1",
               "displayName": "Record ID",
               "multivalues": null,
               "groupName": "Unassigned",
               "multivalue": false
            },
                        {
               "name": "PRODUCTIDEXT",
               "value": "record1-1",
               "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": {},
         "deleted": false
      }
   ],
   "totalCount": 2
}
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 Repository not found

OR

Code: 500 Invalid Request

For error code response, see Error Handling .