Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
MonitoringWorkflowNote

Get a note by ID

Retrieves a specific note by its ID for the specified monitoring workflow

get/monitoring-workflows/{workflowId}/notes/{noteId}

Path parameters

noteIdstring required

ID of the note

workflowIdstring required

ID of the monitoring workflow

Headers

tenant-idstring required

Tenant ID

Response

Successfully retrieved note

idstring

Unique identifier for the note

workflowIdstring

ID of the associated monitoring workflow

createdBystring

ID of the user who created the note

createdByNamestring

Full name of the user who created the note

updatedBystring

ID of the user who last updated the note

updatedByNamestring

Full name of the user who last updated the note

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "note_123456",
  "workflowId": "mw_123456",
  "data": {
    "message": "This is a note message"
  },
  "createdBy": "user_123456",
  "createdByName": "John Doe",
  "updatedBy": "user_123456",
  "updatedByName": "Jane Smith",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}