Creating, Deleting, and Retrieving Records

You can use the DevOps Plan REST API to Create, Delete, and Retrieve records.

To retrieve a record, use GET /repos/<teamspace_id>/databases/<database_name>/records/<record_type>/<record_id>, where SAMPL00000001 is the ID of the record that you are retrieving. For more information, see https://<plan-server-url>/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 /repos/<teamspace_id>/databases/<database_name>/records/<record_type>?operation=Commit. For more information, see https://<plan-server-url>/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 /repos/<teamspace_id>/databases/<database_name>/records/<record_type?/<record_id>?actionName=Delete. For more information, see https://<plan-server-url>/swagger-ui.html#/Record/deleteRecord.