v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

MonitoringWorkflow

Create assignments for multiple monitoring workflows

Creates assignments for multiple monitoring workflows in a single operation. Workflows are evenly distributed across the provided user IDs using round-robin distribution. Each workflow is processed independently, and results include both successful and failed assignments.

post/monitoring-workflows/assignments

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

List of monitoring workflow IDs to assign. Either workflowIds or filter must be provided.

assignTostring[] required

List of user IDs to assign workflows to. Workflows will be evenly distributed across these users

filterstring

Filter criteria as JSON string (URL encoded). Used to fetch workflow IDs when workflowIds is not provided. See GET /monitoring-workflows endpoint documentation for filter format.

Example request

{
  "workflowIds": [
    "44c8fa75-15a1-4790-a0dd-139058d1f86d",
    "55d9fb86-26b2-5801-b1ee-240169e2f97e"
  ],
  "assignTo": [
    "user_123456",
    "user_789012"
  ],
  "filter": "{\"data.monitoringStatus\":{\"eq\":\"PENDING\"}}"
}

Response

Bulk assignment operation completed. Check successful and failed arrays for individual results.

totalProcessedinteger

Total number of workflows processed

successCountinteger

Number of successful assignments

failureCountinteger

Number of failed assignments

Example response

{
  "successful": [
    {
      "workflowId": "44c8fa75-15a1-4790-a0dd-139058d1f86d",
      "assignment": {
        "assignedTo": "user_789012",
        "assignedBy": "user_345678",
        "assignedAt": "2021-01-01T00:00:00Z"
      }
    }
  ],
  "failed": [
    {
      "workflowId": "44c8fa75-15a1-4790-a0dd-139058d1f86d",
      "assignment": {
        "assignedTo": "user_789012",
        "assignedBy": "user_345678",
        "assignedAt": "2021-01-01T00:00:00Z"
      }
    }
  ]
}