@salesforce/lds-adapters-industries-healthcloud 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1503 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  GenericConnectApiGETOutputRepresentation:
+    description: Output representation of Generic Connect API for GET
+    type: object
+    properties:
+      code:
+        description: Generic API GET returned code
+        type: string
+        required: false
+      message:
+        description: Generic API GET Message
+        type: string
+      rowSpecificOutput:
+        description: Generic API GET List of Records
+        type: array
+        required: false
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+      searchTerm:
+        description: Generic API GET Search Term
+        type: string
+  GenericConnectApiPOSTInputRepresentation:
+    description: Generic API POST Input Representation
+    type: object
+    properties:
+      recordList:
+        description: List of records to be created for each entity
+        type: object
+        #required: false
+        properties:
+          //:
+            type: array
+            items:
+              type: any
+  GenericConnectApiPOSTInputRepresentationWrapper:
+    description: Wrapper for Generic Connect API POST Input Representation
+    type: object
+    properties:
+      GenericConnectApiPOSTInput:
+        type: GenericConnectApiPOSTInputRepresentation
+        description: Generic API POST Input Representation
+  GenericConnectApiPOSTOutputRepresentation:
+    description: Output representation of Generic Connect API for POST
+    type: object
+    properties:
+      code:
+        description: Generic API POST returned code
+        type: string
+        required: false
+      createdIds:
+        description: Generic API POST List of Created Records
+        type: object
+        required: false
+        properties:
+          //:
+            type: array
+            items:
+              type: any
+      message:
+        description: Generic API POST Message
+        type: string
+  GetSlotsInputRepresentation:
+    description: Input representation for get Slots API
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Care Program Enrollee Id
+        type: string
+        required: false
+      endTime:
+        description: End Time
+        type: string
+        required: false
+      searchConditions:
+        description: Search Conditions List
+        type: array
+        items:
+          type: SearchConditionInputRepresentation
+      startTime:
+        description: Start Time
+        type: string
+      workProcedureId:
+        description: Work Procedure Id
+        type: string
+        required: false
+  GetSlotsOutputRepresentation:
+    description: List of available slots
+    type: object
+    properties:
+      code:
+        description: Get Slots Status code
+        type: string
+      isSuccess:
+        description: Get Slots API Status flag
+        type: boolean
+      leadTimeMap:
+        description: Get Slots lead time map
+        type: object
+        required: false
+        properties:
+          //:
+            type: integer
+            required: false
+      message:
+        description: Get Slots API Error Message
+        type: string
+        required: false
+      workTypeDateTerritorySlotRepresentation:
+        description: WorkTypeDateTerritorySlotRepresentation
+        type: object
+        required: false
+        properties:
+          //:
+            type: object
+            required: false
+            properties:
+              //:
+                type: array
+                required: false
+                items:
+                  type: any # TODO Hand-rolled W-8863405
+  SearchConditionInputRepresentation:
+    description: Wraps Search Condition
+    type: object
+    properties:
+      serviceTerritoryIds:
+        description: List of Service Territory IDs
+        type: array
+        items:
+          type: string
+      workTypeId:
+        description: List of Work Type IDs
+        type: string
+  SlotSearchDatesCriteriaInputRepresentation:
+    type: object
+    description: Wraps Slot Search Date Criteria
+    properties:
+      endTime:
+        description: End Time
+        type: string
+      startTime:
+        description: Start Time
+        type: string
+      workTypeId:
+        description: Work Type Id
+        type: string
+  GetSlotChainsInputRepresentation:
+    type: object
+    description: Input Representation for Get Slot Chains API
+    properties:
+      considerPrioritizationRules:
+        description: Consider Prioritization Rules
+        type: boolean
+        required: false
+      formSlotChains:
+        description: Form Slot Chains
+        type: boolean
+        required: true
+      leadTimeMap:
+        description: Lead Time Map
+        type: object
+        required: true
+        properties:
+          //:
+            type: integer
+      searchConditions:
+        description: Search Conditions List
+        type: array
+        required: true
+        items:
+          type: SearchConditionInputRepresentation
+      slotSearchDatesCriteria:
+        description: Slot Search Dates Criteria
+        type: SlotSearchDatesCriteriaInputRepresentation
+        required: false
+      threshold:
+        description: Threshold
+        type: integer
+        required: false
+      workProcedureId:
+        description: Work Procedure Id
+        type: string
+        required: true
+      contextId:
+        description: context Id
+        type: string
+        required: false
+  GetSlotChainsOutputRepresentation:
+    description: Get Slot Chains Output Representation
+    type: object
+    properties:
+      code:
+        description: Get Slot Chains API code
+        type: string
+      isSuccess:
+        description: Get Slot Chains API Status flag
+        type: boolean
+      message:
+        description: Get Slot Chains API Error Message
+        type: string
+        required: false
+      slotChains:
+        description: Slot Chains
+        type: array
+        required: false
+        items:
+          type: any # TODO Hand-rolled W-14163124
+      workTypeDateTerritorySlotRepresentation:
+        description: WorkTypeDateTerritorySlotRepresentation
+        type: object
+        required: false
+        properties:
+          //:
+            type: object
+            required: false
+            properties:
+              //:
+                type: array
+                required: false
+                items:
+                  type: any # TODO Hand-rolled W-14163124
+  CancelSlotChainInputRepresentation:
+    description: Input Representation for Cancel Slot Chain API
+    type: object
+    properties:
+      cancelationReason:
+        description: Set Cancelation Reason
+        type: string
+        required: false
+      serviceAppointmentGroupId:
+        description: Set serviceAppointmentGroupId
+        type: string
+        required: false
+      slots:
+        description: Set Slots
+        type: array
+        items:
+          type: string
+        required: false
+      status:
+        description: Set Status
+        type: string
+  CancelSlotChainOutputRepresentation:
+    description: Output Representation for Cancel Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Cancel Slot Chain Code
+        type: string
+      isSuccess:
+        description: Cancel Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Cancel Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentIds:
+        description: Cancel Slot Chain API Service Appointment Ids
+        type: array
+        items:
+          type: string
+  WorkTypeLeadTimeInputRepresentation:
+    description: Input Representation for Work Type Lead Time API
+    type: object
+    properties:
+      contextId:
+        description: Set Context Id
+        type: string
+        required: false
+      priority:
+        description: work type service terrirotry priority
+        type: integer
+        required: false
+      workProcedureId:
+        description: Set Work Procedure Id
+        type: string
+        required: true
+  WorkTypeLeadTimeOutputRepresentation:
+    description: Output Representation for work type Lead time api
+    type: object
+    properties:
+      code:
+        description: Get Generic Entity Output API Code
+        type: string
+      workTypeLeadTimeMap:
+        description: Get Generic Entity Output Records Map
+        type: object
+        properties:
+          //:
+            type: integer
+      isSuccess:
+        description: Get Generic Entity API Status flag
+        type: boolean
+      message:
+        description: Get Generic Entity Output API Error Message
+        type: string | nil
+        required: false
+  SlotChainValidationInputRepresentation:
+    description: Input Representation for Slot Chain Validation API
+    type: object
+    properties:
+      contextId:
+        description: Set Context Id
+        type: string
+        required: false
+      workProcedureId:
+        description: Set Work Procedure Id
+        type: string
+        required: false
+      slots:
+        description: Set Slots
+        type: array
+        items:
+          type: SlotInputRepresentation
+      siteId:
+        description: Set Parent Organisation(Service Territory) Id
+        type: string
+        required: false
+  SlotChainValidationOutputRepresentation:
+    description: Output Representation for Quotas and Allocation Validation API
+    type: object
+    properties:
+      code:
+        description: Slot Chain Validation API code
+        type: string
+      isSlotChainValid:
+        description: Slot Chain Validation API Response if Slot Chain is available for booking
+        type: boolean
+      isSuccess:
+        description: Slot Chain Validation API Status flag
+        type: boolean
+      message:
+        description: Slot Chain Validation API error message
+        type: string | nil
+        required: false
+  VisitBroadcastAssignmentInputRepresentation:
+    description: Visit Broadcast Assignment API Input Representation
+    type: object
+    properties:
+      broadcastResponseAction:
+        description: Broadcast Response Action
+        type: string
+        enum:
+          - Accept
+      scheduleBroadcastAppointmentResourceId:
+        description: Schedule Broadcast Appointment Resource Id
+        type: string
+      startDateTime:
+        description: Start Datetime
+        type: string
+  VisitBroadcastAssignmentOutputRepresentation:
+    description: Visit Broadcast Assignment API Output Representation
+    type: object
+    properties:
+      code:
+        description: Visit Broadcast Assignment API Status code
+        type: string
+      isSuccess:
+        description: Visit Broadcast Assignment API Status flag
+        type: boolean
+      message:
+        description: Visit Broadcast Assignment API Message
+        type: string | nil
+  VisitBroadcastInputRepresentation:
+    description: Visit Broadcast API Input Representation
+    type: object
+    properties:
+      serviceAppointmentIds:
+        description: The comma-separated list of service appointment IDs
+        type: array
+        items:
+          type: string
+      serviceTerritoryIds:
+        description: The comma-separated list of service territory IDs where the care
+          resources attend the appointments.
+        type: array
+        items:
+          type: string
+  VisitBroadcastOutputRepresentation:
+    description: Visit Broadcast API Output Representation
+    type: object
+    properties:
+      code:
+        description: The request response code.
+        type: string
+      failedBroadcastedAppointmentIds:
+        description: The comma-separated list of service appointment IDs that aren't
+          broadcasted.
+        type: array
+        items:
+          type: string
+      message:
+        description: The request response message.
+        type: string | nil
+      status:
+        description: Indicates the status of the request. Possible values are Success,
+          Failure, and Partial Success
+        type: string
+  GetSlotsInputRepresentationWrapper:
+    description: Wrapper for Get Slots input representation
+    type: object
+    properties:
+      getSlotsInput:
+        type: GetSlotsInputRepresentation
+        description: Get Slots Input representation
+  TaskValuesInputRepresentation:
+    description: Input Representation for Task record values
+    type: object
+    properties:
+      workOrderStepId:
+        description: Related work order step id
+        type: string
+        required: false
+      taskSubject:
+        description: Task subject
+        type: string
+        required: false
+      assignedToId:
+        description: Assignee Id
+        type: string
+        required: false
+      isRequired:
+        description: Is task required
+        type: boolean
+        required: false
+  TemplateTaskValuesInputRepresentation:
+    description: Input Representation for Template Task record values
+    type: object
+    properties:
+      workOrderStepId:
+        description: Related work order step id
+        type: string
+        required: false
+      aptVersionId:
+        description: APT Version ID
+        type: string
+        required: false
+      aptItemIds:
+        description: APT Item Ids
+        type: array
+        items:
+          type: string
+        required: false
+  SlotInputRepresentation:
+    description: Input Representation for Slots
+    type: object
+    properties:
+      additionalInformation:
+        description: Set Additional Information
+        type: string
+        required: false
+      appointmentType:
+        description: Set Appointment Type
+        type: string
+        required: false
+      city:
+        description: Set City
+        type: string
+        required: false
+      comments:
+        description: Set Comments
+        type: string
+        required: false
+      contactId:
+        description: Set Contact Id
+        type: string
+        required: false
+      country:
+        description: Set Country
+        type: string
+        required: false
+      description:
+        description: Set Description
+        type: string
+        required: false
+      postalCode:
+        description: Set Postal Code
+        type: string
+        required: false
+      schedEndTime:
+        description: Set SchedEndTime
+        type: string
+      schedStartTime:
+        description: Set SchedStartTime
+        type: string
+      serviceResourceId:
+        description: Set Service Resource Id
+        type: string
+        required: false
+      serviceTerritoryId:
+        description: Set Service Territory Id
+        type: string
+      state:
+        description: Set State
+        type: string
+        required: false
+      status:
+        description: Set Status
+        type: string
+      street:
+        description: Set Street
+        type: string
+        required: false
+      subject:
+        description: Set Subject
+        type: string
+        required: false
+      workTypeId:
+        description: Set WorkType Id
+        type: string
+        required: false
+  BookSlotChainInputRepresentation:
+    description: Input Representation for Book Slot Chain
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+      slots:
+        description: Set Slots
+        type: array
+        items:
+          type: SlotInputRepresentation
+      workProcedureId:
+        description: Set Work Procedure
+        type: string
+  BookSlotChainInputRepresentationWrapper:
+    description: Wrapper for Book Slots input representation
+    type: object
+    properties:
+      BookSlotChainInput:
+        type: BookSlotChainInputRepresentation
+        description: Book Slots Input representation
+  BookSlotChainOutputRepresentation:
+    description: Output Representation for Book Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Book Slot Chain Code
+        type: string
+      isSuccess:
+        description: Book Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Book Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentGroupId:
+        description: Book Slot Chain Service Appointment Group Id
+        type: string | nil
+        required: false
+      serviceAppointmentIds:
+        description: Book Slot Chain API Service Appointment Ids
+        type: array
+        required: false
+        items:
+          type: string
+  CancelSlotChainInputRepresentationWrapper:
+    description: Wrapper for Cancel Slot Chain input representation
+    type: object
+    properties:
+      CancelSlotChainInput:
+        type: CancelSlotChainInputRepresentation
+        description: Cancel Slot Chain Input representation
+  QuotaAvailabilityDateRange:
+    description: Quota Availability Date Range
+    type: object
+    properties:
+      quotaEndDate:
+        description: Quota End Date
+        type: string
+        required: false
+      quotaStartDate:
+        description: Quota Start Date
+        type: string
+        required: false
+  QuotaAvailabilityRepresentation:
+    description: Slot Chain Output Representation
+    type: object
+    properties:
+      availabilityRangeList:
+        description: Quota Availability Date Ranges
+        type: array
+        required: false
+        items:
+          type: QuotaAvailabilityDateRange
+      workTypeId:
+        description: Work Type
+        type: string
+        required: false
+  QuotasAllocationInputRepresentation:
+    description: Input Representation for Quotas and Allocation API
+    type: object
+    properties:
+      contextId:
+        description: Context Id for Scheduling Slots
+        type: string
+      endDate:
+        description: End Date
+        type: string
+      leadTimeMap:
+        description: Lead Time Map
+        type: object
+        required: false
+        properties:
+          //:
+            type: integer
+      siteId:
+        description: Parent Service Territory ID
+        type: string
+        required: false
+      startDate:
+        description: Start Date
+        type: string
+        required: false
+      workProcedureId:
+        description: Work Procedure ID
+        type: string
+        required: false
+      workTypeId:
+        description: Work Type ID
+        type: string
+        required: false
+  QuotasAllocationOutputRepresentation:
+    description: Output Representation for Quotas and Allocation API
+    type: object
+    properties:
+      code:
+        description: Quotas Allocation API Code
+        type: string
+      isSuccess:
+        description: Quotas Allocation API Status flag
+        type: boolean
+      message:
+        description: Quotas Allocation API Error Message
+        type: string
+        required: false
+      quotaAvailability:
+        description: Quota Availability
+        type: array
+        required: false
+        items:
+          type: QuotaAvailabilityRepresentation
+  AdhocTasksAtmInputRepresentation:
+    description: Input Representation for Adhoc Tasks Atm API
+    type: object
+    properties:
+      tasks:
+        description: Set Tasks
+        type: array
+        items:
+          type: TaskValuesInputRepresentation
+        required: false
+      taskCreationMode:
+        description: Adhoc Task creation mode
+        type: string
+        required: true
+      templateTasks:
+        description: Template Tasks
+        type: TemplateTaskValuesInputRepresentation
+        required: false
+  AdhocTasksAtmOutputRepresentation:
+    description: Output Representation for Adhoc Tasks Atm API
+    type: object
+    properties:
+      code:
+        description: Adhoc Tasks Atm API code
+        type: string
+      isSuccess:
+        description: Adhoc Tasks Atm API Status flag
+        type: boolean
+      message:
+        description: Adhoc Tasks Atm API error message
+        type: string | nil
+        required: false
+      createdAssessmentTaskIds:
+        description: Created Assessment Tasks Ids
+        type: array
+        required: false
+        items:
+          type: string
+  RescheduleSlotChainInputRepresentation:
+    description: Input Representation for Reschedule Slot Chain
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+      workProcedureId:
+        description: Set Work Procedure
+        type: string
+      newSlotsInputRepresentation:
+        description: Set New Slots for Book
+        type: array
+        items:
+          type: SlotInputRepresentation
+      status:
+        description: Set Status of Group
+        type: string
+        required: false
+      rescheduleReason:
+        description: Set Reschedule Reason
+        type: string
+        required: false
+      serviceAppointmentGroupIdRescheduledSlots:
+        description: Set Service Appointment Group ID of Rescheduling Slots
+        type: string
+      serviceAppointmentIdsRescheduledSlots:
+        description: Set Service Appointment IDs of Rescheduling Slots
+        type: array
+        items:
+          type: string
+  RescheduleSlotChainInputRepresentationWrapper:
+    description: Wrapper for Reschedule Slot Chain Input Representation
+    type: object
+    properties:
+      RescheduleSlotChainInput:
+        type: RescheduleSlotChainInputRepresentation
+        description: Reschedule Slot Chain Input representation
+  RescheduleSlotChainOutputRepresentation:
+    description: Output Representation for Reschedule Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Reschedule Slot Chain Code
+        type: string
+      isSuccess:
+        description: Reschedule Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Reschedule Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentGroupIdBookedSlots:
+        description: Reschedule Slot Chain Service Appointment Group Id of Newly Booked Slots
+        type: string | nil
+        required: false
+      serviceAppointmentIdsBookedSlots:
+        description: Reschedule Slot Chain API Service Appointment Ids of Newly Booked Slots
+        type: array
+        required: false
+        items:
+          type: string
+  ServiceTerritoryRepresentation:
+    description: Service Territory Representation
+    type: object
+    properties:
+      serviceTerritoryID:
+        description: Service Territory ID
+        type: string
+      serviceTerritoryName:
+        description: Service Territory Name
+        type: string
+  FetchServiceTerritoriesInputRepresentation:
+    description: Input representation for Fetch Service Territories API
+    type: object
+    properties:
+      transplantCenterId:
+        description: Transplant Center ID
+        type: string
+      workProcedureId:
+        description: Work Procedure ID
+        type: string
+      workTypeIds:
+        description: List of WorkType IDs
+        type: array
+        items:
+          type: string
+  FetchServiceTerritoriesInputRepresentationWrapper:
+    description: Wrapper for Fetch Service Territory input representation
+    type: object
+    properties:
+      getWorkTypeServiceTerritories:
+        type: FetchServiceTerritoriesInputRepresentation
+        description: Fetch Service Territory Input representation
+  FetchServiceTerritoriesOutputRepresentation:
+    description: List Service Territories
+    type: object
+    properties:
+      code:
+        description: Fetch Service Territories Status code
+        type: string
+      isSuccess:
+        description: Fetch Service Territories Status flag
+        type: boolean
+      message:
+        description: Fetch Service Territories API Error Message
+        type: string
+        required: false
+      workTypeServiceTerritoryMap:
+        description: Map of WorkTypeId and Service Territories
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+  FetchEntityDetailsSearchConditionInputRepresentation:
+    description: Fetch entity details Search Condition
+    type: object
+    properties:
+      field:
+        description: Set entity Field Name
+        type: string
+        required: false
+      operand:
+        description: Set operand
+        type: string
+        required: false
+      value:
+        description: Set entity Value Name
+        type: any
+        required: false
+  FetchEntityDetailsInputRepresentation:
+    description: Input Representation for fetch entity details api
+    type: object
+    properties:
+      elevatedMode:
+        description: Set elevated Mode
+        type: boolean
+        required: false
+      entityApiName:
+        description: Set entity Api Name
+        type: string
+      filterLogic:
+        description: Set filter Logic
+        type: string
+      queryFieldsList:
+        description: Set Query Fields List
+        type: array
+        items:
+          type: string
+      whereConditionList:
+        description: Set entity condition list
+        type: array
+        required: false
+        items:
+          type: FetchEntityDetailsSearchConditionInputRepresentation
+  FetchEntityDetailsOutputRepresentation:
+    description: Output Representation for fetch entity details api
+    type: object
+    properties:
+      code:
+        description: Get Generic Entity Output API Code
+        type: string
+      fieldsToValueMap:
+        description: Get Generic Entity Output Records Map
+        type: object
+        properties:
+          //:
+            type: object
+            properties:
+              //:
+                type: any
+      isSuccess:
+        description: Get Generic Entity API Status flag
+        type: boolean
+      message:
+        description: Get Generic Entity Output API Error Message
+        type: string | nil
+        required: false
+  FetchEntityDetailsInputRepresentationWrapper:
+    description: Wrapper for fetch entity details input representation
+    type: object
+    properties:
+      fetchEntityDetailsInputParam:
+        type: FetchEntityDetailsInputRepresentation
+        description: Fetch Entity Details Input representation
+  MoveToNextStepInputRepresentation:
+    description: Input Representation for Move To Next Step API
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+  MoveToNextStepInputRepresentationWrapper:
+    description: Wrapper for Move To Next Step input representation
+    type: object
+    properties:
+      MoveToNextStepInput:
+        type: MoveToNextStepInputRepresentation
+        description: Move To Next Step Input representation
+  MoveToNextStepOutputRepresentation:
+    description: Move To Next Step API representation
+    type: object
+    properties:
+      code:
+        description: Move To Next Step Status code
+        type: string
+      isSuccess:
+        description: Move To Next Step API Status flag
+        type: boolean
+      lastUpdatedWorkOrder:
+        description: Last updated work order
+        type: string
+      lastUpdatedWorkOrderStep:
+        description: Last updated work order step
+        type: string
+      message:
+        description: Move To Next Step Error Message
+        type: string | nil
+      nextWorkOrder:
+        description: Next Work Order
+        type: string
+      nextWorkOrderStep:
+        description: Next Work Order Step
+        type: string
+  DigitalVerificationInputFieldsMapInputRepresentation:
+    description: Digital Verification Fields Representation
+    type: object
+    properties:
+      //:
+        type: string
+  UserCredentialsInputRepresentation:
+    description: Wraps User Credentials
+    type: object
+    properties:
+      loginId:
+        description: Set Login Id
+        type: string
+      password:
+        description: Set Password
+        type: string
+  DigitalVerificationInputRepresentation:
+    description: Input Representation for Digital Verification API
+    type: object
+    properties:
+      digitalVerificationId:
+        description: Digital Verification Id
+        type: string
+      digitalVerificationInputFieldsMap:
+        description: Digital Verification Input Fields
+        type: DigitalVerificationInputFieldsMapInputRepresentation
+      sessionId:
+        description: Session Id
+        type: string
+        required: false
+      userCredentials:
+        description: User Credentials
+        type: UserCredentialsInputRepresentation
+        required: false
+  CaseRelatedFileProcessInformationOutputRepresentation:
+    description: Output Representation for   Case Related File Process API
+    type: object
+    properties:
+      code:
+        description: Http Status Code
+        type: string
+      message:
+        description: Response stating the success or error message
+        type: string
+      caseRelatedFiles:
+        description: List of CaseRelatedFile records with associated processing information and FileBasedDataImport records.
+        type: array
+        required: false
+        items:
+          type: CaseRelatedFile
+  CaseRelatedFile:
+    description: Output Representation for Case Related File
+    type: object
+    properties:
+      caseFileProcessExecutions:
+        description: List of case file process executions and FileBasedDataImport records.
+        type: array
+        required: false
+        items:
+          type: CaseFileProcessExecution
+      caseRelatedFileId:
+        description: ID of the  CaseRelatedFile record.
+        type: string
+        required: false
+      sourceFileName:
+        description: Name of the source file
+        type: string
+        required: false
+  CaseFileProcessExecution:
+    description: Output Representation for CaseFileProcessExecution record
+    type: object
+    properties:
+      fileBasedDataImports:
+        description: List of FileBasedDataImport records.
+        type: array
+        required: false
+        items:
+          type: FileBasedDataImport
+      caseFileProcessExecutionId:
+        description: ID of the CaseFileProcessExecution record
+        type: string
+        required: false
+      processingType:
+        description: Specifies the type of the data processing job. For example, preparation or ingestion.
+        type: string
+        required: false
+      flowInterviewId:
+        description: ID of the flow interview associated with the case file process execution.
+        type: string
+        required: false
+      createdDate:
+        description: Date and time when the process was started
+        type: string
+        required: false
+      lastModifiedDate:
+        description: Date and time when CaseFileProcessExecution record was last modified
+        type: string
+        required: false
+      batchJobId:
+        description: ID of the batch job associated with the case file process execution.
+        type: string
+        required: false
+      dpeDeveloperName:
+        description: API name of DPE
+        type: string
+        required: false
+      dpeMasterLabel:
+        description: Label of DPE
+        type: string
+        required: false
+      dpeProcessingOrder:
+        description: The sequence order of the batch calc job definition.
+        type: string
+        required: false
+      dpeBatchJobStatus:
+        description: Status of the processing job
+        type: string
+        required: false
+  FileBasedDataImport:
+    description: Output Representation for FileBasedDataImport
+    type: object
+    properties:
+      jobIdentifier:
+        description: Identifier of the processing job
+        type: string
+        required: false
+      sourceFilename:
+        description: Name of the source file
+        type: string
+        required: false
+      fileBasedDataImportId:
+        description: ID of the FileBasedDataImport recor
+        type: string
+        required: false
+      failedRecordsCount:
+        description: Count of failed records
+        type: number
+        required: false
+      failedResults:
+        description: Content document record ID of the failed record
+        type: string
+        required: false
+      lastModifiedDate:
+        description: Date when the fileBasedDataImport record was last modified
+        type: string
+        required: false
+      status:
+        description: Status of the FileBasedDataImport record
+        type: string
+        required: false
+      successRecordsCount:
+        description: Count of successfully processed records
+        type: number
+        required: false
+      successfulResults:
+        description: Content document record ID of the successfully processed record
+        type: string
+        required: false
+      targetContext:
+        description: Target Entity Object eg Account, Opportunitypnm
+        type: string
+        required: false
+      dataFilterType:
+        description: Specifies the type of filter applied based on the requirement eg CSV Import, Provider Network Management Roster
+        type: string
+        required: false
+      parentJobDataImportId:
+        description: Parent job data import ID of the FileBasedDataImport record
+        type: string
+        required: false
+  DigitalVerificationOutputRepresentation:
+    description: Output Representation for Digital Verification API
+    type: object
+    properties:
+      code:
+        description: Get Digital Verification API Response Code
+        type: string
+      isSuccess:
+        description: Get Digital Verification API Response Status flag
+        type: boolean
+      message:
+        description: Get Digital Verification API Response Message
+        type: string | nil
+  IDPGetDataFieldDataOutputRepresentation:
+    description: IDP GET Data Field Data Output Representation
+    type: object
+    properties:
+      fieldApiName:
+        description: Api name of the field
+        type: string
+        required: false
+      parentReferenceId:
+        description: Parent Record Id of the object for the look up and hierarchy creation
+        type: string
+        required: false
+      value:
+        description: Value of a field
+        type: string
+        required: false
+  IDPGetDataObjectDataOutputRepresentation:
+    description: IDP GET Data Object Data Output Representation
+    type: object
+    properties:
+      objectApiName:
+        description: Api name of the object
+        type: string
+        required: false
+      referenceId:
+        description: Record Id of the object
+        type: string
+        required: false
+      attributes:
+        description: List containing field values
+        type: array
+        required: false
+        items:
+          type: IDPGetDataFieldDataOutputRepresentation
+  IDPGetDataResponseDataOutputRepresentation:
+    description: IDP GET Data Response Data Output Representation
+    type: object
+    properties:
+      data:
+        description: Data node containing list of record details in a flat structure
+        type: array
+        required: false
+        items:
+          type: IDPGetDataObjectDataOutputRepresentation
+  IDPGetDataResponseErrorDetailsOutputRepresentation:
+    description: IDP GET Data Response Error Details Output Representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code
+        type: string
+        required: false
+      errorMessage:
+        description: Error Message
+        type: string
+        required: false
+  IDPGetDataResponseErrorOutputRepresentation:
+    description: IDP GET Data Response Error Output Representation
+    type: object
+    properties:
+      errors:
+        description: List containing any error details encountered during the connect request
+        type: array
+        required: false
+        items:
+          type: IDPGetDataResponseErrorDetailsOutputRepresentation
+  IDPGetDataOutputRepresentation:
+    description: Output Representation for IDP Get Data API
+    type: object
+    properties:
+      data:
+        description: Data node containing record details in a flat structure
+        type: IDPGetDataResponseDataOutputRepresentation
+        required: false
+      error:
+        description: Error node containing error details
+        type: IDPGetDataResponseErrorOutputRepresentation
+        required: false
+      recordId:
+        description: Record ID of the requested record
+        type: string
+        required: true
+
+/connect:
+  /health:
+    /generic/{context}:
+      get:
+        description: Generic Connect API GET Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericConnectApiGETOutputRepresentation
+        queryParameters:
+          fields:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          limitBy:
+            type: string
+            required: false
+          offset:
+            type: string
+            required: false
+          searchTerm:
+            type: string
+            required: false
+          sortBy:
+            type: string
+            required: false
+          sortOrder:
+            type: string
+            required: false
+          values:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      post:
+        description: Generic Connect API POST Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericConnectApiPOSTOutputRepresentation
+        body:
+          application/json:
+            type: GenericConnectApiPOSTInputRepresentationWrapper
+            #required: false
+            (oas-body-name): GenericConnectApiPOSTInput
+      uriParameters:
+        context:
+          type: string
+          required: true
+    /advanced-therapy-management:
+      /get-slots:
+        post:
+          description: Fetch Available Slots
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GetSlotsOutputRepresentation
+          body:
+            application/json:
+              type: GetSlotsInputRepresentationWrapper
+              #required: false
+              (oas-body-name): getSlotsInput
+      /get-slot-chains:
+        post:
+          description: Get Available Slot Chains or Slots
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GetSlotChainsOutputRepresentation
+          body:
+            application/json:
+              type: GetSlotChainsInputRepresentation
+              #required: false
+              (oas-body-name): getSlotChainsInput
+      /book-slot-chain:
+        post:
+          description: Book Slot Chain API Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: BookSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: BookSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): BookSlotChainInput
+      /cancel-slot-chain:
+        post:
+          description: Cancel slot chain
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CancelSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: CancelSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): CancelSlotChainInput
+      /worktype-leadtime:
+        post:
+          description: Fetch Work Type Lead time
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: WorkTypeLeadTimeOutputRepresentation
+          body:
+            application/json:
+              type: WorkTypeLeadTimeInputRepresentation
+              #required: false
+              (oas-body-name): WorkTypeLeadTimeInput
+      /validate-slot-chain:
+        post:
+          description: Validate slot chain
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SlotChainValidationOutputRepresentation
+          body:
+            application/json:
+              type: SlotChainValidationInputRepresentation
+              #required: false
+              (oas-body-name): SlotChainInput
+      /adhoc-tasks-atm:
+        post:
+          description: Adhoc Tasks Atm
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: AdhocTasksAtmOutputRepresentation
+          body:
+            application/json:
+              type: AdhocTasksAtmInputRepresentation
+              #required: false
+              (oas-body-name): AdhocTasksAtmInput
+      /reschedule-slot-chain:
+        post:
+          description: Reschedule Slot Chain
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: RescheduleSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: RescheduleSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): RescheduleSlotChainInput
+      /fetch-service-territories:
+        post:
+          description: API to fetch Service Territories data
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: FetchServiceTerritoriesOutputRepresentation
+          body:
+            application/json:
+              type: FetchServiceTerritoriesInputRepresentationWrapper
+              #required: false
+              (oas-body-name): getWorkTypeServiceTerritories
+      /move-to-next-step:
+        post:
+          description: Move to next step
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: MoveToNextStepOutputRepresentation
+          body:
+            application/json:
+              type: MoveToNextStepInputRepresentationWrapper
+              #required: false
+              (oas-body-name): MoveToNextStepInput
+      /quotas-and-allocations:
+        post:
+          displayName: postQuotasAndAllocation
+          description: Quotas and Allocation API Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: QuotasAllocationOutputRepresentation
+          body:
+            application/json:
+              type: QuotasAllocationInputRepresentation
+              # required: false
+              (oas-body-name): QuotasAndAllocationInput
+      /digital-verification:
+        post:
+          description: Digital VerificationAPI Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DigitalVerificationOutputRepresentation
+          body:
+            application/json:
+              type: DigitalVerificationInputRepresentation
+              #required: false
+              (oas-body-name): digitalVerificationInputRequest
+    /fetch-entity-details:
+      post:
+        description: Fetch Entity Details
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FetchEntityDetailsOutputRepresentation
+        body:
+          application/json:
+            type: FetchEntityDetailsInputRepresentationWrapper
+            #required: false
+            (oas-body-name): fetchEntityDetailsInputParam
+    /home-health:
+      /visit-broadcast-assignment:
+        post:
+          displayName: postVisitBroadcastAssignment
+          description: Visit Broadcast Assignment API Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: VisitBroadcastAssignmentOutputRepresentation
+          body:
+            application/json:
+              type: VisitBroadcastAssignmentInputRepresentation
+              #required: false
+              (oas-body-name): VisitBroadcastAssignmentInput
+      /visit-broadcast:
+        post:
+          displayName: postVisitBroadcast
+          description: Visit Broadcast API Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: VisitBroadcastOutputRepresentation
+          body:
+            application/json:
+              type: VisitBroadcastInputRepresentation
+              #required: false
+              (oas-body-name): VisitBroadcastInput
+    /idp/{recordId}:
+      get:
+        displayName: getIdpRecord
+        description: Get records related to Intelligent Document Processing
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: IDPGetDataOutputRepresentation
+      uriParameters:
+        recordId:
+          type: string
+          required: true
+    /provider-network-management:
+      /case-related-file-process-information:
+        get:
+          displayName: getCaseRelatedFileProcessInformation
+          description: Retrieve case related file info records, along with their process information and fileBasedDataImport records, from the provided list of case related file IDs.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CaseRelatedFileProcessInformationOutputRepresentation
+          queryParameters:
+            caseRelatedFileIds:
+              type: array
+              required: false
+              items:
+                type: string