v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

FlagCalculator

Calculate flags for a monitoring workflow

Calculates flags for a monitoring workflow based on practitioner data and manages flag lifecycle (create/update/deactivate) according to the comparison with existing flags

post/flag-calculator

Headers

tenant-idstring required

Tenant ID

user-idstring

User ID for service-to-service calls

Request body

monitoringWorkflowIdstring required

ID of the monitoring workflow to calculate flags for

sectionsstring[]

Array of sections to calculate flags for. If not provided or empty, all sections' flags are calculated

Example request

{
  "monitoringWorkflowId": "mw_1234567890",
  "sections": [
    "licenses",
    "education"
  ]
}

Response

Successfully calculated flags

flagsCreatedinteger

Number of flags created

flagsUpdatedinteger

Number of flags updated

flagsDeactivatedinteger

Number of flags deactivated

totalFlagsinteger

Total number of flags after calculation

monitoringWorkflowIdstring

ID of the monitoring workflow

Example response

{
  "flagsCreated": 5,
  "flagsUpdated": 3,
  "flagsDeactivated": 2,
  "totalFlags": 8,
  "monitoringWorkflowId": "mw_1234567890"
}