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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/industries-omnidesigner.js +15146 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  4. package/dist/es/es2018/types/src/generated/adapters/buildBusinessProcessDataJson.d.ts +18 -0
  5. package/dist/es/es2018/types/src/generated/adapters/buildJson.d.ts +18 -0
  6. package/dist/es/es2018/types/src/generated/adapters/cardUpsertAttachment.d.ts +17 -0
  7. package/dist/es/es2018/types/src/generated/adapters/cloneOmniProcess.d.ts +16 -0
  8. package/dist/es/es2018/types/src/generated/adapters/cloneOmniProcessElement.d.ts +16 -0
  9. package/dist/es/es2018/types/src/generated/adapters/deleteOmniProcessElement.d.ts +16 -0
  10. package/dist/es/es2018/types/src/generated/adapters/fetchDataraptorList.d.ts +28 -0
  11. package/dist/es/es2018/types/src/generated/adapters/fetchDecisionMatrix.d.ts +26 -0
  12. package/dist/es/es2018/types/src/generated/adapters/fetchDocusignTemplates.d.ts +26 -0
  13. package/dist/es/es2018/types/src/generated/adapters/fetchEmailDocuments.d.ts +26 -0
  14. package/dist/es/es2018/types/src/generated/adapters/fetchEntityInfo.d.ts +28 -0
  15. package/dist/es/es2018/types/src/generated/adapters/fetchOmniProcessData.d.ts +27 -0
  16. package/dist/es/es2018/types/src/generated/adapters/fetchOmniProcessList.d.ts +29 -0
  17. package/dist/es/es2018/types/src/generated/adapters/getCardById.d.ts +28 -0
  18. package/dist/es/es2018/types/src/generated/adapters/getCardList.d.ts +29 -0
  19. package/dist/es/es2018/types/src/generated/adapters/getDataraptorConfig.d.ts +31 -0
  20. package/dist/es/es2018/types/src/generated/adapters/getDecisionTableForDocumentMatrix.d.ts +26 -0
  21. package/dist/es/es2018/types/src/generated/adapters/getDesignerCustomization.d.ts +27 -0
  22. package/dist/es/es2018/types/src/generated/adapters/getDesignerCustomizationElementWarning.d.ts +28 -0
  23. package/dist/es/es2018/types/src/generated/adapters/getDesignerElementCustomizations.d.ts +28 -0
  24. package/dist/es/es2018/types/src/generated/adapters/getDocusignTemplatesExternal.d.ts +26 -0
  25. package/dist/es/es2018/types/src/generated/adapters/getDynamicElements.d.ts +26 -0
  26. package/dist/es/es2018/types/src/generated/adapters/getEmailTemplates.d.ts +26 -0
  27. package/dist/es/es2018/types/src/generated/adapters/getEntityRecords.d.ts +21 -0
  28. package/dist/es/es2018/types/src/generated/adapters/getExpressionGrammar.d.ts +27 -0
  29. package/dist/es/es2018/types/src/generated/adapters/getFileBasedOsDetail.d.ts +27 -0
  30. package/dist/es/es2018/types/src/generated/adapters/getFileBasedOsList.d.ts +26 -0
  31. package/dist/es/es2018/types/src/generated/adapters/getFileCardDetail.d.ts +27 -0
  32. package/dist/es/es2018/types/src/generated/adapters/getIntegrationProcedureFetchRecord.d.ts +27 -0
  33. package/dist/es/es2018/types/src/generated/adapters/getNonOmniscriptLwc.d.ts +28 -0
  34. package/dist/es/es2018/types/src/generated/adapters/insertOmniProcessElement.d.ts +23 -0
  35. package/dist/es/es2018/types/src/generated/adapters/integrationProcedureExecutionResult.d.ts +21 -0
  36. package/dist/es/es2018/types/src/generated/adapters/moveOmniProcessElement.d.ts +18 -0
  37. package/dist/es/es2018/types/src/generated/adapters/postClearDatamapperCache.d.ts +17 -0
  38. package/dist/es/es2018/types/src/generated/adapters/postClearIntegrationProcedureCache.d.ts +19 -0
  39. package/dist/es/es2018/types/src/generated/adapters/postExecuteDataMapper.d.ts +20 -0
  40. package/dist/es/es2018/types/src/generated/adapters/postIntegrationProcedureConnectPost.d.ts +25 -0
  41. package/dist/es/es2018/types/src/generated/adapters/postIntegrationProcedureExecute.d.ts +19 -0
  42. package/dist/es/es2018/types/src/generated/adapters/saveCustomLabel.d.ts +16 -0
  43. package/dist/es/es2018/types/src/generated/adapters/simulateDataraptor.d.ts +17 -0
  44. package/dist/es/es2018/types/src/generated/adapters/uploadDocument.d.ts +17 -0
  45. package/dist/es/es2018/types/src/generated/adapters/upsertDataraptor.d.ts +21 -0
  46. package/dist/es/es2018/types/src/generated/adapters/upsertOmniProcess.d.ts +34 -0
  47. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +43 -0
  48. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +68 -0
  49. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerCardByCardId.d.ts +16 -0
  50. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerDataraptorConfig.d.ts +19 -0
  51. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerDataraptorList.d.ts +16 -0
  52. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerDecisionMatrix.d.ts +12 -0
  53. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerDocumentMatrixDecisionTable.d.ts +12 -0
  54. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerDocusignTemplates.d.ts +12 -0
  55. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerEmailDocuments.d.ts +12 -0
  56. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerEmailTemplates.d.ts +12 -0
  57. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerEntityInfo.d.ts +16 -0
  58. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerExpressionGrammar.d.ts +15 -0
  59. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerGetCards.d.ts +17 -0
  60. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerGetFileCardByCardName.d.ts +15 -0
  61. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOmniProcessList.d.ts +17 -0
  62. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOmniprocessByOmniProcessId.d.ts +15 -0
  63. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFetchDesignerCustomizationByDesignerCustomizationType.d.ts +15 -0
  64. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFetchDesignerCustomizationElementWarningByDesignerCustomizationTypeAndOmniScriptId.d.ts +16 -0
  65. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFetchDesignerElementCustomizationByDesignerCustomizationTypeAndElementId.d.ts +16 -0
  66. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFetchDocusignTemplates.d.ts +12 -0
  67. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFetchDynamicElements.d.ts +12 -0
  68. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsFileBasedByOsName.d.ts +15 -0
  69. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsGetScripts.d.ts +12 -0
  70. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerOsNonOmniscriptLwc.d.ts +16 -0
  71. package/dist/es/es2018/types/src/generated/resources/getConnectOmniDesignerRecordByOmniProcessId.d.ts +15 -0
  72. package/dist/es/es2018/types/src/generated/resources/patchConnectOmniDesignerDataraptorSimulate.d.ts +14 -0
  73. package/dist/es/es2018/types/src/generated/resources/patchConnectOmniDesignerExecuteIp.d.ts +18 -0
  74. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerCardAddAttachment.d.ts +14 -0
  75. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerCloneOmniProcess.d.ts +13 -0
  76. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerGetEntityRecords.d.ts +18 -0
  77. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerInsertIpRecord.d.ts +22 -0
  78. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsBuildBusinessProcessDataJson.d.ts +15 -0
  79. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsBuildJson.d.ts +15 -0
  80. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsCloneOmniProcessElement.d.ts +13 -0
  81. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsDeleteOmniProcessElement.d.ts +13 -0
  82. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsDocument.d.ts +14 -0
  83. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsInsertOmniProcessElement.d.ts +20 -0
  84. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsMoveOmniProcessElement.d.ts +15 -0
  85. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerOsSaveCustomLabel.d.ts +13 -0
  86. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerUpsertDataraptor.d.ts +18 -0
  87. package/dist/es/es2018/types/src/generated/resources/postConnectOmniDesignerUpsertOmniProcess.d.ts +31 -0
  88. package/dist/es/es2018/types/src/generated/resources/postConnectOmniGlobalDataMapperActionsClearCache.d.ts +14 -0
  89. package/dist/es/es2018/types/src/generated/resources/postConnectOmniGlobalDataMapperExecuteByName.d.ts +19 -0
  90. package/dist/es/es2018/types/src/generated/resources/postConnectOmniGlobalIntegrationProcedureActionsClearCache.d.ts +16 -0
  91. package/dist/es/es2018/types/src/generated/resources/postConnectOmniGlobalIntegrationProcedureExecuteById.d.ts +18 -0
  92. package/dist/es/es2018/types/src/generated/types/BuildJsonInputRepresentation.d.ts +37 -0
  93. package/dist/es/es2018/types/src/generated/types/BuildJsonOutputRepresentation.d.ts +38 -0
  94. package/dist/es/es2018/types/src/generated/types/DataMapperExecutionInputDataRepresentationList.d.ts +28 -0
  95. package/dist/es/es2018/types/src/generated/types/DataMapperExecutionInputRepresentation.d.ts +35 -0
  96. package/dist/es/es2018/types/src/generated/types/DataMapperExecutionOptionsRepresentation.d.ts +49 -0
  97. package/dist/es/es2018/types/src/generated/types/DataMapperExecutionOutputRepresentation.d.ts +44 -0
  98. package/dist/es/es2018/types/src/generated/types/DataMapperListRepresentation.d.ts +29 -0
  99. package/dist/es/es2018/types/src/generated/types/DataMapperParamRepresentation.d.ts +31 -0
  100. package/dist/es/es2018/types/src/generated/types/DatamapperCacheInputParamRepresentation.d.ts +32 -0
  101. package/dist/es/es2018/types/src/generated/types/DatamapperClearCacheOutputRepresentation.d.ts +45 -0
  102. package/dist/es/es2018/types/src/generated/types/DatamapperClearCacheResponse.d.ts +31 -0
  103. package/dist/es/es2018/types/src/generated/types/DesignerCustomizationElementWarningOutputRepresentation.d.ts +33 -0
  104. package/dist/es/es2018/types/src/generated/types/DesignerCutomizationOutputRepresentation.d.ts +33 -0
  105. package/dist/es/es2018/types/src/generated/types/DocumentRepresentation.d.ts +37 -0
  106. package/dist/es/es2018/types/src/generated/types/DocusignTemplatesOutputRepresentation.d.ts +32 -0
  107. package/dist/es/es2018/types/src/generated/types/DynamicElementsOutputRepresentation.d.ts +33 -0
  108. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheInputData.d.ts +34 -0
  109. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheInputDataRepresentationList.d.ts +29 -0
  110. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheInputRepresentation.d.ts +35 -0
  111. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheKeysRepresentationList.d.ts +28 -0
  112. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheOutputRepresentation.d.ts +45 -0
  113. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureCacheResponse.d.ts +31 -0
  114. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureExecuteInputRepresentation.d.ts +42 -0
  115. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureExecuteOutputRepresentation.d.ts +38 -0
  116. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureRecordInputRepresentation.d.ts +54 -0
  117. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureRecordOutputRepresentation.d.ts +65 -0
  118. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureRecordOutputRepresentations.d.ts +56 -0
  119. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureRecordStepOutputRepresentation.d.ts +66 -0
  120. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureRecordStepParameterOutputRepresentation.d.ts +40 -0
  121. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureServiceRunInputRepresentation.d.ts +31 -0
  122. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureServiceRunInputRepresentationList.d.ts +28 -0
  123. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureServiceRunOptionsRepresentation.d.ts +46 -0
  124. package/dist/es/es2018/types/src/generated/types/IntegrationProcedureServiceRunOutputRepresentation.d.ts +44 -0
  125. package/dist/es/es2018/types/src/generated/types/NonOmniscriptComponentsOutputRepresentation.d.ts +33 -0
  126. package/dist/es/es2018/types/src/generated/types/OmniDesignerBusinessProcessDataJsonInputRepresentation.d.ts +35 -0
  127. package/dist/es/es2018/types/src/generated/types/OmniDesignerBusinessProcessDataJsonOutputRepresentation.d.ts +45 -0
  128. package/dist/es/es2018/types/src/generated/types/OmniDesignerCardDetailRepresentation.d.ts +61 -0
  129. package/dist/es/es2018/types/src/generated/types/OmniDesignerCardListRepresentation.d.ts +33 -0
  130. package/dist/es/es2018/types/src/generated/types/OmniDesignerDRDetailRepresentation.d.ts +37 -0
  131. package/dist/es/es2018/types/src/generated/types/OmniDesignerDRListRepresentation.d.ts +30 -0
  132. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorInfoRepresentation.d.ts +31 -0
  133. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorMappingItemInfoDetailRepresentation.d.ts +31 -0
  134. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorMappingItemInfoRepresentation.d.ts +32 -0
  135. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorRepresentation.d.ts +40 -0
  136. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorSimulateInputParamRepresentation.d.ts +31 -0
  137. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorSimulateInputRepresentation.d.ts +32 -0
  138. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorSimulateRepresentation.d.ts +41 -0
  139. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorUpsertInputRepresentation.d.ts +46 -0
  140. package/dist/es/es2018/types/src/generated/types/OmniDesignerDataraptorUpsertOutputRepresentation.d.ts +41 -0
  141. package/dist/es/es2018/types/src/generated/types/OmniDesignerDecisionMatrixDetailRepresentation.d.ts +31 -0
  142. package/dist/es/es2018/types/src/generated/types/OmniDesignerDecisionMatrixListRepresentation.d.ts +30 -0
  143. package/dist/es/es2018/types/src/generated/types/OmniDesignerDecisionTableDetailRepresentation.d.ts +31 -0
  144. package/dist/es/es2018/types/src/generated/types/OmniDesignerDecisionTableRepresentation.d.ts +30 -0
  145. package/dist/es/es2018/types/src/generated/types/OmniDesignerDocusignDetailRepresentation.d.ts +34 -0
  146. package/dist/es/es2018/types/src/generated/types/OmniDesignerDocusignListRepresentation.d.ts +30 -0
  147. package/dist/es/es2018/types/src/generated/types/OmniDesignerEmailDocumentListRepresentation.d.ts +30 -0
  148. package/dist/es/es2018/types/src/generated/types/OmniDesignerEmailDocumentRepresentation.d.ts +31 -0
  149. package/dist/es/es2018/types/src/generated/types/OmniDesignerEmailTemplateListRepresentation.d.ts +30 -0
  150. package/dist/es/es2018/types/src/generated/types/OmniDesignerEmailTemplateRepresentation.d.ts +28 -0
  151. package/dist/es/es2018/types/src/generated/types/OmniDesignerEntitiesInfoDetailRepresentation.d.ts +32 -0
  152. package/dist/es/es2018/types/src/generated/types/OmniDesignerEntityInfoDetailRepresentation.d.ts +31 -0
  153. package/dist/es/es2018/types/src/generated/types/OmniDesignerEntityInfoRepresentation.d.ts +33 -0
  154. package/dist/es/es2018/types/src/generated/types/OmniDesignerExpressionGrammarDetailRepresentation.d.ts +31 -0
  155. package/dist/es/es2018/types/src/generated/types/OmniDesignerExpressionGrammarRepresentation.d.ts +30 -0
  156. package/dist/es/es2018/types/src/generated/types/OmniDesignerFetchEntityRecordsInputRepresentation.d.ts +46 -0
  157. package/dist/es/es2018/types/src/generated/types/OmniDesignerFetchEntityRecordsOutputRepresentation.d.ts +41 -0
  158. package/dist/es/es2018/types/src/generated/types/OmniDesignerFileCardRepresentation.d.ts +59 -0
  159. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessDetailRepresentation.d.ts +67 -0
  160. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessListOutputRepresentation.d.ts +30 -0
  161. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessMoveElementRepresentation.d.ts +43 -0
  162. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessOutputRepresentation.d.ts +95 -0
  163. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessUpsertInputRepresentation.d.ts +85 -0
  164. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniProcessUpsertRepresentation.d.ts +38 -0
  165. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniScriptDetailRepresentation.d.ts +58 -0
  166. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniScriptListRepresentation.d.ts +30 -0
  167. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptCloneElementInputRepresentation.d.ts +31 -0
  168. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptCloneElementOutputRepresentation.d.ts +42 -0
  169. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptCustomLabelInputRepresentation.d.ts +34 -0
  170. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptCustomLabelListInputRepresentation.d.ts +29 -0
  171. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptCustomLabelOutputRepresentation.d.ts +38 -0
  172. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptDeleteElementInputRepresentation.d.ts +31 -0
  173. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptDeleteElementOutputRepresentation.d.ts +45 -0
  174. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptInsertElementInputRepresentation.d.ts +52 -0
  175. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptInsertElementOutputRepresentation.d.ts +42 -0
  176. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptMoveElementInputRepresentation.d.ts +37 -0
  177. package/dist/es/es2018/types/src/generated/types/OmniDesignerOmniscriptMoveElementOutputRepresentation.d.ts +42 -0
  178. package/dist/es/es2018/types/src/generated/types/OmniProcessCloneInputRepresentation.d.ts +31 -0
  179. package/dist/es/es2018/types/src/generated/types/OmniProcessCloneOutputRepresentation.d.ts +38 -0
  180. package/dist/es/es2018/types/src/generated/types/OmniProcessElementDeleteRepresentation.d.ts +40 -0
  181. package/dist/es/es2018/types/src/generated/types/OmniProcessElementDesignerCustomizationOutputRepresentation.d.ts +33 -0
  182. package/dist/es/es2018/types/src/generated/types/OmniProcessElementRepresentation.d.ts +76 -0
  183. package/dist/es/es2018/types/src/generated/types/OmniProcessInsertElementRepresentation.d.ts +52 -0
  184. package/dist/es/es2018/types/src/generated/types/OmniProcessRepresentation.d.ts +103 -0
  185. package/dist/es/es2018/types/src/generated/types/OmniUiCardAttachmentInputRepresentation.d.ts +34 -0
  186. package/dist/es/es2018/types/src/generated/types/OmniUiCardAttachmentRepresentation.d.ts +31 -0
  187. package/dist/es/es2018/types/src/generated/types/OmniUiCardAttachmentUpsertRepresentation.d.ts +38 -0
  188. package/dist/es/es2018/types/src/generated/types/OmniUiCardRepresentation.d.ts +72 -0
  189. package/dist/es/es2018/types/src/generated/types/OsFileOutputRepresentation.d.ts +34 -0
  190. package/dist/es/es2018/types/src/generated/types/UploadDocumentInputRepresentation.d.ts +34 -0
  191. package/dist/es/es2018/types/src/generated/types/UploadDocumentOutputRepresentation.d.ts +42 -0
  192. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  193. package/package.json +66 -0
  194. package/sfdc/index.d.ts +1 -0
  195. package/sfdc/index.js +15543 -0
  196. package/src/raml/api.raml +2612 -0
  197. package/src/raml/luvio.raml +351 -0
@@ -0,0 +1,2612 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '61.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ OmniDesignerEntitiesInfoDetailRepresentation:
29
+ description: List of enities
30
+ type: object
31
+ properties:
32
+ entityInfo:
33
+ description: Information about the entity as a List of name value pairs.
34
+ type: array
35
+ items:
36
+ type: OmniDesignerEntityInfoDetailRepresentation
37
+ entityName:
38
+ description: The name of the entity
39
+ type: string
40
+ OmniDesignerEntityInfoDetailRepresentation:
41
+ description: Information about an entity
42
+ type: object
43
+ properties:
44
+ entityInfoName:
45
+ description: The name of the property of the entity like the label
46
+ type: string
47
+ entityInfoValue:
48
+ description: The value of the property
49
+ type: string
50
+ OmniDesignerEntityInfoRepresentation:
51
+ description: Entity Info output
52
+ type: object
53
+ properties:
54
+ entitiesInfo:
55
+ description: A list of OmniDesignerEntityInfoDetailRepresentation
56
+ type: array
57
+ items:
58
+ type: OmniDesignerEntitiesInfoDetailRepresentation
59
+ queryMore:
60
+ description: A string in an internal format that should be returned by the
61
+ caller as is to fetch the next set of entities
62
+ type: string
63
+ required: false
64
+ OmniDesignerFileCardRepresentation:
65
+ description: Output representation for file based flexcard that contains user
66
+ specified search term in its name
67
+ type: object
68
+ properties:
69
+ authorName:
70
+ description: Name of author
71
+ type: string
72
+ required: false
73
+ dataSourceConfig:
74
+ description: Unique Name for the Overriden FlexCard
75
+ type: string
76
+ required: false
77
+ isActive:
78
+ description: If OmniUiCard is active or not.
79
+ type: boolean
80
+ name:
81
+ description: Name of card
82
+ type: string
83
+ required: false
84
+ omniUiCardType:
85
+ description: Type of Omni Ui Card
86
+ type: string
87
+ overrideKey:
88
+ description: Unique Name for the Overriden FlexCard
89
+ type: string
90
+ required: false
91
+ propertySetConfig:
92
+ description: Configuration of card
93
+ type: string
94
+ sampleDataSourceResponse:
95
+ description: Sample data source response for flexcard
96
+ type: string
97
+ required: false
98
+ uniqueName:
99
+ description: Unique Name for the Overriden FlexCard
100
+ type: string
101
+ versionNumber:
102
+ description: Version number of card
103
+ format: double
104
+ type: number
105
+ description:
106
+ description: Description of flexcard
107
+ type: string
108
+ required: false
109
+
110
+ OmniUiCardAttachmentInputRepresentation:
111
+ description: Input representation for assigning actionable List
112
+ type: object
113
+ properties:
114
+ attachmentContent:
115
+ description: content of attachment to be upserted
116
+ type: string
117
+ attachmentName:
118
+ description: Name of attachment to be upserted
119
+ type: string
120
+ cardId:
121
+ description: Id of card to which this attachment will be attached
122
+ type: string
123
+ OmniUiCardAttachmentUpsertRepresentation:
124
+ description: Upsert Attachment in OmniUiCard result representation.
125
+ type: object
126
+ properties:
127
+ attachmentId:
128
+ description: Id of upserted attachment
129
+ type: string
130
+ OmniUiCardAttachmentRepresentation:
131
+ description: Representation of attachment linked to certain OmniUiCard
132
+ type: object
133
+ properties:
134
+ id:
135
+ description: Id of attachment
136
+ type: string
137
+ parentId:
138
+ description: Parent id of attachment
139
+ type: string
140
+ OmniUiCardRepresentation:
141
+ description: Output representation for file based flexcard that contains user
142
+ specified search term in its name
143
+ type: object
144
+ properties:
145
+ attachments:
146
+ description: List of attachments attached to FlexCard
147
+ type: array
148
+ items:
149
+ type: OmniUiCardAttachmentRepresentation
150
+ authorName:
151
+ description: Name of author
152
+ type: string
153
+ dataSourceConfig:
154
+ description: Unique Name for the Overriden FlexCard
155
+ type: string
156
+ id:
157
+ description: Id of card
158
+ type: string
159
+ isActive:
160
+ description: If card is active or not
161
+ type: boolean
162
+ lastModifiedDate:
163
+ description: Unique Name for the Overriden FlexCard
164
+ type: string
165
+ name:
166
+ description: Name of author
167
+ type: string
168
+ omniUiCardKey:
169
+ description: The unique identifier of a Omni UI Card version.
170
+ type: string
171
+ omniUiCardType:
172
+ description: Type of Omni Ui Card
173
+ type: string
174
+ propertySetConfig:
175
+ description: Configuration of card
176
+ type: string
177
+ stylingConfiguration:
178
+ description: Styling Configuration of OmniUiCard
179
+ type: string
180
+ versionNumber:
181
+ description: Version number of card
182
+ format: double
183
+ type: number
184
+ OmniDesignerDRListRepresentation:
185
+ description: Dataraptor Outpur in List Representation
186
+ type: object
187
+ properties:
188
+ omniDesignerDRList:
189
+ description: Representation of the DataRaptor as a list.
190
+ type: array
191
+ items:
192
+ type: OmniDesignerDRDetailRepresentation
193
+ OmniDesignerDataraptorInfoRepresentation:
194
+ description: Data raptor property as a name value pair
195
+ type: object
196
+ properties:
197
+ dataraptorProperty:
198
+ description: 'Represents the name of an overall property of a dataraptor like
199
+ Type, InputType etc. '
200
+ type: string
201
+ value:
202
+ description: The value of the property
203
+ type: string
204
+ OmniDesignerDataraptorMappingItemInfoDetailRepresentation:
205
+ description: Represents a dataraptor mapping property
206
+ type: object
207
+ properties:
208
+ mappingName:
209
+ description: The name of the data raptor designer mapping item parameter
210
+ type: string
211
+ mappingValue:
212
+ description: The value of the mapped parameter
213
+ type: string
214
+ OmniDesignerDataraptorMappingItemInfoRepresentation:
215
+ description: Represents a dataraptor mapping
216
+ type: object
217
+ properties:
218
+ mappingItemParams:
219
+ description: The data raptor designer mapping item as a list of name value
220
+ pairs
221
+ type: array
222
+ required: false
223
+ items:
224
+ type: OmniDesignerDataraptorMappingItemInfoDetailRepresentation
225
+ omniDataTransformItemId:
226
+ description: The record Id of the OmniDataTransformItem if it is db based
227
+ type: string
228
+ required: false
229
+ OmniDesignerDataraptorRepresentation:
230
+ description: Dataraptor representation
231
+ type: object
232
+ properties:
233
+ dataraptorInfo:
234
+ description: The overall properties of a dataraptor as a list
235
+ type: array
236
+ required: false
237
+ items:
238
+ type: OmniDesignerDataraptorInfoRepresentation
239
+ mappingInfo:
240
+ description: The mapped properties of a dataraptor
241
+ type: array
242
+ required: false
243
+ items:
244
+ type: OmniDesignerDataraptorMappingItemInfoRepresentation
245
+ name:
246
+ description: The data raptor name
247
+ type: string
248
+ omniDataTransformationId:
249
+ description: The record Id of the OmniDataTransformation if it is db based
250
+ type: string
251
+ required: false
252
+ OmniDesignerDRDetailRepresentation:
253
+ description: Dataraptor Outpur Representation
254
+ type: object
255
+ properties:
256
+ id:
257
+ description: Record Id of Dataraptor
258
+ type: string
259
+ isActive:
260
+ description: Active/Deactive status of Dataraptor
261
+ type: string
262
+ name:
263
+ description: Name of the Dataraptor
264
+ type: string
265
+ versionNumber:
266
+ description: Version Number of Dataraptor
267
+ type: string
268
+ OmniDesignerDecisionMatrixDetailRepresentation:
269
+ description: Decision Matrix Detail Output Representation
270
+ type: object
271
+ properties:
272
+ id:
273
+ description: Id of the Decision Matrix
274
+ type: string
275
+ required: false
276
+ name:
277
+ description: Name of the Decision Matrix
278
+ type: string
279
+ required: false
280
+ OmniDesignerDecisionMatrixListRepresentation:
281
+ description: Deciison Matrix List Output Representation
282
+ type: object
283
+ properties:
284
+ decisionMatrixList:
285
+ description: Represents a Decision Matrix as a List
286
+ type: array
287
+ required: false
288
+ items:
289
+ type: OmniDesignerDecisionMatrixDetailRepresentation
290
+ OmniDesignerDocusignDetailRepresentation:
291
+ description: Docusign Template Output Representation
292
+ type: object
293
+ properties:
294
+ name:
295
+ description: The name of the Docusign Template
296
+ type: string
297
+ required: false
298
+ recipientList:
299
+ description: The list of Docusign recipient of the template
300
+ type: string
301
+ required: false
302
+ templateIdentifier:
303
+ description: Template Identifier Stored for Docusign Template
304
+ type: string
305
+ required: false
306
+ OmniDesignerDocusignListRepresentation:
307
+ description: DocuSign Template Output Representation
308
+ type: object
309
+ properties:
310
+ docusignList:
311
+ description: Representation of the Docusign template as a list.
312
+ type: array
313
+ required: false
314
+ items:
315
+ type: OmniDesignerDocusignDetailRepresentation
316
+ OmniDesignerEmailDocumentListRepresentation:
317
+ description: Emails Document Output List Representation
318
+ type: object
319
+ properties:
320
+ emailDocumentsList:
321
+ description: Representation of the Email Documents as a list.
322
+ type: array
323
+ required: false
324
+ items:
325
+ type: OmniDesignerEmailDocumentRepresentation
326
+ OmniDesignerEmailDocumentRepresentation:
327
+ description: Email Document Output Representation
328
+ type: object
329
+ properties:
330
+ developerName:
331
+ description: Name of the Email Documents
332
+ type: string
333
+ required: false
334
+ id:
335
+ description: Id of the Email Documents
336
+ type: string
337
+ required: false
338
+ OmniDesignerOmniProcessDetailRepresentation:
339
+ description: OmniProcess Detail Output Representation
340
+ type: object
341
+ properties:
342
+ createdById:
343
+ description: The CreatedBy Name of OmniProcess
344
+ type: string
345
+ required: false
346
+ createdByName:
347
+ description: OmniProcess Created by the user
348
+ type: string
349
+ createdDate:
350
+ description: The CreatedDate of OmniProcess
351
+ type: string
352
+ description:
353
+ description: The Description for the OmniProcess
354
+ type: string
355
+ id:
356
+ description: The Record Id of OmniProcess
357
+ type: string
358
+ isActive:
359
+ description: To Identify if OmniProcess is Active or InActive
360
+ type: boolean
361
+ isTestProcedure:
362
+ description: Boolean value to store if OmniProcess is Test Procedure or not
363
+ type: boolean
364
+ lastModifiedById:
365
+ description: The LastModifiedBy UserID of OmniProcess
366
+ type: string
367
+ lastModifiedByName:
368
+ description: OmniProcess last modified by the user
369
+ type: string
370
+ lastModifiedDate:
371
+ description: The LastModifiedDate of OmniProcess
372
+ type: string
373
+ name:
374
+ description: The Name of the OmniProcess
375
+ type: string
376
+ subType:
377
+ description: The SubType of OmniProcess
378
+ type: string
379
+ type:
380
+ description: The Type of OmniProcess
381
+ type: string
382
+ versionNumber:
383
+ description: The VersionNumber of OmniProcess
384
+ type: string
385
+ OmniDesignerOmniProcessListOutputRepresentation:
386
+ description: Output representation of OmniProcess List
387
+ type: object
388
+ properties:
389
+ omniProcessList:
390
+ description: Representation of the OmniProcess as a list
391
+ type: array
392
+ items:
393
+ type: OmniDesignerOmniProcessDetailRepresentation
394
+ OmniDesignerOmniProcessOutputRepresentation:
395
+ description: Output representation of OmniProcess
396
+ type: object
397
+ properties:
398
+ createdById:
399
+ description: The CreatedBy Name of OmniProcess
400
+ type: string
401
+ required: false
402
+ createdByName:
403
+ description: OmniProcess Created by the user
404
+ type: string
405
+ createdDate:
406
+ description: The CreatedDate of OmniProcess
407
+ type: string
408
+ customHtmlTemplates:
409
+ description: The Custom HTML stored for Integration Procedure
410
+ type: string
411
+ required: false
412
+ customJavaScript:
413
+ description: The Custom Javascript Code stored for Integration Procedure
414
+ type: string
415
+ required: false
416
+ description:
417
+ description: The Description for an Integration Procedure
418
+ type: string
419
+ required: false
420
+ id:
421
+ description: The RecordId of an OmniProcess
422
+ type: string
423
+ required: false
424
+ isActive:
425
+ description: To Identify that if an Integration Procedure is Active or Inactive
426
+ type: boolean
427
+ required: false
428
+ isIntegrationProcedure:
429
+ description: The BooleanValue for Type of OmniProcess Record. I.e OmniScript
430
+ / Integration Procedure
431
+ type: boolean
432
+ isMetadataCacheDisabled:
433
+ description: This is Used for disabling/enabling Metadata Cache
434
+ type: boolean
435
+ required: false
436
+ isOmniScriptEmbeddable:
437
+ description: Field used for Reusable OmniProcess
438
+ type: string
439
+ required: false
440
+ isTestProcedure:
441
+ description: The Boolean value to identify if IP is Test Procedure or not
442
+ type: boolean
443
+ required: false
444
+ isWebCompEnabled:
445
+ description: This is Used for OmniProcess record is LWC enabled/disabled
446
+ type: boolean
447
+ language:
448
+ description: The Language Store In Integration Procedure
449
+ type: string
450
+ required: false
451
+ lastModifiedById:
452
+ description: The LastModifiedBy UserID of OmniProcess
453
+ type: string
454
+ lastModifiedByName:
455
+ description: OmniProcess last modified by the user
456
+ type: string
457
+ lastModifiedDate:
458
+ description: The LastModifiedDate of OmniProcess
459
+ type: string
460
+ name:
461
+ description: Name of the OmniProcess
462
+ type: string
463
+ required: false
464
+ propertySetConfig:
465
+ description: The Configuration Values stored for an Integration Procedure
466
+ type: string
467
+ required: false
468
+ responseCacheType:
469
+ description: This is Used for storing type of Response Cache
470
+ type: string
471
+ required: false
472
+ subType:
473
+ description: The SubType of Integration Procedure
474
+ type: string
475
+ required: false
476
+ type:
477
+ description: The Type of Integration Procedure
478
+ type: string
479
+ required: false
480
+ versionNumber:
481
+ description: The Version Number of Integration Procedure
482
+ type: string
483
+ required: false
484
+ OmniDesignerOmniProcessUpsertInputRepresentation:
485
+ description: Input representation for OmniProcess
486
+ type: object
487
+ properties:
488
+ customHtmlTemplates:
489
+ description: Custom html store for Omniprocess
490
+ type: string
491
+ required: false
492
+ customJavaScript:
493
+ description: Custom Javascript code store for Omniprocess
494
+ type: string
495
+ required: false
496
+ description:
497
+ description: Description for the Omniprocess
498
+ type: string
499
+ required: false
500
+ isActive:
501
+ description: Identify that Omniprocess is Active/Deactive
502
+ type: boolean
503
+ required: false
504
+ isIntegrationProcedure:
505
+ description: Boolean value of Type of OmniProcess
506
+ type: boolean
507
+ required: false
508
+ isMetadataCacheDisabled:
509
+ description: Used for diablind/enabling Metadata Cache
510
+ type: boolean
511
+ required: false
512
+ isOmniScriptEmbeddable:
513
+ description: Field used for Reusable OmniProcess
514
+ type: boolean
515
+ required: false
516
+ isTestProcedure:
517
+ description: Boolean value for test procedure
518
+ type: boolean
519
+ required: false
520
+ isWebCompEnabled:
521
+ description: Used for Omprocess record is LWC enabled/disabled
522
+ type: boolean
523
+ required: false
524
+ language:
525
+ description: Language of Omniprocess
526
+ type: string
527
+ required: false
528
+ lastPreviewPage:
529
+ description: Last Preview Page for Integration Procedure
530
+ type: string
531
+ required: false
532
+ name:
533
+ description: Name of the Omniprocess being updated
534
+ type: string
535
+ required: false
536
+ omniProcessId:
537
+ description: OmniProcessId is Id of Omniprocess
538
+ type: string
539
+ required: false
540
+ omniProcessType:
541
+ description: Type of the Omniprocess being updated
542
+ type: string
543
+ required: false
544
+ propertySetConfig:
545
+ description: Configuration Value store for Omniprocess
546
+ type: string
547
+ required: false
548
+ requiredPermission:
549
+ description: Used for requierd permission store for Omniprocess
550
+ type: string
551
+ required: false
552
+ responseCacheType:
553
+ description: Used for storing type for Response Cache
554
+ type: string
555
+ required: false
556
+ subType:
557
+ description: SubType of Omniprocess
558
+ type: string
559
+ required: false
560
+ type:
561
+ description: Type of Omniprocess
562
+ type: string
563
+ required: false
564
+ versionNumber:
565
+ description: Version Number of Omniprocess
566
+ type: string
567
+ required: false
568
+ OmniDesignerOmniProcessUpsertRepresentation:
569
+ description: Output representation for OmniProcess
570
+ type: object
571
+ properties:
572
+ omniProcessId:
573
+ description: A unique identifier for the Omniprocess
574
+ type: string
575
+ OmniDesignerDataraptorUpsertInputRepresentation:
576
+ description: Input representation of upserting a dataraptor
577
+ type: object
578
+ properties:
579
+ expectedInputJson:
580
+ description: Expected Input Json to store on Dataraptor
581
+ type: string
582
+ required: false
583
+ inputType:
584
+ description: Input Type of Dataraptor store here
585
+ type: string
586
+ name:
587
+ description: Name of the Datarapor being updated
588
+ type: string
589
+ outputType:
590
+ description: Output Type of Dataraptor store here
591
+ type: string
592
+ sourceObject:
593
+ description: Source Object of Dataraptor store here
594
+ type: string
595
+ required: false
596
+ type:
597
+ description: Type of Omniprocess
598
+ type: string
599
+ xmlOutputTagsOrder:
600
+ description: Xml output order of Dataraptor store here
601
+ type: string
602
+ required: false
603
+ OmniDesignerDataraptorUpsertOutputRepresentation:
604
+ description: Output representation of Dataraptor
605
+ type: object
606
+ properties:
607
+ id:
608
+ description: A unique identifier for the dataraptor
609
+ type: string
610
+ name:
611
+ description: A name of the dataraptor
612
+ type: string
613
+ BuildJsonInputRepresentation:
614
+ description: Input representation for building JSON v3
615
+ type: object
616
+ properties:
617
+ bPreview:
618
+ description: bPreview
619
+ type: boolean
620
+ multiLangCode:
621
+ description: multiLangCode
622
+ # TODO hand rolled. W-14995636. Hand Rolled Change
623
+ type: string | nil
624
+ required: false
625
+ sId:
626
+ description: sId
627
+ type: string
628
+ scriptState:
629
+ description: scriptState
630
+ type: string
631
+ BuildJsonOutputRepresentation:
632
+ description: Output representation of building json
633
+ type: object
634
+ properties:
635
+ result:
636
+ description: result
637
+ type: string
638
+ DesignerCutomizationOutputRepresentation:
639
+ description: Output representation of designer customization
640
+ type: object
641
+ properties:
642
+ results:
643
+ description: results
644
+ type: object
645
+ properties:
646
+ //:
647
+ type: any #Handrolled
648
+ DocumentRepresentation:
649
+ description: Output representation of moving an element in Omni-Script
650
+ type: object
651
+ properties:
652
+ developerName:
653
+ description: developerName
654
+ # TODO hand rolled. W-14995636. Hand Rolled Change
655
+ type: string | nil
656
+ required: false
657
+ id:
658
+ description: id
659
+ # TODO hand rolled. W-14995636. Hand Rolled Change
660
+ type: string | nil
661
+ required: false
662
+ name:
663
+ description: name
664
+ # TODO hand rolled. W-14995636. Hand Rolled Change
665
+ type: string | nil
666
+ required: false
667
+ type:
668
+ description: type
669
+ # TODO hand rolled. W-14995636. Hand Rolled Change
670
+ type: string | nil
671
+ required: false
672
+ DocusignTemplatesOutputRepresentation:
673
+ description: Output representation of fetching Docusign templates
674
+ type: object
675
+ properties:
676
+ message:
677
+ description: message
678
+ type: string
679
+ statusCode:
680
+ description: statusCode
681
+ type: string
682
+ DynamicElementsOutputRepresentation:
683
+ description: Output representation of fetching dynamic elements
684
+ type: object
685
+ properties:
686
+ results:
687
+ description: results
688
+ type: array
689
+ items:
690
+ type: object
691
+ properties:
692
+ //:
693
+ type: any #Handrolled
694
+ NonOmniscriptComponentsOutputRepresentation:
695
+ description: Output representation of non omniscript components
696
+ type: object
697
+ properties:
698
+ results:
699
+ description: results
700
+ type: array
701
+ items:
702
+ type: object
703
+ properties:
704
+ //:
705
+ type: any #Handrolled
706
+ OmniDesignerOmniProcessMoveElementRepresentation:
707
+ description: Output representation of moving an element in Omni-Script
708
+ type: object
709
+ properties:
710
+ id:
711
+ description: id
712
+ # TODO hand rolled. W-14995636. Hand Rolled Change
713
+ type: string | nil
714
+ required: false
715
+ level:
716
+ description: level
717
+ # TODO hand rolled. W-14995636. Hand Rolled Change
718
+ type: integer | nil
719
+ required: false
720
+ name:
721
+ description: name
722
+ type: string
723
+ omniProcessId:
724
+ description: omniProcess Id
725
+ # TODO hand rolled. W-14995636. Hand Rolled Change
726
+ type: string | nil
727
+ required: false
728
+ parentElementId:
729
+ description: parentElementId
730
+ # TODO hand rolled. W-14995636. Hand Rolled Change
731
+ type: string | nil
732
+ required: false
733
+ sequenceNumber:
734
+ description: sequenceNumber
735
+ # TODO hand rolled. W-14995636. Hand Rolled Change
736
+ type: integer | nil
737
+ required: false
738
+ OmniDesignerOmniscriptCloneElementInputRepresentation:
739
+ description: Input representation for cloning omni process element
740
+ type: object
741
+ properties:
742
+ elementName:
743
+ description: element name
744
+ type: string
745
+ omniscriptId:
746
+ description: omni-script Id
747
+ type: string
748
+ OmniDesignerOmniscriptCloneElementOutputRepresentation:
749
+ description: Output representation of cloning an element in Omni-Script
750
+ type: object
751
+ properties:
752
+ name:
753
+ description: name
754
+ type: string
755
+ results:
756
+ description: results
757
+ type: array
758
+ items:
759
+ type: OmniProcessInsertElementRepresentation
760
+ OmniDesignerOmniscriptCustomLabelInputRepresentation:
761
+ description: Input representation for saving a custom label
762
+ type: object
763
+ properties:
764
+ languageCode:
765
+ description: Custom Label language code
766
+ type: string
767
+ name:
768
+ description: Custom Label name
769
+ type: string
770
+ value:
771
+ description: Custom Label value
772
+ type: string
773
+ OmniDesignerOmniscriptCustomLabelListInputRepresentation:
774
+ description: List Input representation for saving a custom label
775
+ type: object
776
+ properties:
777
+ customLabels:
778
+ description: Custom Label name
779
+ type: array
780
+ items:
781
+ type: OmniDesignerOmniscriptCustomLabelInputRepresentation
782
+ OmniDesignerOmniscriptCustomLabelOutputRepresentation:
783
+ description: Output representation of saving custom label in Omniscript
784
+ type: object
785
+ properties:
786
+ externalId:
787
+ description: externalId
788
+ type: string
789
+ OmniDesignerOmniscriptInsertElementInputRepresentation:
790
+ description: Input representation for inserting omni process element.
791
+ type: object
792
+ properties:
793
+ customLwcName:
794
+ description: customLwcName
795
+ # TODO hand rolled. W-14995636. Hand Rolled Change
796
+ type: string | nil
797
+ required: false
798
+ designerElementName:
799
+ description: designerElementName
800
+ # TODO hand rolled. W-14995636. Hand Rolled Change
801
+ type: string | nil
802
+ required: false
803
+ isCancelAction:
804
+ description: cancel Action
805
+ type: boolean
806
+ name:
807
+ description: name
808
+ type: string
809
+ omniscriptId:
810
+ description: omni-script Id
811
+ type: string
812
+ order:
813
+ description: order
814
+ type: integer
815
+ parentElementId:
816
+ description: parentElementId
817
+ # TODO hand rolled. W-14995636. Hand Rolled Change
818
+ type: string | nil
819
+ type:
820
+ description: type
821
+ type: string
822
+ width:
823
+ description: width
824
+ type: integer
825
+ OmniDesignerOmniscriptInsertElementOutputRepresentation:
826
+ description: Output representation for inserting an element in Omni-Script
827
+ type: object
828
+ properties:
829
+ name:
830
+ description: name
831
+ # TODO hand rolled. W-14995636. Hand Rolled Change
832
+ type: string | nil
833
+ result:
834
+ description: result
835
+ type: array
836
+ items:
837
+ type: OmniProcessInsertElementRepresentation
838
+ OmniDesignerOmniscriptMoveElementInputRepresentation:
839
+ description: Input representation for moving omni process element
840
+ type: object
841
+ properties:
842
+ elementId:
843
+ description: element Id
844
+ type: string
845
+ omniscriptId:
846
+ description: omni-script Id
847
+ type: string
848
+ order:
849
+ description: order
850
+ type: integer
851
+ parentElementId:
852
+ description: parent element Id
853
+ # TODO hand rolled. W-14995636. Hand Rolled Change
854
+ type: string | nil
855
+ required: false
856
+ OmniDesignerOmniscriptMoveElementOutputRepresentation:
857
+ description: Output representation of moving an element in Omni-Script
858
+ type: object
859
+ properties:
860
+ elementName:
861
+ description: element Name
862
+ # TODO hand rolled. W-14995636. Hand Rolled Change
863
+ type: string | nil
864
+ results:
865
+ description: result
866
+ type: array
867
+ items:
868
+ type: OmniDesignerOmniProcessMoveElementRepresentation
869
+ OmniProcessInsertElementRepresentation:
870
+ description: Output representation of moving an element in Omni-Script
871
+ type: object
872
+ properties:
873
+ id:
874
+ description: id
875
+ # TODO hand rolled. W-14995636. Hand Rolled Change
876
+ type: string | nil
877
+ required: false
878
+ isActive:
879
+ description: isActive
880
+ # TODO hand rolled. W-14995636. Hand Rolled Change
881
+ type: boolean | nil
882
+ required: false
883
+ level:
884
+ description: level
885
+ # TODO hand rolled. W-14995636. Hand Rolled Change
886
+ type: integer | nil
887
+ required: false
888
+ name:
889
+ description: name
890
+ # TODO hand rolled. W-14995636. Hand Rolled Change
891
+ type: string | nil
892
+ required: false
893
+ omniProcessId:
894
+ description: omniProcess Id
895
+ # TODO hand rolled. W-14995636. Hand Rolled Change
896
+ type: string | nil
897
+ required: false
898
+ parentElementId:
899
+ description: parentElementId
900
+ # TODO hand rolled. W-14995636. Hand Rolled Change
901
+ type: string | nil
902
+ required: false
903
+ propertySetConfig:
904
+ description: propertySet Config
905
+ # TODO hand rolled. W-14995636. Hand Rolled Change
906
+ type: string | nil
907
+ required: false
908
+ sequenceNumber:
909
+ description: sequenceNumber
910
+ # TODO hand rolled. W-14995636. Hand Rolled Change
911
+ type: integer | nil
912
+ required: false
913
+ type:
914
+ description: type
915
+ # TODO hand rolled. W-14995636. Hand Rolled Change
916
+ type: string | nil
917
+ required: false
918
+ OmniDesignerOmniscriptDeleteElementInputRepresentation:
919
+ description: Input representation for deleting omni process element
920
+ type: object
921
+ properties:
922
+ elementName:
923
+ description: element name
924
+ type: string
925
+ omniscriptId:
926
+ description: omni-script Id
927
+ type: string
928
+ OmniDesignerOmniscriptDeleteElementOutputRepresentation:
929
+ description: Output representation of deleting an element in Omni-Script
930
+ type: object
931
+ properties:
932
+ deleted:
933
+ description: deleted
934
+ type: array
935
+ items:
936
+ type: OmniProcessElementDeleteRepresentation
937
+ name:
938
+ description: name
939
+ type: string
940
+ updated:
941
+ description: updated
942
+ type: array
943
+ items:
944
+ type: OmniProcessElementDeleteRepresentation
945
+ OmniProcessElementDeleteRepresentation:
946
+ description: Output representation of deleting an element in Omni-Script
947
+ type: object
948
+ properties:
949
+ id:
950
+ description: Id
951
+ # TODO hand rolled. W-14995636. Hand Rolled Change
952
+ type: string | nil
953
+ required: false
954
+ name:
955
+ description: Name
956
+ # TODO hand rolled. W-14995636. Hand Rolled Change
957
+ type: string | nil
958
+ required: false
959
+ omniProcessId:
960
+ description: omniProcess Id
961
+ type: string
962
+ parentElementId:
963
+ description: parentElement Id
964
+ # TODO hand rolled. W-14995636. Hand Rolled Change
965
+ type: string | nil
966
+ required: false
967
+ sequenceNumber:
968
+ description: sequenceNumber
969
+ # TODO hand rolled. W-14995636. Hand Rolled Change
970
+ type: integer | nil
971
+ required: false
972
+ OmniProcessElementDesignerCustomizationOutputRepresentation:
973
+ description: Output representation of designer customization element leve
974
+ type: object
975
+ properties:
976
+ results:
977
+ description: results
978
+ type: object
979
+ properties:
980
+ //:
981
+ type: any #Handrolled
982
+ UploadDocumentInputRepresentation:
983
+ description: Input representation for uploading Document
984
+ type: object
985
+ properties:
986
+ encBody:
987
+ description: encBody
988
+ type: string
989
+ name:
990
+ description: name
991
+ type: string
992
+ type:
993
+ description: type
994
+ type: string
995
+ UploadDocumentOutputRepresentation:
996
+ description: Output representation of uploading document
997
+ type: object
998
+ properties:
999
+ documents:
1000
+ description: documents
1001
+ type: array
1002
+ items:
1003
+ type: DocumentRepresentation
1004
+ name:
1005
+ description: name
1006
+ type: string
1007
+ IntegrationProcedureRecordOutputRepresentations:
1008
+ description: Output Representation of Integration Procedure Record
1009
+ type: object
1010
+ properties:
1011
+ apiName:
1012
+ description: The unique name of Integration Procedure record
1013
+ type: string
1014
+ attributes:
1015
+ description: The attributes of Integration Procedure record
1016
+ type: object
1017
+ properties:
1018
+ //:
1019
+ type: any
1020
+ description:
1021
+ description: The description of Integration Procedure record
1022
+ type: string
1023
+ id:
1024
+ description: The id of Integration Procedure record
1025
+ type: string
1026
+ name:
1027
+ description: The name of Integration Procedure record
1028
+ type: string
1029
+ status:
1030
+ description: The status of Integration Procedure record
1031
+ type: boolean
1032
+ steps:
1033
+ description: The steps of Integration Procedure record
1034
+ type: object
1035
+ properties:
1036
+ //:
1037
+ type: IntegrationProcedureRecordStepOutputRepresentation
1038
+ IntegrationProcedureRecordOutputRepresentation:
1039
+ description: Output Representation of Integration Procedure Record
1040
+ type: object
1041
+ properties:
1042
+ apiName:
1043
+ description: The unique name of Integration Procedure record
1044
+ type: string
1045
+ attributes:
1046
+ description: The attributes of Integration Procedure record
1047
+ type: object
1048
+ properties:
1049
+ //:
1050
+ type: any
1051
+ description:
1052
+ description: The description of Integration Procedure record
1053
+ type: string
1054
+ id:
1055
+ description: The id of Integration Procedure record
1056
+ type: string
1057
+ name:
1058
+ description: The name of Integration Procedure record
1059
+ type: string
1060
+ status:
1061
+ description: The status of Integration Procedure record
1062
+ type: boolean
1063
+ steps:
1064
+ description: The steps of Integration Procedure record
1065
+ type: object
1066
+ properties:
1067
+ //:
1068
+ type: IntegrationProcedureRecordStepOutputRepresentation
1069
+ IntegrationProcedureRecordStepOutputRepresentation:
1070
+ description: Output Representation of Step in Integration Procedure Record
1071
+ type: object
1072
+ properties:
1073
+ apiName:
1074
+ description: The unique name of step
1075
+ type: string
1076
+ attributes:
1077
+ description: Attributes of step
1078
+ type: object
1079
+ properties:
1080
+ //:
1081
+ type: any
1082
+ description:
1083
+ description: The description of step
1084
+ type: string
1085
+ id:
1086
+ description: Specifies the id of step
1087
+ type: string
1088
+ isActive:
1089
+ description: To Identify that if an Element is Active or Inactive
1090
+ type: boolean
1091
+ required: false
1092
+ level:
1093
+ description: The level number of this step
1094
+ type: integer
1095
+ name:
1096
+ description: The name of step
1097
+ type: string
1098
+ parameters:
1099
+ description: Parameters of step
1100
+ type: array
1101
+ items:
1102
+ type: IntegrationProcedureRecordStepParameterOutputRepresentation
1103
+ parentStep:
1104
+ description: The unique name of parent step of this step
1105
+ type: string
1106
+ sequenceNumber:
1107
+ description: The sequence number of this step
1108
+ type: integer
1109
+ stepType:
1110
+ description: Specifies the type of step
1111
+ type: string
1112
+ type:
1113
+ description: Specifies the type of element
1114
+ type: string
1115
+ IntegrationProcedureRecordStepParameterOutputRepresentation:
1116
+ description: Output Representation of Parameter in the Step of Integration Procedure
1117
+ Record
1118
+ type: object
1119
+ properties:
1120
+ input:
1121
+ description: Whether the step parameter is input or not
1122
+ type: boolean
1123
+ name:
1124
+ description: Step parameter name
1125
+ type: string
1126
+ output:
1127
+ description: Whether the step parameter is output or not
1128
+ type: boolean
1129
+ type:
1130
+ description: Type of the step parameter
1131
+ type: string
1132
+ value:
1133
+ description: Step parameter value
1134
+ type: string
1135
+ IntegrationProcedureRecordInputRepresentation:
1136
+ description: Input Representation of Integration Procedure Record
1137
+ type: object
1138
+ properties:
1139
+ apiName:
1140
+ description: The unique name of Integration Procedure record
1141
+ type: string
1142
+ attributes:
1143
+ description: Attributes of Integration Procedure record
1144
+ type: object
1145
+ properties:
1146
+ //:
1147
+ type: any
1148
+ description:
1149
+ description: The description of Integration Procedure record
1150
+ type: string
1151
+ id:
1152
+ description: The id of Integration Procedure record
1153
+ type: string
1154
+ name:
1155
+ description: The name of Integration Procedure record
1156
+ type: string
1157
+ status:
1158
+ description: The status of Integration Procedure record
1159
+ type: boolean
1160
+ steps:
1161
+ description: Steps of Integration Procedure record
1162
+ type: object
1163
+ properties:
1164
+ //:
1165
+ type: any
1166
+ OmniDesignerExpressionGrammarDetailRepresentation:
1167
+ description: Expression Grammar element
1168
+ type: object
1169
+ properties:
1170
+ elementType:
1171
+ description: The type of expression grammar element
1172
+ type: string
1173
+ value:
1174
+ description: The value of the element type. For example, if the elementType
1175
+ is a function, the value can be the name of a function like SECOND.
1176
+ type: string
1177
+ OmniDesignerExpressionGrammarRepresentation:
1178
+ description: Expression Grammar
1179
+ type: object
1180
+ properties:
1181
+ exprGrammarElements:
1182
+ description: The list of expression grammar elements
1183
+ type: array
1184
+ items:
1185
+ type: OmniDesignerExpressionGrammarDetailRepresentation
1186
+ OmniDesignerDataraptorSimulateInputParamRepresentation:
1187
+ description: Dataraptor Simulation Input Parameters Representation
1188
+ type: object
1189
+ properties:
1190
+ simulationParamName:
1191
+ description: The name of the Simulation parameter
1192
+ type: string
1193
+ simulationParamValue:
1194
+ description: The value of the Simulation parameter
1195
+ type: string
1196
+ OmniDesignerDataraptorSimulateInputRepresentation:
1197
+ description: Dataraptor Simulation Input Representation
1198
+ type: object
1199
+ properties:
1200
+ name:
1201
+ description: The name of the data raptor to simulate
1202
+ type: string
1203
+ simulationParams:
1204
+ description: The list of simulation params
1205
+ type: array
1206
+ items:
1207
+ type: OmniDesignerDataraptorSimulateInputParamRepresentation
1208
+ OmniDesignerDataraptorSimulateRepresentation:
1209
+ description: Dataraptor Simulation Output Representation
1210
+ type: object
1211
+ properties:
1212
+ name:
1213
+ description: The name of the dataraptor
1214
+ type: string
1215
+ result:
1216
+ description: The result of simulation as a json string
1217
+ type: string
1218
+ OmniDesignerFetchEntityRecordsInputRepresentation:
1219
+ description: Input representation for Common GetEntityRecords Api
1220
+ type: object
1221
+ properties:
1222
+ entityName:
1223
+ description: Name of entity whose records are requested by user
1224
+ type: string
1225
+ fields:
1226
+ description: 'list of fields to be fetched '
1227
+ type: array
1228
+ items:
1229
+ type: string
1230
+ filterExpression:
1231
+ description: Expression to decide how filters in list are combined with each
1232
+ other
1233
+ type: string
1234
+ required: false
1235
+ filters:
1236
+ description: List of filter clause to be applied while fetching records
1237
+ type: array
1238
+ required: false
1239
+ items:
1240
+ type: any
1241
+ nextPageCursor:
1242
+ description: cursor for next page
1243
+ required: false
1244
+ type: string
1245
+ orderBy:
1246
+ description: order by clause list
1247
+ type: array
1248
+ required: false
1249
+ items:
1250
+ type: any
1251
+ pageSize:
1252
+ description: Number of records to be returned
1253
+ required: false
1254
+ type: integer
1255
+ OmniDesignerFetchEntityRecordsOutputRepresentation:
1256
+ description: Output representation for entity records needed for omni designer but not accessible via UIAPI
1257
+ type: object
1258
+ properties:
1259
+ nextPageToken:
1260
+ description: Next page cursor to fetch next page of records
1261
+ type: string
1262
+ records:
1263
+ description: List of records
1264
+ type: array
1265
+ items:
1266
+ type: any
1267
+ OmniDesignerCardDetailRepresentation:
1268
+ description: Output representation for file based flexcard that contains user specified search term in its name
1269
+ type: object
1270
+ properties:
1271
+ authorName:
1272
+ description: Name of author
1273
+ type: string
1274
+ uniqueName:
1275
+ description: Unique Name for the Overriden FlexCard
1276
+ type: string
1277
+ required: false
1278
+ id:
1279
+ description: Id of card
1280
+ type: string
1281
+ required: false
1282
+ isActive:
1283
+ description: If card is active or not
1284
+ type: boolean
1285
+ lastModifiedDate:
1286
+ description: Unique Name for the Overriden FlexCard
1287
+ type: string
1288
+ required: false
1289
+ name:
1290
+ description: Name of card
1291
+ type: string
1292
+ omniUiCardType:
1293
+ description: Type of Omni Ui Card
1294
+ type: string
1295
+ lastModifiedById:
1296
+ description: Id of last user who modified this record
1297
+ type: string
1298
+ required: false
1299
+ lastModifiedBy:
1300
+ description: Name of last user who modified this record
1301
+ type: string
1302
+ required: false
1303
+ versionNumber:
1304
+ description: Version number of card
1305
+ format: double
1306
+ type: number
1307
+ description:
1308
+ description: Description of card
1309
+ type: string
1310
+ required: false
1311
+ isFileBasedCard:
1312
+ description: If this card is file based or not.
1313
+ type: boolean
1314
+
1315
+ OmniDesignerCardListRepresentation:
1316
+ description: Output representation for list of cards matching user's searchTerm.
1317
+ type: object
1318
+ properties:
1319
+ nextPageCursor:
1320
+ description: Next page cursor to fetch next page of records
1321
+ type: string
1322
+ cards:
1323
+ description: List of cards
1324
+ type: array
1325
+ items:
1326
+ type: OmniDesignerCardDetailRepresentation
1327
+ IntegrationProcedureExecuteOutputRepresentation:
1328
+ description: 'Output Representation of Executed Integration Procedure '
1329
+ type: object
1330
+ properties:
1331
+ result:
1332
+ description: The result of executed Integration Procedure
1333
+ type: string
1334
+ IntegrationProcedureExecuteInputRepresentation:
1335
+ description: Input Representation of Integration Procedure for execution
1336
+ type: object
1337
+ properties:
1338
+ inputParams:
1339
+ description: Input Parameters for Integration Procedure record
1340
+ type: object
1341
+ properties:
1342
+ //:
1343
+ type: any
1344
+ options:
1345
+ description: Options passing for Integration Procedure record
1346
+ type: object
1347
+ properties:
1348
+ //:
1349
+ type: any
1350
+ procedureId:
1351
+ description: The id of Integration Procedure record
1352
+ type: string
1353
+ OsFileOutputRepresentation:
1354
+ description: Output representation for file based os card
1355
+ type: object
1356
+ properties:
1357
+ elements:
1358
+ description: elements
1359
+ type: array
1360
+ items:
1361
+ type: OmniProcessElementRepresentation
1362
+ omniProcess:
1363
+ description: omniProcess
1364
+ type: OmniProcessRepresentation | nil
1365
+ OmniProcessElementRepresentation:
1366
+ description: Output representation for OmniProcessElement
1367
+ type: object
1368
+ properties:
1369
+ description:
1370
+ description: description
1371
+ type: string | nil
1372
+ required: false
1373
+ designerCustomizationType:
1374
+ description: designerCustomizationType
1375
+ type: string | nil
1376
+ required: false
1377
+ discoveryFrameworkUsageType:
1378
+ description: discoveryFrameworkUsageType
1379
+ type: string | nil
1380
+ required: false
1381
+ embeddedOmniScriptKey:
1382
+ description: embeddedOmniScriptKey
1383
+ type: string | nil
1384
+ required: false
1385
+ id:
1386
+ description: id
1387
+ type: string | nil
1388
+ required: false
1389
+ isActive:
1390
+ description: isActive
1391
+ type: boolean | nil
1392
+ required: false
1393
+ isOmniScriptEmbeddable:
1394
+ description: isOmniScriptEmbeddable
1395
+ type: boolean | nil
1396
+ required: false
1397
+ level:
1398
+ description: level
1399
+ format: double
1400
+ type: number
1401
+ required: false
1402
+ name:
1403
+ description: name
1404
+ type: string | nil
1405
+ required: false
1406
+ omniProcessId:
1407
+ description: omniProcessId
1408
+ type: string | nil
1409
+ required: false
1410
+ omniProcessVersionNumber:
1411
+ description: omniProcessVersionNumber
1412
+ format: double
1413
+ type: number
1414
+ required: false
1415
+ parentElementId:
1416
+ description: parentElementId
1417
+ type: string | nil
1418
+ required: false
1419
+ parentElementName:
1420
+ description: parentElementName
1421
+ type: string | nil
1422
+ required: false
1423
+ parentElementType:
1424
+ description: parentElementType
1425
+ type: string | nil
1426
+ required: false
1427
+ propertySetConfig:
1428
+ description: propertySetConfig
1429
+ type: string | nil
1430
+ required: false
1431
+ sequenceNumber:
1432
+ description: sequenceNumber
1433
+ format: double
1434
+ type: number
1435
+ required: false
1436
+ type:
1437
+ description: type
1438
+ type: string | nil
1439
+ required: false
1440
+ OmniProcessRepresentation:
1441
+ description: Output representation for os
1442
+ type: object
1443
+ properties:
1444
+ customHtmlTemplates:
1445
+ description: customHtmlTemplates
1446
+ type: string | nil
1447
+ required: false
1448
+ customJavascript:
1449
+ description: customJavascript
1450
+ type: string | nil
1451
+ required: false
1452
+ description:
1453
+ description: description
1454
+ type: string | nil
1455
+ designerCustomizationType:
1456
+ description: designerCustomizationType
1457
+ type: string | nil
1458
+ required: false
1459
+ discoveryFrameworkUsageType:
1460
+ description: discoveryFrameworkUsageType
1461
+ type: string | nil
1462
+ required: false
1463
+ elementTypeComponentMapping:
1464
+ description: elementTypeComponentMapping
1465
+ type: string | nil
1466
+ required: false
1467
+ id:
1468
+ description: id
1469
+ type: string | nil
1470
+ required: false
1471
+ isActive:
1472
+ description: isActive
1473
+ type: boolean | nil
1474
+ required: false
1475
+ isIntegrationProcedure:
1476
+ description: isIntegrationProcedure
1477
+ type: boolean | nil
1478
+ required: false
1479
+ isMetadataCacheDisabled:
1480
+ description: isMetadataCacheDisabled
1481
+ type: boolean | nil
1482
+ required: false
1483
+ isOmniscriptEmbeddable:
1484
+ description: isOmniscriptEmbeddable
1485
+ type: boolean | nil
1486
+ required: false
1487
+ isTestProcedure:
1488
+ description: isTestProcedure
1489
+ type: boolean | nil
1490
+ required: false
1491
+ isWebCompEmbeddable:
1492
+ description: isWebCompEmbeddable
1493
+ type: boolean | nil
1494
+ required: false
1495
+ language:
1496
+ description: language
1497
+ type: string | nil
1498
+ required: false
1499
+ lastPreviewPage:
1500
+ description: lastPreviewPage
1501
+ type: string | nil
1502
+ required: false
1503
+ name:
1504
+ description: name
1505
+ type: string | nil
1506
+ required: false
1507
+ omniProcessType:
1508
+ description: omniProcessType
1509
+ type: string | nil
1510
+ required: false
1511
+ omniscriptKey:
1512
+ description: omniscriptKey
1513
+ type: string | nil
1514
+ required: false
1515
+ overrideKey:
1516
+ description: overrideKey
1517
+ type: string | nil
1518
+ required: false
1519
+ propertySetConfig:
1520
+ description: propertySetConfig
1521
+ type: string | nil
1522
+ required: false
1523
+ requiredPermission:
1524
+ description: requiredPermission
1525
+ type: string | nil
1526
+ required: false
1527
+ subType:
1528
+ description: subType
1529
+ type: string | nil
1530
+ required: false
1531
+ type:
1532
+ description: type
1533
+ type: string | nil
1534
+ required: false
1535
+ uniqueName:
1536
+ description: uniqueName
1537
+ type: string | nil
1538
+ required: false
1539
+ versionNumber:
1540
+ description: versionNumber
1541
+ format: double
1542
+ type: number
1543
+ required: false
1544
+ webComponentKey:
1545
+ description: webComponentKey
1546
+ type: string | nil
1547
+ required: false
1548
+ OmniDesignerEmailTemplateListRepresentation:
1549
+ description: Emails Template Output List Representation
1550
+ type: object
1551
+ properties:
1552
+ emailTemplateList:
1553
+ description: Representation of the Email Template as a list.
1554
+ type: array
1555
+ required: false
1556
+ items:
1557
+ type: OmniDesignerEmailTemplateRepresentation
1558
+ OmniDesignerEmailTemplateRepresentation:
1559
+ description: Emails Template Output Representation
1560
+ type: object
1561
+ properties:
1562
+ developerName:
1563
+ description: Name of the Email Template
1564
+ type: string
1565
+ required: false
1566
+ OmniDesignerOmniScriptDetailRepresentation:
1567
+ description: Representation of detail of a omniscript for list page
1568
+ type: object
1569
+ properties:
1570
+ description:
1571
+ description: Description of Omniscript
1572
+ type: string | nil
1573
+ isActive:
1574
+ description: if the omniscript is active or not
1575
+ type: boolean
1576
+ isFileBasedScript:
1577
+ description: If the omniscript is a file based omniscript
1578
+ type: boolean | nil
1579
+ language:
1580
+ description: Language of Omniscript
1581
+ type: string | nil
1582
+ name:
1583
+ description: Name of Omniscript
1584
+ type: string | nil
1585
+ omniProcessKey:
1586
+ description: Omni Process Key associated with the omniscript
1587
+ type: string | nil
1588
+ omniProcessType:
1589
+ description: Omni process type
1590
+ type: string | nil
1591
+ overrideKey:
1592
+ description: Override key of the omni process
1593
+ type: string | nil
1594
+ subType:
1595
+ description: Sub type of Omniscript
1596
+ type: string | nil
1597
+ type:
1598
+ description: Type of Omniscript
1599
+ type: string | nil
1600
+ versionNumber:
1601
+ description: Version number of Omniscript
1602
+ type: number
1603
+ format: double
1604
+ OmniDesignerOmniScriptListRepresentation:
1605
+ description: List of all omniscripts matching to user's query
1606
+ type: object
1607
+ properties:
1608
+ omniscripts:
1609
+ description: List of omniscripts
1610
+ type: array
1611
+ items:
1612
+ type: OmniDesignerOmniScriptDetailRepresentation
1613
+ OmniDesignerBusinessProcessDataJsonInputRepresentation:
1614
+ description: Input Representation of BusinessProcessDataJson
1615
+ type: object
1616
+ properties:
1617
+ businessProcessId:
1618
+ description: The id of OmniProcess record
1619
+ type: string
1620
+ rootElements:
1621
+ description: Input Parameters for root elements
1622
+ type: object
1623
+ properties:
1624
+ //:
1625
+ type: object
1626
+ DesignerCustomizationElementWarningOutputRepresentation:
1627
+ description: Output representation of designer customization element warning
1628
+ type: object
1629
+ properties:
1630
+ results:
1631
+ description: results
1632
+ type: object
1633
+ properties:
1634
+ //:
1635
+ type: any #Handrolled
1636
+ OmniDesignerBusinessProcessDataJsonOutputRepresentation:
1637
+ description: Output representation of BusinessProcessDataJson
1638
+ type: object
1639
+ properties:
1640
+ businessProcessId:
1641
+ description: The Id of the OmniProcess which was sent as an input
1642
+ type: string
1643
+ results:
1644
+ description: The JSON format of the OmniProcess record which will be used
1645
+ in Data Mapper
1646
+ type: object
1647
+ properties:
1648
+ //:
1649
+ type: any #Handrolled
1650
+ OmniProcessCloneInputRepresentation:
1651
+ description: Input representation for cloning omni process
1652
+ type: object
1653
+ properties:
1654
+ id:
1655
+ description: omni-process Id
1656
+ type: string
1657
+ type:
1658
+ description: type
1659
+ type: string
1660
+ OmniProcessCloneOutputRepresentation:
1661
+ description: Output representation of OmniProcess cloning
1662
+ type: object
1663
+ properties:
1664
+ id:
1665
+ description: The RecordId of cloned OmniProcess
1666
+ type: string
1667
+ DataMapperListRepresentation:
1668
+ description: Datamappers List Representation
1669
+ type: object
1670
+ properties:
1671
+ dataMappers:
1672
+ description: The list of data raptors
1673
+ type: array
1674
+ items:
1675
+ type: DataMapperParamRepresentation
1676
+ DataMapperParamRepresentation:
1677
+ description: Datamapper param Representation
1678
+ type: object
1679
+ properties:
1680
+ dataMapperName:
1681
+ description: Data Raptor Name
1682
+ type: string
1683
+ input:
1684
+ description: Input data for data raptor
1685
+ required: false
1686
+ type: string
1687
+ DatamapperCacheInputParamRepresentation:
1688
+ description: Datamapper Cache Input Parameters Representation
1689
+ type: object
1690
+ properties:
1691
+ cacheStorageType:
1692
+ description: The cache storage type
1693
+ type: string
1694
+ enum:
1695
+ - All
1696
+ - Metadata
1697
+ - Org
1698
+ - Session
1699
+ dataMapperList:
1700
+ description: The list of data mapper names
1701
+ type: DataMapperListRepresentation
1702
+ DatamapperClearCacheOutputRepresentation:
1703
+ description: Response for clearing cache for list of inputs
1704
+ type: object
1705
+ properties:
1706
+ error:
1707
+ description: A message describing the result of the cache clear operation
1708
+ type: string
1709
+ required: false
1710
+ responseList:
1711
+ description: List of response for the clear cache execution
1712
+ type: array
1713
+ required: false
1714
+ items:
1715
+ type: DatamapperClearCacheResponse
1716
+ status:
1717
+ description: Indicates if the cache was cleared successfully or not
1718
+ type: boolean
1719
+ DatamapperClearCacheResponse:
1720
+ description: Response for clearing cache
1721
+ type: object
1722
+ properties:
1723
+ error:
1724
+ description: A message describing the result of the cache clear operation
1725
+ type: string
1726
+ required: false
1727
+ status:
1728
+ description: Indicates if the cache was cleared successfully or not
1729
+ type: boolean
1730
+ DataMapperExecutionInputDataRepresentationList:
1731
+ description: Data Mapper Simulation Input Representation
1732
+ type: object
1733
+ properties:
1734
+ inputs:
1735
+ description: List of input data for data mapper to simulate
1736
+ type: array
1737
+ items:
1738
+ type: string
1739
+ DataMapperExecutionInputRepresentation:
1740
+ description: Data Mapper Simulation Input Representation
1741
+ type: object
1742
+ properties:
1743
+ dataMapperInput:
1744
+ description: Input data for data raptor to simulate
1745
+ type: DataMapperExecutionInputDataRepresentationList
1746
+ inputType:
1747
+ description: Input type for the data raptor to simulate
1748
+ type: string
1749
+ options:
1750
+ description: Options data raptor to simulate
1751
+ type: DataMapperExecutionOptionsRepresentation
1752
+ DataMapperExecutionOptionsRepresentation:
1753
+ description: Data Mapper Simulation Option Representation
1754
+ type: object
1755
+ properties:
1756
+ ignoreCache:
1757
+ description: Ignore Cache option for data mapper to execute
1758
+ required: false
1759
+ type: boolean
1760
+ ignoreMetadataCache:
1761
+ description: Ignore Metadata Cache option for data mapper to execute
1762
+ required: false
1763
+ type: boolean
1764
+ ignoreMetadataPermissions:
1765
+ description: Ignore Metadata Permissions option for data raptor to simulate
1766
+ required: false
1767
+ type: boolean
1768
+ locale:
1769
+ description: Locale option for data mapper to execute
1770
+ required: false
1771
+ type: string
1772
+ resetCache:
1773
+ description: Reset cache option for data raptor to simulate
1774
+ required: false
1775
+ type: boolean
1776
+ shouldIgnoreCommit:
1777
+ description: Ignore commit option for data raptor to simulate
1778
+ required: false
1779
+ type: boolean
1780
+ shouldSendLegacyResponse:
1781
+ description: Legacy response option for data raptor to simulate
1782
+ required: false
1783
+ type: boolean
1784
+ withoutSharing:
1785
+ description: Without sharing option for data raptor to simulate
1786
+ required: false
1787
+ type: boolean
1788
+ DataMapperExecutionOutputRepresentation:
1789
+ description: Data mapper execution Output Representation
1790
+ type: object
1791
+ properties:
1792
+ error:
1793
+ description: The response of execution as a JSON string
1794
+ type: string
1795
+ response:
1796
+ description: The response of execution as a JSON string
1797
+ type: array
1798
+ items:
1799
+ type: string
1800
+ status:
1801
+ description: The response of execution as a JSON string
1802
+ type: string
1803
+ enum:
1804
+ - Error
1805
+ - Success
1806
+ IntegrationProcedureServiceRunOutputRepresentation:
1807
+ description: Integration Procedure Execute From Output Representation
1808
+ type: object
1809
+ properties:
1810
+ error:
1811
+ description: The response of execution as a JSON string
1812
+ type: string
1813
+ response:
1814
+ description: The output of integration procedure run
1815
+ type: array
1816
+ items:
1817
+ type: string
1818
+ status:
1819
+ description: The response of execution as a JSON string
1820
+ type: string
1821
+ enum:
1822
+ - Error
1823
+ - Success
1824
+ IntegrationProcedureServiceRunInputRepresentation:
1825
+ description: Integration Procedure Execute From Apex Input Representation
1826
+ type: object
1827
+ properties:
1828
+ input:
1829
+ description: Input data for integration procedure
1830
+ type: IntegrationProcedureServiceRunInputRepresentationList
1831
+ options:
1832
+ description: Options for integration procedure
1833
+ type: IntegrationProcedureServiceRunOptionsRepresentation
1834
+ IntegrationProcedureServiceRunInputRepresentationList:
1835
+ description: Integration Procedure Service Run Input Representation
1836
+ type: object
1837
+ properties:
1838
+ inputs:
1839
+ description: List of input data for integration procedure service run
1840
+ type: array
1841
+ items:
1842
+ type: string
1843
+ IntegrationProcedureServiceRunOptionsRepresentation:
1844
+ description: Integration Procedure Service Run Option Representation
1845
+ type: object
1846
+ properties:
1847
+ chainable:
1848
+ description: Chainable option for Integration Procedure
1849
+ required: false
1850
+ type: boolean
1851
+ ignoreCache:
1852
+ description: Ignore Cache option for integration procedure to execute
1853
+ required: false
1854
+ type: boolean
1855
+ isDebug:
1856
+ description: IsDebug option for Integration Procedure
1857
+ required: false
1858
+ type: boolean
1859
+ queuableChainable:
1860
+ description: QueuableChainable option for Integration Procedure
1861
+ required: false
1862
+ type: boolean
1863
+ resetCache:
1864
+ description: Reset Cache option for Integration Procedure
1865
+ required: false
1866
+ type: boolean
1867
+ shouldSendLegacyResponse:
1868
+ description: Legacy response option for Integration Procedure
1869
+ required: false
1870
+ type: boolean
1871
+ useQueueableApexRemoting:
1872
+ description: UseQueueableApexRemoting Option for Integarion Procedure
1873
+ required: false
1874
+ type: boolean
1875
+ IntegrationProcedureCacheInputData:
1876
+ description: Integration Procedure Cache Input Data
1877
+ type: object
1878
+ properties:
1879
+ blockName:
1880
+ description: String for providing the blockname for Integration Procedure
1881
+ type: string
1882
+ required: false
1883
+ ipkey:
1884
+ description: IP Key in <Type_SubType> format
1885
+ type: string
1886
+ required: false
1887
+ inputData:
1888
+ description: JSON reprsentation of Input Data for Integration Procedure cache
1889
+ type: string
1890
+ required: false
1891
+ IntegrationProcedureCacheInputDataRepresentationList:
1892
+ description: Integration Procedure Cache Input Representation List
1893
+ type: object
1894
+ properties:
1895
+ inputs:
1896
+ description: List of input data for Integration Procedure Cache
1897
+ type: array
1898
+ items:
1899
+ type: IntegrationProcedureCacheInputData
1900
+ IntegrationProcedureCacheInputRepresentation:
1901
+ description: Integration Procedure Cache Input Representation
1902
+ type: object
1903
+ properties:
1904
+ cacheKeys:
1905
+ description: Cache Key for Integration Procedure cache
1906
+ required: false
1907
+ type: IntegrationProcedureCacheKeysRepresentationList
1908
+ cacheStorageType:
1909
+ description: The Integration Procedure cache storage type
1910
+ type: string
1911
+ enum:
1912
+ - All
1913
+ - Metadata
1914
+ - Org
1915
+ - Session
1916
+ ipinput:
1917
+ description: Input data for Integration Procedure cache
1918
+ required: false
1919
+ type: IntegrationProcedureCacheInputDataRepresentationList
1920
+ IntegrationProcedureCacheKeysRepresentationList:
1921
+ description: Integration Procedure Cache Input Representation List
1922
+ type: object
1923
+ properties:
1924
+ cacheKeys:
1925
+ description: List of cache Keys for Integration Procedure Cache
1926
+ type: array
1927
+ items:
1928
+ type: string
1929
+ IntegrationProcedureCacheOutputRepresentation:
1930
+ description: Integration Procedure Cache Output Representation
1931
+ type: object
1932
+ properties:
1933
+ error:
1934
+ description: A message describing the result of the cache clear operation
1935
+ type: string
1936
+ required: false
1937
+ responseList:
1938
+ description: The response of integration procedure run
1939
+ type: array
1940
+ required: false
1941
+ items:
1942
+ type: IntegrationProcedureCacheResponse
1943
+ status:
1944
+ description: Indicates if the cache was cleared successfully or not
1945
+ type: boolean
1946
+ IntegrationProcedureCacheResponse:
1947
+ description: Integration Procedure Cache Response
1948
+ type: object
1949
+ properties:
1950
+ error:
1951
+ description: The error message when the cache clear operation fails
1952
+ type: string
1953
+ required: false
1954
+ status:
1955
+ description: The status of cache clear operation
1956
+ type: boolean
1957
+ OmniDesignerDecisionTableDetailRepresentation:
1958
+ description: Output representation of single decision table record.
1959
+ type: object
1960
+ properties:
1961
+ label:
1962
+ description: Label of record.
1963
+ type: string
1964
+ value:
1965
+ description: Value of record
1966
+ type: string
1967
+ OmniDesignerDecisionTableRepresentation:
1968
+ description: Output representation of decision table records that are eligible for document matrix feature in omniScript.
1969
+ type: object
1970
+ properties:
1971
+ decisionTables:
1972
+ description: List of decision table records
1973
+ type: array
1974
+ items:
1975
+ type: OmniDesignerDecisionTableDetailRepresentation
1976
+ /connect:
1977
+ /omni-designer:
1978
+ /entity-info:
1979
+ get:
1980
+ displayName: fetchEntityInfo
1981
+ description: Fetches metadata about Entity Objects
1982
+ responses:
1983
+ '200':
1984
+ description: Success
1985
+ body:
1986
+ application/json:
1987
+ type: OmniDesignerEntityInfoRepresentation
1988
+ queryParameters:
1989
+ pageSize:
1990
+ type: integer
1991
+ required: false
1992
+ queryMore:
1993
+ type: string
1994
+ required: false
1995
+ /card:
1996
+ /add-attachment:
1997
+ post:
1998
+ displayName: postCardUpsertAttachment
1999
+ description: Upsert attachment in OmniUiCard
2000
+ responses:
2001
+ '200':
2002
+ description: Success
2003
+ body:
2004
+ application/json:
2005
+ type: OmniUiCardAttachmentUpsertRepresentation
2006
+ body:
2007
+ application/json:
2008
+ type: OmniUiCardAttachmentInputRepresentation
2009
+ (oas-body-name): cardUpsertAttachmentInput
2010
+ /{cardId}:
2011
+ get:
2012
+ displayName: getGetCardById
2013
+ description: Api to get OmniUiCard data by cardId
2014
+ responses:
2015
+ '200':
2016
+ description: Success
2017
+ body:
2018
+ application/json:
2019
+ type: OmniUiCardRepresentation
2020
+ uriParameters:
2021
+ cardId:
2022
+ type: string
2023
+ required: true
2024
+ /clone-omni-process:
2025
+ post:
2026
+ displayName: postCloneOmniProcess
2027
+ description: API to clone an omniProcess
2028
+ responses:
2029
+ '200':
2030
+ description: Success
2031
+ body:
2032
+ application/json:
2033
+ type: OmniProcessCloneOutputRepresentation
2034
+ body:
2035
+ application/json:
2036
+ type: OmniProcessCloneInputRepresentation
2037
+ (oas-body-name): cloneOmniProcessData
2038
+ /dataraptor-config:
2039
+ get:
2040
+ displayName: getDataraptorConfig
2041
+ description: Fetches configuration for a dataraptor
2042
+ responses:
2043
+ '200':
2044
+ description: Success
2045
+ body:
2046
+ application/json:
2047
+ type: OmniDesignerDataraptorRepresentation
2048
+ queryParameters:
2049
+ dataraptorIdentifier:
2050
+ type: string
2051
+ required: false
2052
+ dataraptorName:
2053
+ type: string
2054
+ required: false
2055
+ dataraptorVersion:
2056
+ type: string
2057
+ required: false
2058
+ mappingItemsCount:
2059
+ type: integer
2060
+ required: false
2061
+ queryMore:
2062
+ type: string
2063
+ required: false
2064
+ /dataraptor-list:
2065
+ get:
2066
+ displayName: fetchDataraptorList
2067
+ description: Fetch List of Data Raptor
2068
+ responses:
2069
+ '200':
2070
+ description: Success
2071
+ body:
2072
+ application/json:
2073
+ type: OmniDesignerDRListRepresentation
2074
+ queryParameters:
2075
+ name:
2076
+ type: string
2077
+ required: false
2078
+ type:
2079
+ type: string
2080
+ required: false
2081
+ /decision-matrix:
2082
+ get:
2083
+ displayName: fetchDecisionMatrix
2084
+ description: Fetch List of Decision Matrix
2085
+ responses:
2086
+ '200':
2087
+ description: Success
2088
+ body:
2089
+ application/json:
2090
+ type: OmniDesignerDecisionMatrixListRepresentation
2091
+ /docusign-templates:
2092
+ get:
2093
+ displayName: fetchDocusignTemplates
2094
+ description: Fetch List of Docusign Template
2095
+ responses:
2096
+ '200':
2097
+ description: Success
2098
+ body:
2099
+ application/json:
2100
+ type: OmniDesignerDocusignListRepresentation
2101
+ /email-documents:
2102
+ get:
2103
+ displayName: fetchEmailDocuments
2104
+ description: Fetch List of Email Documents
2105
+ responses:
2106
+ '200':
2107
+ description: Success
2108
+ body:
2109
+ application/json:
2110
+ type: OmniDesignerEmailDocumentListRepresentation
2111
+ /omni-process-list:
2112
+ get:
2113
+ displayName: fetchOmniProcessList
2114
+ description: ' Fetches list of OmniProcess'
2115
+ responses:
2116
+ '200':
2117
+ description: Success
2118
+ body:
2119
+ application/json:
2120
+ type: OmniDesignerOmniProcessListOutputRepresentation
2121
+ queryParameters:
2122
+ isProcedure:
2123
+ type: boolean
2124
+ required: false
2125
+ pageSize:
2126
+ type: integer
2127
+ required: false
2128
+ queryMore:
2129
+ type: string
2130
+ required: false
2131
+ /omniprocess/{omniProcessId}:
2132
+ get:
2133
+ displayName: fetchOmniProcessData
2134
+ description: Fetch OmniProcess Data
2135
+ responses:
2136
+ '200':
2137
+ description: Success
2138
+ body:
2139
+ application/json:
2140
+ type: OmniDesignerOmniProcessOutputRepresentation
2141
+ uriParameters:
2142
+ omniProcessId:
2143
+ type: string
2144
+ required: true
2145
+ /upsert-omni-process:
2146
+ post:
2147
+ displayName: upsertOmniProcess
2148
+ description: Upsert OmniProcess data
2149
+ responses:
2150
+ '200':
2151
+ description: Success
2152
+ body:
2153
+ application/json:
2154
+ type: OmniDesignerOmniProcessUpsertRepresentation
2155
+ body:
2156
+ application/json:
2157
+ type: OmniDesignerOmniProcessUpsertInputRepresentation
2158
+ (oas-body-name): omniProcessUpsertData
2159
+ /upsert-dataraptor:
2160
+ post:
2161
+ displayName: upsertDataraptor
2162
+ description: Upsert Dataraptor data
2163
+ responses:
2164
+ '200':
2165
+ description: Success
2166
+ body:
2167
+ application/json:
2168
+ type: OmniDesignerDataraptorUpsertOutputRepresentation
2169
+ body:
2170
+ application/json:
2171
+ type: OmniDesignerDataraptorUpsertInputRepresentation
2172
+ (oas-body-name): dataraptorUpsertData
2173
+ /os:
2174
+ /build-business-process-data-json:
2175
+ post:
2176
+ displayName: postOmniDesignerBusinessProcessDataJson
2177
+ description: Get JSON format of OmniProcess
2178
+ responses:
2179
+ '200':
2180
+ description: Success
2181
+ body:
2182
+ application/json:
2183
+ type: OmniDesignerBusinessProcessDataJsonOutputRepresentation
2184
+ body:
2185
+ application/json:
2186
+ type: OmniDesignerBusinessProcessDataJsonInputRepresentation
2187
+ (oas-body-name): businessDataJson
2188
+ /build-json:
2189
+ post:
2190
+ displayName: postOmniscriptBuildJson
2191
+ description: API to build Json of an omniscript
2192
+ responses:
2193
+ '200':
2194
+ description: Success
2195
+ body:
2196
+ application/json:
2197
+ type: BuildJsonOutputRepresentation
2198
+ body:
2199
+ application/json:
2200
+ # TODO hand rolled. W-14995636. Added the wrapper manually
2201
+ type: BuildJsonInputRepresentation
2202
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2203
+ (oas-body-name): buildJson
2204
+ /clone-omni-process-element:
2205
+ post:
2206
+ displayName: postOmniscriptCloneElement
2207
+ description: API to clone element in an omniscript
2208
+ responses:
2209
+ '200':
2210
+ description: Success
2211
+ body:
2212
+ application/json:
2213
+ type: OmniDesignerOmniscriptCloneElementOutputRepresentation
2214
+ body:
2215
+ application/json:
2216
+ # TODO hand rolled. W-14995636. Added the wrapper manually
2217
+ type: OmniDesignerOmniscriptCloneElementInputRepresentation
2218
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2219
+ (oas-body-name): cloneOmniscriptElementData
2220
+ /fetch-designer-customization-element-warning/{designerCustomizationType}/{omniScriptId}:
2221
+ get:
2222
+ displayName: getOmniscriptGetDesignerCustomizationElementWarning
2223
+ description: Api to fetch designer Customization element warnings
2224
+ responses:
2225
+ '200':
2226
+ description: Success
2227
+ body:
2228
+ application/json:
2229
+ type: DesignerCustomizationElementWarningOutputRepresentation
2230
+ uriParameters:
2231
+ designerCustomizationType:
2232
+ type: string
2233
+ required: true
2234
+ omniScriptId:
2235
+ type: string
2236
+ required: true
2237
+ /fetch-designer-customization/{designerCustomizationType}:
2238
+ get:
2239
+ displayName: getOmniscriptGetDesignerCustomizations
2240
+ description: Api to fetch Dynamic Elements
2241
+ responses:
2242
+ '200':
2243
+ description: Success
2244
+ body:
2245
+ application/json:
2246
+ type: DesignerCutomizationOutputRepresentation
2247
+ uriParameters:
2248
+ designerCustomizationType:
2249
+ type: string
2250
+ required: true
2251
+ /fetch-designer-element-customization/{designerCustomizationType}/{elementId}:
2252
+ get:
2253
+ displayName: getOmniscriptGetElementDesignerCustomizations
2254
+ description: Api to fetch designer Customization element customizations
2255
+ responses:
2256
+ '200':
2257
+ description: Success
2258
+ body:
2259
+ application/json:
2260
+ type: OmniProcessElementDesignerCustomizationOutputRepresentation
2261
+ uriParameters:
2262
+ designerCustomizationType:
2263
+ type: string
2264
+ required: true
2265
+ elementId:
2266
+ type: string
2267
+ required: true
2268
+ /fetch-docusign-templates:
2269
+ get:
2270
+ displayName: getDocusignTemplatesExternal
2271
+ description: Api to fetch Docusign templates
2272
+ responses:
2273
+ '200':
2274
+ description: Success
2275
+ body:
2276
+ application/json:
2277
+ type: DocusignTemplatesOutputRepresentation
2278
+ /fetch-dynamic-elements:
2279
+ get:
2280
+ displayName: getOmniscriptGetDynamicElements
2281
+ description: Api to fetch Dynamic Elements
2282
+ responses:
2283
+ '200':
2284
+ description: Success
2285
+ body:
2286
+ application/json:
2287
+ type: DynamicElementsOutputRepresentation
2288
+ /insert-omni-process-element:
2289
+ post:
2290
+ displayName: postOmniscriptInsertElement
2291
+ description: API to insert element in an omniscript
2292
+ responses:
2293
+ '200':
2294
+ description: Success
2295
+ body:
2296
+ application/json:
2297
+ type: OmniDesignerOmniscriptInsertElementOutputRepresentation
2298
+ body:
2299
+ application/json:
2300
+ # TODO hand rolled. W-14995636. Added the wrapper manually
2301
+ type: OmniDesignerOmniscriptInsertElementInputRepresentation
2302
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2303
+ (oas-body-name): insertOmniscriptElementData
2304
+ /move-omni-process-element:
2305
+ post:
2306
+ displayName: postOmniscriptMoveElement
2307
+ description: API to move element in an omniscript
2308
+ responses:
2309
+ '200':
2310
+ description: Success
2311
+ body:
2312
+ application/json:
2313
+ type: OmniDesignerOmniscriptMoveElementOutputRepresentation
2314
+ body:
2315
+ application/json:
2316
+ type: OmniDesignerOmniscriptMoveElementInputRepresentation
2317
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2318
+ (oas-body-name): moveOmniscriptElementData
2319
+ /non-omniscript-lwc:
2320
+ get:
2321
+ displayName: getFetchNonOmniscriptLwc
2322
+ description: Fetch List of Non Omniscript Lwc Resources
2323
+ responses:
2324
+ '200':
2325
+ description: Success
2326
+ body:
2327
+ application/json:
2328
+ type: NonOmniscriptComponentsOutputRepresentation
2329
+ queryParameters:
2330
+ name:
2331
+ type: string
2332
+ required: false
2333
+ type:
2334
+ type: string
2335
+ required: false
2336
+ /delete-omni-process-element:
2337
+ post:
2338
+ displayName: delete element
2339
+ description: API to delete element in an omniscript
2340
+ responses:
2341
+ '200':
2342
+ description: Success
2343
+ body:
2344
+ application/json:
2345
+ type: OmniDesignerOmniscriptDeleteElementOutputRepresentation
2346
+ body:
2347
+ application/json:
2348
+ type: OmniDesignerOmniscriptDeleteElementInputRepresentation
2349
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2350
+ (oas-body-name): deleteOmniscriptElementData
2351
+ /save-custom-label:
2352
+ post:
2353
+ displayName: postOmniscriptSaveCustomLabel
2354
+ description: API to move element in an omniscript
2355
+ responses:
2356
+ '200':
2357
+ description: Success
2358
+ body:
2359
+ application/json:
2360
+ type: OmniDesignerOmniscriptCustomLabelOutputRepresentation
2361
+ body:
2362
+ application/json:
2363
+ type: OmniDesignerOmniscriptCustomLabelListInputRepresentation
2364
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2365
+ (oas-body-name): saveCustomLabelData
2366
+ /document:
2367
+ post:
2368
+ displayName: upload Document
2369
+ description: API to upload document in an omniscript
2370
+ responses:
2371
+ '200':
2372
+ description: Success
2373
+ body:
2374
+ application/json:
2375
+ type: UploadDocumentOutputRepresentation
2376
+ body:
2377
+ application/json:
2378
+ type: UploadDocumentInputRepresentation
2379
+ # TODO hand rolled. W-14995636. Hand Rolled Change to add 'required: false'
2380
+ (oas-body-name): uploadDocumentData
2381
+ /file-based/{osName}:
2382
+ get:
2383
+ displayName: getFetchFileBasedOsDetail
2384
+ description: API to get detail of file based os
2385
+ responses:
2386
+ '200':
2387
+ description: Success
2388
+ body:
2389
+ application/json:
2390
+ type: OsFileOutputRepresentation
2391
+ uriParameters:
2392
+ osName:
2393
+ type: string
2394
+ required: true
2395
+ /get-scripts:
2396
+ get:
2397
+ displayName: getFetchFileBasedOsList
2398
+ description: API to get all file based omniscripts accessible to this org/user
2399
+ responses:
2400
+ '200':
2401
+ description: Success
2402
+ body:
2403
+ application/json:
2404
+ type: OmniDesignerOmniScriptListRepresentation
2405
+ /record/{omniProcessId}:
2406
+ get:
2407
+ displayName: getIntegrationProcedureFetchRecord
2408
+ description: Read Builder Record
2409
+ responses:
2410
+ '200':
2411
+ description: Success
2412
+ body:
2413
+ application/json:
2414
+ type: IntegrationProcedureRecordOutputRepresentations
2415
+ uriParameters:
2416
+ omniProcessId:
2417
+ description: Record id for integration Procedure
2418
+ type: string
2419
+ required: true
2420
+ /insert-ip-record:
2421
+ post:
2422
+ displayName: postIntegrationProcedureConnectPost
2423
+ description: Update Builder Record
2424
+ responses:
2425
+ '200':
2426
+ description: Success
2427
+ body:
2428
+ application/json:
2429
+ type: IntegrationProcedureRecordOutputRepresentation
2430
+ body:
2431
+ application/json:
2432
+ type: IntegrationProcedureRecordInputRepresentation
2433
+ (oas-body-name): integrationProcedureRecordInputRepresentationObject
2434
+ /expression-grammar:
2435
+ get:
2436
+ displayName: getExpressionGrammar
2437
+ description: Fetches metadata about Expression Grammar
2438
+ responses:
2439
+ '200':
2440
+ description: Success
2441
+ body:
2442
+ application/json:
2443
+ type: OmniDesignerExpressionGrammarRepresentation
2444
+ queryParameters:
2445
+ designerName:
2446
+ type: string
2447
+ required: false
2448
+ /dataraptor-simulate:
2449
+ patch:
2450
+ displayName: simulateDataraptor
2451
+ description: Simulates a Data Raptor
2452
+ responses:
2453
+ '200':
2454
+ description: Success
2455
+ body:
2456
+ application/json:
2457
+ type: OmniDesignerDataraptorSimulateRepresentation
2458
+ body:
2459
+ application/json:
2460
+ type: OmniDesignerDataraptorSimulateInputRepresentation
2461
+ (oas-body-name): dataraptorSimualateInputParams
2462
+ /get-entity-records:
2463
+ post:
2464
+ displayName: getEntityRecords
2465
+ description: Get resource to fetch entity records
2466
+ responses:
2467
+ '200':
2468
+ description: Success
2469
+ body:
2470
+ application/json:
2471
+ type: OmniDesignerFetchEntityRecordsOutputRepresentation
2472
+ body:
2473
+ application/json:
2474
+ type: OmniDesignerFetchEntityRecordsInputRepresentation
2475
+ (oas-body-name): getEntityRecordsInput
2476
+ /execute-ip:
2477
+ patch:
2478
+ displayName: integrationProcedureExecutionResult
2479
+ description: Update Builder Record
2480
+ responses:
2481
+ '200':
2482
+ description: Success
2483
+ body:
2484
+ application/json:
2485
+ type: IntegrationProcedureExecuteOutputRepresentation
2486
+ body:
2487
+ application/json:
2488
+ type: IntegrationProcedureExecuteInputRepresentation
2489
+ (oas-body-name): integrationProcedureExecuteInputRepresentationObject
2490
+
2491
+ /get-cards:
2492
+ get:
2493
+ displayName: getCardsList
2494
+ description: Get List of cards for list page.
2495
+ responses:
2496
+ '200':
2497
+ description: Success
2498
+ body:
2499
+ application/json:
2500
+ type: OmniDesignerCardListRepresentation
2501
+ queryParameters:
2502
+ searchTerm:
2503
+ type: string
2504
+ required: false
2505
+ onlyFileBased:
2506
+ type: boolean
2507
+ required: false
2508
+ nextPageCursor:
2509
+ type: string
2510
+ required: false
2511
+
2512
+ /get-file-card/{cardName}:
2513
+ get:
2514
+ displayName: getFileBasedCardDetail
2515
+ description: API to get file based card detail
2516
+ responses:
2517
+ '200':
2518
+ description: Success
2519
+ body:
2520
+ application/json:
2521
+ type: OmniDesignerFileCardRepresentation
2522
+ uriParameters:
2523
+ cardName:
2524
+ type: string
2525
+ required: true
2526
+ /email-templates:
2527
+ get:
2528
+ displayName: getEmailTemplates
2529
+ description: Get List of Email Templates
2530
+ responses:
2531
+ '200':
2532
+ description: Success
2533
+ body:
2534
+ application/json:
2535
+ type: OmniDesignerEmailTemplateListRepresentation
2536
+ /document-matrix/decision-table:
2537
+ get:
2538
+ displayName: getDecisionTableForDocumentMatrix
2539
+ description: Gets decision Table records that are eligible for document matrix feature in omniscript.
2540
+ responses:
2541
+ '200':
2542
+ description: Success
2543
+ body:
2544
+ application/json:
2545
+ type: OmniDesignerDecisionTableRepresentation
2546
+ /omni-global:
2547
+ /data-mapper:
2548
+ /actions/clear-cache:
2549
+ post:
2550
+ displayName: postClearDatamapperCache
2551
+ description: Clears the cache for a specific Datamapper
2552
+ responses:
2553
+ '200':
2554
+ description: Success
2555
+ body:
2556
+ application/json:
2557
+ type: DatamapperClearCacheOutputRepresentation
2558
+ body:
2559
+ application/json:
2560
+ type: DatamapperCacheInputParamRepresentation
2561
+ (oas-body-name): datamapperClearCacheInputParams
2562
+ /execute/{name}:
2563
+ post:
2564
+ displayName: postExecuteDataMapper
2565
+ description: Simulates a Data Mapper
2566
+ responses:
2567
+ '200':
2568
+ description: Success
2569
+ body:
2570
+ application/json:
2571
+ type: DataMapperExecutionOutputRepresentation
2572
+ body:
2573
+ application/json:
2574
+ type: DataMapperExecutionInputRepresentation
2575
+ (oas-body-name): datamapperSimualateApexInputParams
2576
+ uriParameters:
2577
+ name:
2578
+ type: string
2579
+ required: true
2580
+ /integration-procedure:
2581
+ /execute/{id}:
2582
+ post:
2583
+ displayName: postIntegrationProcedureExecute
2584
+ description: Invokes an Integration Procedure
2585
+ responses:
2586
+ '200':
2587
+ description: Success
2588
+ body:
2589
+ application/json:
2590
+ type: IntegrationProcedureServiceRunOutputRepresentation
2591
+ body:
2592
+ application/json:
2593
+ type: IntegrationProcedureServiceRunInputRepresentation
2594
+ (oas-body-name): integrationProcedureServiceRunInputParams
2595
+ uriParameters:
2596
+ id:
2597
+ type: string
2598
+ required: true
2599
+ /actions/clear-cache:
2600
+ post:
2601
+ displayName: postClearIntegrationProcedureCache
2602
+ description: Clears the cache for Integration Procedures
2603
+ responses:
2604
+ '200':
2605
+ description: Success
2606
+ body:
2607
+ application/json:
2608
+ type: IntegrationProcedureCacheOutputRepresentation
2609
+ body:
2610
+ application/json:
2611
+ type: IntegrationProcedureCacheInputRepresentation
2612
+ (oas-body-name): IntegrationProcedureCacheInputRepresentation