Creating, Deleting, and Retrieving Records

You can use the HCL Compass REST API to Create, Delete, and Retrieve records.

To retrieve a record, use GET https://localhots:8190/ccmweb/rest/repos/CCMRepo/databases/SAMPL/records/Defect/SAMPL00000001, where SAMPL00000001 is the ID of the record that you are retrieving. For more information, see https://localhost:8190/swagger-ui.html#/Record/getRecord.

Sample Response: 
{
  "dbId": "33554433",
  "fields": [
    {
      "name": "Attachments",
      "value": "",
      "valueStatus": "HAS_NO_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "ATTACHMENT_LIST",
      "valueAsList": [],
      "messageText": "",
      "maxLength": 0
    },
    {
      "name": "customer",
      "value": "",
      "valueStatus": "HAS_NO_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "REFERENCE_LIST",
      "valueAsList": [],
      "messageText": "",
      "maxLength": 0
    },
…

To create a new record, use POST https://localhost:8190/ccmweb/rest/repos/CCMRepo/databases/SAMPL/records/Defect?operation=Commit. For more information, see https://localhost:8190/swagger-ui.html#/Record/createRecord .

Request body: 
{
"fields": [
        {
            "name": "Headline",
            "value": "this is test sample"
        },
        {
            "name": "Severity",
            "value": "1-Critical"
        }
    ]
}

Response:
{
  "dbId": "33554473",
  "fields": [
    {
      "name": "customer",
      "value": "",
      "valueStatus": "HAS_NO_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "REFERENCE_LIST",
      "valueAsList": [],
      "messageText": "",
      "maxLength": 0
    },
    {
      "name": "Headline",
      "value": "this is test sample",
      "valueStatus": "HAS_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "SHORT_STRING",
      "valueAsList": [
        "this is test sample"
      ],
      "messageText": "",
      "maxLength": 125
    },
{
      "name": "id",
      "value": "SAMPL00000041",
      "valueStatus": "HAS_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "ID",
      "valueAsList": [
        "SAMPL00000041"
      ],
      "messageText": "",
      "maxLength": 13
    },    {
      "name": "Description",
      "value": "",
      "valueStatus": "HAS_NO_VALUE",
      "validationStatus": "_KNOWN_VALID",
      "requiredness": "READONLY",
      "requirednessForUser": "READONLY",
      "type": "MULTILINE_STRING",
      "valueAsList": [],
      "messageText": "",
      "maxLength": 0
    },
…

To delete a record, use DELETE https://localhost:8190/ccmweb/rest/repos/CCMRepo/databases/SAMPL/records/Defect/SAMPL00000041?actionName=Delete. For more information, see https://localhost:8190/swagger-ui.html#/Record/deleteRecord.