Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
CredentialingWorkflow

Change status of multiple credentialing workflows

Creates timeline events for multiple credentialing workflows in a single operation. This allows changing the status of multiple workflows at once. Each workflow is processed independently, and the response includes both successful and failed operations.

post/credentialing-workflows/timeline-events

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[]

List of 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 /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",
      "timelineEvent": {
        "id": "te_123456",
        "workflowId": "cw_123456",
        "data": {
          "name": "CRED_APPROVED",
          "changeReason": "Application approved by committee",
          "credentialingDecisionDate": "2022-03-10",
          "nextCredentialingDate": "2022-03-10",
          "nextCredentialingDateSource": "SYSTEM_CALCULATED",
          "nextCredentialingDateChangeLog": [
            {
              "changedFrom": "2022-03-10",
              "changedTo": "2022-03-10",
              "changeReason": "Updated based on new license expiration",
              "createdBy": "user_123456",
              "createdAt": "2024-01-15T10:30:00Z"
            }
          ],
          "psvPdfPath": "/files/psv_123456.pdf",
          "overrideReason": "Test override reason",
          "isOverride": true
        },
        "createdBy": "user_123456",
        "updatedBy": "user_123456",
        "createdAt": "2022-03-10T16:15:50Z",
        "updatedAt": "2022-03-10T16:15:50Z"
      }
    }
  ],
  "failed": [
    {
      "workflowId": "a2b4f213-f56e-49b7-9ffe-070ff70f0539",
      "timelineEvent": {
        "id": "te_123456",
        "workflowId": "cw_123456",
        "data": {
          "name": "CRED_APPROVED",
          "changeReason": "Application approved by committee",
          "credentialingDecisionDate": "2022-03-10",
          "nextCredentialingDate": "2022-03-10",
          "nextCredentialingDateSource": "SYSTEM_CALCULATED",
          "nextCredentialingDateChangeLog": [
            {
              "changedFrom": "2022-03-10",
              "changedTo": "2022-03-10",
              "changeReason": "Updated based on new license expiration",
              "createdBy": "user_123456",
              "createdAt": "2024-01-15T10:30:00Z"
            }
          ],
          "psvPdfPath": "/files/psv_123456.pdf",
          "overrideReason": "Test override reason",
          "isOverride": true
        },
        "createdBy": "user_123456",
        "updatedBy": "user_123456",
        "createdAt": "2022-03-10T16:15:50Z",
        "updatedAt": "2022-03-10T16:15:50Z"
      }
    }
  ],
  "totalCount": 5,
  "successCount": 4,
  "failureCount": 1
}