Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
CredentialingWorkflow

Create an override timeline event for a credentialing workflow

Creates an override timeline event for the specified credentialing workflow

post/credentialing-workflows/{workflowId}/override-timeline-events

Path parameters

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

namestring required
changeReasonstring
credentialingDecisionDatestring date
nextCredentialingDatestring date
overrideReasonstring
isOverrideboolean

Example request

{
  "credentialingDecisionDate": "2022-03-10",
  "nextCredentialingDate": "2022-03-10"
}

Response

Successfully created the timeline event

idstring

Unique identifier for the timeline event

workflowIdstring

ID of the associated credentialing workflow

createdBystring

ID of the user who created the timeline event

updatedBystring

ID of the user who last updated the timeline event

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "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"
}