Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

Bulk-remove assignments from multiple workflows

Removes the current assignee from multiple monitoring workflows in one call. Use this endpoint for bulk unassignment; use PATCH /monitoring-workflows/{id}/unassign for a single workflow. The request body must supply either workflowIds or filter — at least one is required. Workflows in REVIEWED_BY_CERTIFYOS status are automatically excluded and appear in the response failed array. Requires all of: MONITORING_WORKFLOW_ASSIGN, MONITORING_WORKFLOW_BULK_ASSIGN, and MONITORING_WORKFLOW_ASSIGN_SELF. The tenant-id header is mandatory. Always returns HTTP 200, even when some unassignments fail — check the successful and failed arrays for per-workflow outcomes.

patch/monitoring-workflows/unassign

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

List of monitoring workflow IDs to unassign (workflow IDs will be fetched using the filter if not provided).

filterstring

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

Example request

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

Response

Bulk unassignment completed. successful/failed are arrays of {workflowId, error} — error is null on success. totalProcessed, successCount, and failureCount summarize the batch.

totalProcessedinteger

Total number of workflows processed

successCountinteger

Number of successful unassignments

failureCountinteger

Number of failed unassignments

Example response

{
  "successful": [
    {
      "workflowId": "44c8fa75-15a1-4790-a0dd-139058d1f86d"
    }
  ],
  "failed": [
    {
      "workflowId": "44c8fa75-15a1-4790-a0dd-139058d1f86d"
    }
  ]
}