Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
CredentialingWorkflow

Create assignments for multiple credentialing workflows

Creates assignments for multiple credentialing 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/credentialing-workflows/assignments

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

List of credentialing workflow IDs to assign. Required when isSelectAll is false. Ignored when isSelectAll is true (workflow IDs will be fetched using the filter).

assignedTostring[] required

List of user IDs to assign workflows to. Workflows will be evenly distributed across these users. If empty array, all workflows will be unassigned (assignedTo set to null).

reasonstring

Optional reason for the assignment

filterstring

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

isSelectAllboolean

If true, fetch all workflow IDs matching the filter criteria instead of using workflowIds. When true, filter parameter is required and workflowIds will be ignored.

Example request

{
  "workflowIds": [
    "44c8fa75-15a1-4790-a0dd-139058d1f86d",
    "55d9fb86-26b2-5801-b1ee-240169e2f97e"
  ],
  "assignedTo": [
    "user_123456",
    "user_789012"
  ],
  "reason": "Load balancing",
  "filter": "{\"data.credentialingStatus\":{\"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": {
        "workflowId": "1234",
        "tenantId": "tenant_123456",
        "tenantPractitionerId": "tp_123456",
        "assignments": [
          {
            "assignedFrom": "user_123456",
            "assignedTo": "user_789012",
            "assignedBy": "user_345678",
            "assignedOn": "2021-01-01T00:00:00Z",
            "reason": "Load balancing"
          }
        ]
      }
    }
  ],
  "failed": [
    {
      "workflowId": "44c8fa75-15a1-4790-a0dd-139058d1f86d",
      "assignment": {
        "workflowId": "1234",
        "tenantId": "tenant_123456",
        "tenantPractitionerId": "tp_123456",
        "assignments": [
          {
            "assignedFrom": "user_123456",
            "assignedTo": "user_789012",
            "assignedBy": "user_345678",
            "assignedOn": "2021-01-01T00:00:00Z",
            "reason": "Load balancing"
          }
        ]
      }
    }
  ]
}