Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
MonitoringWorkflow

Get monitoring workflow by ID

Retrieves a single monitoring workflow by its ID

get/monitoring-workflows/{id}

Path parameters

idstring required

ID of the monitoring workflow to retrieve

Headers

tenant-idstring required

Tenant ID

Response

Successfully retrieved the monitoring workflow

idstring

Unique identifier for the monitoring workflow

tenantIdstring

ID of the tenant

tenantPractitionerIdstring

ID of the tenant practitioner

certifyPractitionerIdstring

Certify practitioner ID

createdBystring

ID of the user who created the monitoring workflow

updatedBystring

ID of the user who updated the monitoring workflow

createdAtstring date-time
updatedAtstring date-time
allFlagsCountinteger

Total count of all existing flags (excluding new flags)

Example response

{
  "id": "1234",
  "tenantId": "tenant_123456",
  "tenantPractitionerId": "tp_123456",
  "certifyPractitionerId": "cp_123456",
  "data": {
    "monitoringStatus": "IN_PROGRESS",
    "monitoringStatusLastUpdatedDate": "2024-01-15T10:30:00Z"
  },
  "createdBy": "user_123456",
  "updatedBy": "user_123456",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z",
  "allFlagsCount": 5
}