latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Change status of multiple facility workflows via timeline events

Creates a timeline event for each supplied facility credentialing workflow in a single synchronous call, advancing each workflow's credentialingStatus to the requested state. When to use: Use to transition multiple workflows at once — for example, moving a cohort of facilities to a new credentialing stage. For a single workflow, use POST /facility-credentialing-workflows/{workflowId}/timeline-events. To discover which status values are permitted for a given workflow, call GET /{workflowId}/timeline-events/status-options first. Preconditions: Each workflow must belong to the caller's tenant. Permitted status transitions depend on the workflow's current state and the caller's permissions. Each workflow is processed independently: the response contains successful and failed arrays — inspect both even on 200 OK. Returns: 200 OK with bulk-result arrays.

post/facility-credentialing-workflows/timeline-events

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

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

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": [
    "a2b4f213-f56e-49b7-9ffe-070ff70f0539",
    "b3c5f324-f67e-49b8-0aff-181ff81f1640"
  ],
  "timelineEventData": {
    "credentialingDecisionDate": "2022-03-10",
    "nextCredentialingDate": "2022-03-10"
  },
  "filter": "{\"data.credentialingStatus\":{\"eq\":\"PENDING\"}}"
}

Response

Bulk status change operation completed. Check successful and failed arrays for details.

totalCountinteger required

Total number of workflows processed

successCountinteger required

Number of successful changes

failureCountinteger required

Number of failed changes

Example response

{
  "successful": [
    {
      "workflowId": "a2b4f213-f56e-49b7-9ffe-070ff70f0539"
    }
  ],
  "failed": [
    {
      "workflowId": "a2b4f213-f56e-49b7-9ffe-070ff70f0539"
    }
  ],
  "totalCount": 5,
  "successCount": 4,
  "failureCount": 1
}