Requests - Notes API

• List notes of a request
• Create a note
• Fields

List notes of a request

List all notes of the request with a specific ID.

GET /requests/:id/notes

Response

Status: 200 OK

[
  {
    "person": {
      "name": "Barney Turban",
      "id": 58
    },
    "created_at": "2016-03-12T11:33:00-06:00",
    "text": "Use the information gathered in the previous risk & impact analysis tasks to finalize the change plan. Do this is such a way that the implementation plan minimizes both the risk of failure and the impact on the customer(s). Also ensure that the necessary approvals are collected before the implementation of the change can start.\n\nNote that approval from the owner of the service that is related to the workflow is required for each non-standard change, regardless of whether customer representative approval is required or not. Approval from the customer representative(s) of the service that is related to the workflow is only required if the change implementation is going to cause:\n- the service to become unavailable or degraded during service hours, or\n- the functionality of the service to become different.",
    "id": 464,
    "medium": "default",
    "task": {
      "id": 89,
      "subject": "Finalize the change plan"
    },
    "attachments": []
  },
  {
    "person": {
      "name": "Luis Thomas",
      "id": 60
    },
    "created_at": "2016-03-12T11:33:00-06:00",
    "text": "Because the servers are monitored by NNM and because they will need to be rebooted after the upgrade, events wil be generated, and we should warn Operations.",
    "id": 463,
    "medium": "default",
    "task": {
      "id": 88,
      "subject": "Will events be generated when the change is implemented?"
    },
    "attachments": []
  },
  "..."
]

The response contains these fields by default.

Predefined Filters

The following predefined filters are available:

• requests/:id/notes/public : List all public notes of a request with a specific ID
• requests/:id/notes/internal : List all internal notes of a request with a specific ID

Filtering

Filtering is available for the following fields :

created_at medium person

Sorting

The collection of notes is sorted ascending by id .

The following fields are accepted by the ?sort= parameter :

id person_id created_at

Create a note

POST /requests/:id/notes

When creating a new note these fields are available.

Response

Status: 201 Created

{
  "id": 12345
}

The response contains the id of the created note.

Fields

text

Required text (max 64KB) — The text of the note.

attachments

Optional attachments Attachments that should be added to the note.

internal

Optional boolean , default: false — Set to the value true to add an internal note.

suppress_note_added_notifications

Optional boolean , default: false — Set to the value true to suppress the ‘Note Added’ notifications from being created. Other notifications, such as ‘Watchlist Item Updated’ and ‘Person Mentioned’, will still be created if applicable.

Examples

Create a note with rich text formatting

The text field supports rich text formatting, including bold, italic, lists, code blocks, and expandable sections.

POST /requests/12345/notes
Content-Type: application/json
Authorization: Bearer <token>

{
  "text": "Please verify the following:\n\n* Check **error logs** for the past 24 hours\n* Verify __network connectivity__\n* Monitor `system resources`"
}

Create a note with an expandable section (spoiler)

POST /requests/12345/notes
Content-Type: application/json
Authorization: Bearer <token>

{
  "text": "<details>\n<summary>Diagnostic Information</summary>\n\nPlease review:\n\n* **Log file**: /var/log/system.log\n* **Status**: Check with `systemctl status service`\n\n</details>"
}

Create an internal note with expandable sections

POST /requests/12345/notes
Content-Type: application/json
Authorization: Bearer <token>

{
  "text": "<details>\n<summary>Internal Diagnosis</summary>\n\nThis is internal information only for specialists.\n\n</details>",
  "internal": true
}

Create a note with multiple expandable sections

POST /requests/12345/notes
Content-Type: application/json
Authorization: Bearer <token>

{
  "text": "<details>\n<summary>Section 1</summary>\n\nContent for the first section.\n\n</details>\n\n<details>\n<summary>Section 2</summary>\n\nContent for the second section.\n\n</details>"
}