latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Bulk-assign or unassign facility credentialing workflows

Assigns one or more facility credentialing workflows to a set of users in a single call, distributing workflows evenly across the supplied user IDs using round-robin. When to use: Use to reassign a batch of workflows or to clear all assignees at once. To assign a single workflow, use POST /facility-credentialing-workflows/{id}/assignments. Key behaviors: * Existing assignees are replaced by the new assignment — this is not additive. * To unassign all workflows in the batch, pass an empty array for assignedTo. * Each workflow is processed independently; the response contains separate successful and failed arrays — inspect both. * * Returns: 200 OK with bulk-result arrays listing which workflow IDs succeeded and which failed.

post/facility-credentialing-workflows/assignments

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

List of facility 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 /facility-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",
        "tenantFacilityId": "tf_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",
        "tenantFacilityId": "tf_123456",
        "assignments": [
          {
            "assignedFrom": "user_123456",
            "assignedTo": "user_789012",
            "assignedBy": "user_345678",
            "assignedOn": "2021-01-01T00:00:00Z",
            "reason": "Load balancing"
          }
        ]
      }
    }
  ]
}