@salesforce/lds-adapters-analytics-unifiedanalytics 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 (270) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/analytics-unifiedanalytics.js +14184 -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/createAnnotation.d.ts +20 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createAssetSlackChannel.d.ts +17 -0
  6. package/dist/es/es2018/types/src/generated/adapters/createDashboard.d.ts +27 -0
  7. package/dist/es/es2018/types/src/generated/adapters/createDataAlert.d.ts +26 -0
  8. package/dist/es/es2018/types/src/generated/adapters/createDataAssetRequest.d.ts +24 -0
  9. package/dist/es/es2018/types/src/generated/adapters/createLoglines.d.ts +15 -0
  10. package/dist/es/es2018/types/src/generated/adapters/createRecordShares.d.ts +17 -0
  11. package/dist/es/es2018/types/src/generated/adapters/createTemplate.d.ts +22 -0
  12. package/dist/es/es2018/types/src/generated/adapters/createVisualization.d.ts +35 -0
  13. package/dist/es/es2018/types/src/generated/adapters/createWorkspace.d.ts +18 -0
  14. package/dist/es/es2018/types/src/generated/adapters/createWorkspaceAsset.d.ts +18 -0
  15. package/dist/es/es2018/types/src/generated/adapters/deleteAllShares.d.ts +14 -0
  16. package/dist/es/es2018/types/src/generated/adapters/deleteDashboard.d.ts +14 -0
  17. package/dist/es/es2018/types/src/generated/adapters/deleteDataAlert.d.ts +14 -0
  18. package/dist/es/es2018/types/src/generated/adapters/deleteRecordShare.d.ts +15 -0
  19. package/dist/es/es2018/types/src/generated/adapters/deleteVisualization.d.ts +14 -0
  20. package/dist/es/es2018/types/src/generated/adapters/deleteWorkspace.d.ts +14 -0
  21. package/dist/es/es2018/types/src/generated/adapters/deleteWorkspaceAsset.d.ts +15 -0
  22. package/dist/es/es2018/types/src/generated/adapters/follow.d.ts +20 -0
  23. package/dist/es/es2018/types/src/generated/adapters/generateSFDriveCredentials.d.ts +15 -0
  24. package/dist/es/es2018/types/src/generated/adapters/getAnnotations.d.ts +31 -0
  25. package/dist/es/es2018/types/src/generated/adapters/getAssetSlackChannels.d.ts +27 -0
  26. package/dist/es/es2018/types/src/generated/adapters/getDashboardByName.d.ts +29 -0
  27. package/dist/es/es2018/types/src/generated/adapters/getDashboards.d.ts +29 -0
  28. package/dist/es/es2018/types/src/generated/adapters/getDataAlert.d.ts +28 -0
  29. package/dist/es/es2018/types/src/generated/adapters/getDataAlertCollection.d.ts +29 -0
  30. package/dist/es/es2018/types/src/generated/adapters/getDataAssetDependencies.d.ts +28 -0
  31. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestByIdOrApiName.d.ts +28 -0
  32. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequests.d.ts +37 -0
  33. package/dist/es/es2018/types/src/generated/adapters/getDataAssetRequestsCount.d.ts +33 -0
  34. package/dist/es/es2018/types/src/generated/adapters/getFlowByName.d.ts +27 -0
  35. package/dist/es/es2018/types/src/generated/adapters/getFlows.d.ts +28 -0
  36. package/dist/es/es2018/types/src/generated/adapters/getFollowedAssets.d.ts +30 -0
  37. package/dist/es/es2018/types/src/generated/adapters/getFollowers.d.ts +31 -0
  38. package/dist/es/es2018/types/src/generated/adapters/getMarketplaceListingInstallationProgress.d.ts +27 -0
  39. package/dist/es/es2018/types/src/generated/adapters/getOrg.d.ts +26 -0
  40. package/dist/es/es2018/types/src/generated/adapters/getShares.d.ts +34 -0
  41. package/dist/es/es2018/types/src/generated/adapters/getSlackAppInfo.d.ts +26 -0
  42. package/dist/es/es2018/types/src/generated/adapters/getSubscriptionDigestConfig.d.ts +28 -0
  43. package/dist/es/es2018/types/src/generated/adapters/getUnifiedAnalyticsLibraryAssets.d.ts +23 -0
  44. package/dist/es/es2018/types/src/generated/adapters/getUniqueFollowerCount.d.ts +28 -0
  45. package/dist/es/es2018/types/src/generated/adapters/getVisualization.d.ts +29 -0
  46. package/dist/es/es2018/types/src/generated/adapters/getVisualizationBundle.d.ts +29 -0
  47. package/dist/es/es2018/types/src/generated/adapters/getVisualizations.d.ts +29 -0
  48. package/dist/es/es2018/types/src/generated/adapters/getWorkspaceByIdOrName.d.ts +28 -0
  49. package/dist/es/es2018/types/src/generated/adapters/getWorkspaces.d.ts +28 -0
  50. package/dist/es/es2018/types/src/generated/adapters/initiateMarketplaceListingInstallation.d.ts +27 -0
  51. package/dist/es/es2018/types/src/generated/adapters/postDataAlertRun.d.ts +15 -0
  52. package/dist/es/es2018/types/src/generated/adapters/publish.d.ts +15 -0
  53. package/dist/es/es2018/types/src/generated/adapters/publishToMarketplace.d.ts +17 -0
  54. package/dist/es/es2018/types/src/generated/adapters/queryAssets.d.ts +22 -0
  55. package/dist/es/es2018/types/src/generated/adapters/queryUsers.d.ts +19 -0
  56. package/dist/es/es2018/types/src/generated/adapters/unfollow.d.ts +15 -0
  57. package/dist/es/es2018/types/src/generated/adapters/updateDashboard.d.ts +28 -0
  58. package/dist/es/es2018/types/src/generated/adapters/updateDataAlert.d.ts +27 -0
  59. package/dist/es/es2018/types/src/generated/adapters/updateDataAssetRequest.d.ts +25 -0
  60. package/dist/es/es2018/types/src/generated/adapters/updateFollowedAsset.d.ts +19 -0
  61. package/dist/es/es2018/types/src/generated/adapters/updateRecordShares.d.ts +16 -0
  62. package/dist/es/es2018/types/src/generated/adapters/updateSubscriptionDigestConfig.d.ts +17 -0
  63. package/dist/es/es2018/types/src/generated/adapters/updateVisualization.d.ts +36 -0
  64. package/dist/es/es2018/types/src/generated/adapters/updateWorkspace.d.ts +19 -0
  65. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +62 -0
  66. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +98 -0
  67. package/dist/es/es2018/types/src/generated/resources/deleteTableauDashboardsByDashboardIdOrApiName.d.ts +12 -0
  68. package/dist/es/es2018/types/src/generated/resources/deleteTableauDataAlertsByDataAlertId.d.ts +12 -0
  69. package/dist/es/es2018/types/src/generated/resources/deleteTableauFollowFollowersFollowsByFollowedAssetIdAndFollowerId.d.ts +13 -0
  70. package/dist/es/es2018/types/src/generated/resources/deleteTableauRecordsSharesByRecordId.d.ts +12 -0
  71. package/dist/es/es2018/types/src/generated/resources/deleteTableauRecordsSharesByRecordIdAndUserOrGroupId.d.ts +13 -0
  72. package/dist/es/es2018/types/src/generated/resources/deleteTableauVisualizationsByVisualizationIdOrApiName.d.ts +12 -0
  73. package/dist/es/es2018/types/src/generated/resources/deleteTableauWorkspacesAssetsByAssetIdAndWorkspaceIdOrApiName.d.ts +13 -0
  74. package/dist/es/es2018/types/src/generated/resources/deleteTableauWorkspacesByWorkspaceIdOrApiName.d.ts +12 -0
  75. package/dist/es/es2018/types/src/generated/resources/getTableauAnnotations.d.ts +19 -0
  76. package/dist/es/es2018/types/src/generated/resources/getTableauAnnotationsSlackAppInfo.d.ts +12 -0
  77. package/dist/es/es2018/types/src/generated/resources/getTableauDashboards.d.ts +17 -0
  78. package/dist/es/es2018/types/src/generated/resources/getTableauDashboardsByDashboardIdOrApiName.d.ts +19 -0
  79. package/dist/es/es2018/types/src/generated/resources/getTableauDataAlerts.d.ts +17 -0
  80. package/dist/es/es2018/types/src/generated/resources/getTableauDataAlertsByDataAlertId.d.ts +16 -0
  81. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsDependenciesByAssetId.d.ts +18 -0
  82. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequests.d.ts +25 -0
  83. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +16 -0
  84. package/dist/es/es2018/types/src/generated/resources/getTableauDataAssetsRequestsCount.d.ts +21 -0
  85. package/dist/es/es2018/types/src/generated/resources/getTableauFlows.d.ts +16 -0
  86. package/dist/es/es2018/types/src/generated/resources/getTableauFlowsByFlowApiName.d.ts +15 -0
  87. package/dist/es/es2018/types/src/generated/resources/getTableauFollowAssetsFollowerCountByFollowedAssetId.d.ts +18 -0
  88. package/dist/es/es2018/types/src/generated/resources/getTableauFollowAssetsFollowersByFollowedAssetId.d.ts +21 -0
  89. package/dist/es/es2018/types/src/generated/resources/getTableauFollowFollowersFollowedAssetsByFollowerId.d.ts +20 -0
  90. package/dist/es/es2018/types/src/generated/resources/getTableauFollowFollowersFollowsByFollowedAssetIdAndFollowerId.d.ts +16 -0
  91. package/dist/es/es2018/types/src/generated/resources/getTableauMarketplaceInstallationsByInstallationId.d.ts +15 -0
  92. package/dist/es/es2018/types/src/generated/resources/getTableauMarketplaceListingsInstallByListingId.d.ts +15 -0
  93. package/dist/es/es2018/types/src/generated/resources/getTableauOrgs.d.ts +12 -0
  94. package/dist/es/es2018/types/src/generated/resources/getTableauRecordsSharesByRecordId.d.ts +24 -0
  95. package/dist/es/es2018/types/src/generated/resources/getTableauRecordsSharesByRecordIdAndUserOrGroupId.d.ts +16 -0
  96. package/dist/es/es2018/types/src/generated/resources/getTableauSlackChannels.d.ts +15 -0
  97. package/dist/es/es2018/types/src/generated/resources/getTableauSubscriptionsDigestByDigestConfigOwner.d.ts +16 -0
  98. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizations.d.ts +17 -0
  99. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizationsBundleByVisualizationIdOrApiName.d.ts +19 -0
  100. package/dist/es/es2018/types/src/generated/resources/getTableauVisualizationsByVisualizationIdOrApiName.d.ts +19 -0
  101. package/dist/es/es2018/types/src/generated/resources/getTableauWorkspaces.d.ts +16 -0
  102. package/dist/es/es2018/types/src/generated/resources/getTableauWorkspacesAssetsByAssetIdAndWorkspaceIdOrApiName.d.ts +16 -0
  103. package/dist/es/es2018/types/src/generated/resources/getTableauWorkspacesAssetsByWorkspaceIdOrApiName.d.ts +20 -0
  104. package/dist/es/es2018/types/src/generated/resources/getTableauWorkspacesByWorkspaceIdOrApiName.d.ts +16 -0
  105. package/dist/es/es2018/types/src/generated/resources/patchTableauDashboardsByDashboardIdOrApiName.d.ts +29 -0
  106. package/dist/es/es2018/types/src/generated/resources/patchTableauDataAssetsRequestsByRequestIdOrApiName.d.ts +24 -0
  107. package/dist/es/es2018/types/src/generated/resources/patchTableauFollowFollowersFollowsByFollowerId.d.ts +18 -0
  108. package/dist/es/es2018/types/src/generated/resources/patchTableauRecordsSharesByRecordId.d.ts +15 -0
  109. package/dist/es/es2018/types/src/generated/resources/patchTableauSubscriptionsDigestByDigestConfigOwner.d.ts +16 -0
  110. package/dist/es/es2018/types/src/generated/resources/patchTableauVisualizationsByVisualizationIdOrApiName.d.ts +37 -0
  111. package/dist/es/es2018/types/src/generated/resources/patchTableauWorkspacesByWorkspaceIdOrApiName.d.ts +18 -0
  112. package/dist/es/es2018/types/src/generated/resources/postSsotSfDriveActionsGenerateCredential.d.ts +11 -0
  113. package/dist/es/es2018/types/src/generated/resources/postTableauAdminMonitoringEvents.d.ts +12 -0
  114. package/dist/es/es2018/types/src/generated/resources/postTableauAnnotations.d.ts +17 -0
  115. package/dist/es/es2018/types/src/generated/resources/postTableauAssetsQuery.d.ts +19 -0
  116. package/dist/es/es2018/types/src/generated/resources/postTableauDashboards.d.ts +26 -0
  117. package/dist/es/es2018/types/src/generated/resources/postTableauDataAlerts.d.ts +25 -0
  118. package/dist/es/es2018/types/src/generated/resources/postTableauDataAlertsRunByDataAlertId.d.ts +12 -0
  119. package/dist/es/es2018/types/src/generated/resources/postTableauDataAssetsRequests.d.ts +21 -0
  120. package/dist/es/es2018/types/src/generated/resources/postTableauFollowFollowersFollowsByFollowerId.d.ts +19 -0
  121. package/dist/es/es2018/types/src/generated/resources/postTableauLibraryAssetsQuery.d.ts +20 -0
  122. package/dist/es/es2018/types/src/generated/resources/postTableauLoglines.d.ts +12 -0
  123. package/dist/es/es2018/types/src/generated/resources/postTableauMarketplaceListings.d.ts +14 -0
  124. package/dist/es/es2018/types/src/generated/resources/postTableauMarketplaceTemplates.d.ts +19 -0
  125. package/dist/es/es2018/types/src/generated/resources/postTableauRecordsSharesByRecordId.d.ts +16 -0
  126. package/dist/es/es2018/types/src/generated/resources/postTableauSlackChannels.d.ts +14 -0
  127. package/dist/es/es2018/types/src/generated/resources/postTableauUsersQuery.d.ts +16 -0
  128. package/dist/es/es2018/types/src/generated/resources/postTableauVisualizations.d.ts +34 -0
  129. package/dist/es/es2018/types/src/generated/resources/postTableauWorkspaces.d.ts +15 -0
  130. package/dist/es/es2018/types/src/generated/resources/postTableauWorkspacesAssetsByWorkspaceIdOrApiName.d.ts +17 -0
  131. package/dist/es/es2018/types/src/generated/resources/putTableauDataAlertsByDataAlertId.d.ts +28 -0
  132. package/dist/es/es2018/types/src/generated/types/AnalyticsAssetsQueryInputRepresentation.d.ts +47 -0
  133. package/dist/es/es2018/types/src/generated/types/AnalyticsAssetsQueryResultsItemRepresentation.d.ts +36 -0
  134. package/dist/es/es2018/types/src/generated/types/AnalyticsAssetsQueryResultsRepresentation.d.ts +48 -0
  135. package/dist/es/es2018/types/src/generated/types/AnalyticsAssetsQueryResultsWorkspaceRepresentation.d.ts +26 -0
  136. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryAssetCollectionOutputRepresentation.d.ts +45 -0
  137. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryCollectionQueryInputRepresentation.d.ts +50 -0
  138. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryDashboardTemplateRepresentation.d.ts +32 -0
  139. package/dist/es/es2018/types/src/generated/types/AnalyticsLibraryImageRepresentation.d.ts +28 -0
  140. package/dist/es/es2018/types/src/generated/types/AnalyticsUserRepresentation.d.ts +29 -0
  141. package/dist/es/es2018/types/src/generated/types/AnalyticsUsersQueryInputRepresentation.d.ts +40 -0
  142. package/dist/es/es2018/types/src/generated/types/AnalyticsUsersQueryResultsRepresentation.d.ts +48 -0
  143. package/dist/es/es2018/types/src/generated/types/AnnotationAssetRepresentation.d.ts +31 -0
  144. package/dist/es/es2018/types/src/generated/types/AnnotationCollectionRepresentation.d.ts +42 -0
  145. package/dist/es/es2018/types/src/generated/types/AnnotationConversationInputRepresentation.d.ts +37 -0
  146. package/dist/es/es2018/types/src/generated/types/AnnotationConversationRepresentation.d.ts +41 -0
  147. package/dist/es/es2018/types/src/generated/types/AnnotationInputRepresentation.d.ts +43 -0
  148. package/dist/es/es2018/types/src/generated/types/AnnotationRepresentation.d.ts +55 -0
  149. package/dist/es/es2018/types/src/generated/types/AssetSlackChannelCollectionRepresentation.d.ts +39 -0
  150. package/dist/es/es2018/types/src/generated/types/AssetSlackChannelInputRepresentation.d.ts +34 -0
  151. package/dist/es/es2018/types/src/generated/types/AssetSlackChannelRepresentation.d.ts +50 -0
  152. package/dist/es/es2018/types/src/generated/types/BaseAnalyticsAssetRepresentation.d.ts +37 -0
  153. package/dist/es/es2018/types/src/generated/types/BaseAnalyticsLibraryAssetRepresentation.d.ts +40 -0
  154. package/dist/es/es2018/types/src/generated/types/BaseAnalyticsRepresentation.d.ts +37 -0
  155. package/dist/es/es2018/types/src/generated/types/CdpAssetBaseInputRepresentation.d.ts +34 -0
  156. package/dist/es/es2018/types/src/generated/types/ContentDocumentOutputRepresentation.d.ts +40 -0
  157. package/dist/es/es2018/types/src/generated/types/ContentVersionOutputRepresentation.d.ts +44 -0
  158. package/dist/es/es2018/types/src/generated/types/DashboardAnchorInputRepresentation.d.ts +28 -0
  159. package/dist/es/es2018/types/src/generated/types/DashboardAnnotationAnchorRepresentation.d.ts +28 -0
  160. package/dist/es/es2018/types/src/generated/types/DashboardCollectionRepresentation.d.ts +38 -0
  161. package/dist/es/es2018/types/src/generated/types/DashboardInputRepresentation.d.ts +57 -0
  162. package/dist/es/es2018/types/src/generated/types/DashboardRepresentation.d.ts +81 -0
  163. package/dist/es/es2018/types/src/generated/types/DataAlertCollectionRepresentation.d.ts +36 -0
  164. package/dist/es/es2018/types/src/generated/types/DataAlertConditionInputRepresentation.d.ts +38 -0
  165. package/dist/es/es2018/types/src/generated/types/DataAlertConditionRepresentation.d.ts +33 -0
  166. package/dist/es/es2018/types/src/generated/types/DataAlertContentInputRepresentation.d.ts +33 -0
  167. package/dist/es/es2018/types/src/generated/types/DataAlertContentRepresentation.d.ts +28 -0
  168. package/dist/es/es2018/types/src/generated/types/DataAlertCronScheduleRepresentation.d.ts +29 -0
  169. package/dist/es/es2018/types/src/generated/types/DataAlertDailyScheduleInputRepresentation.d.ts +26 -0
  170. package/dist/es/es2018/types/src/generated/types/DataAlertDailyScheduleRepresentation.d.ts +26 -0
  171. package/dist/es/es2018/types/src/generated/types/DataAlertDeliveryConfigurationInputRepresentation.d.ts +30 -0
  172. package/dist/es/es2018/types/src/generated/types/DataAlertDeliveryConfigurationRepresentation.d.ts +29 -0
  173. package/dist/es/es2018/types/src/generated/types/DataAlertInputRepresentation.d.ts +46 -0
  174. package/dist/es/es2018/types/src/generated/types/DataAlertMetricContentInputRepresentation.d.ts +33 -0
  175. package/dist/es/es2018/types/src/generated/types/DataAlertMetricContentRepresentation.d.ts +32 -0
  176. package/dist/es/es2018/types/src/generated/types/DataAlertMetricValueInputRepresentation.d.ts +55 -0
  177. package/dist/es/es2018/types/src/generated/types/DataAlertMetricValueRepresentation.d.ts +51 -0
  178. package/dist/es/es2018/types/src/generated/types/DataAlertNotificationRecipientsInputRepresentation.d.ts +30 -0
  179. package/dist/es/es2018/types/src/generated/types/DataAlertNotificationRecipientsRepresentation.d.ts +29 -0
  180. package/dist/es/es2018/types/src/generated/types/DataAlertRawValueInputRepresentation.d.ts +33 -0
  181. package/dist/es/es2018/types/src/generated/types/DataAlertRawValueRepresentation.d.ts +32 -0
  182. package/dist/es/es2018/types/src/generated/types/DataAlertReceiversInputRepresentation.d.ts +33 -0
  183. package/dist/es/es2018/types/src/generated/types/DataAlertReceiversRepresentation.d.ts +28 -0
  184. package/dist/es/es2018/types/src/generated/types/DataAlertRepresentation.d.ts +61 -0
  185. package/dist/es/es2018/types/src/generated/types/DataAlertRunOutputRepresentation.d.ts +44 -0
  186. package/dist/es/es2018/types/src/generated/types/DataAlertScheduleInputRepresentation.d.ts +37 -0
  187. package/dist/es/es2018/types/src/generated/types/DataAlertScheduleRepresentation.d.ts +31 -0
  188. package/dist/es/es2018/types/src/generated/types/DataAlertThresholdsInputRepresentation.d.ts +32 -0
  189. package/dist/es/es2018/types/src/generated/types/DataAlertThresholdsRepresentation.d.ts +32 -0
  190. package/dist/es/es2018/types/src/generated/types/DataAlertValueInputRepresentation.d.ts +34 -0
  191. package/dist/es/es2018/types/src/generated/types/DataAlertValueRepresentation.d.ts +28 -0
  192. package/dist/es/es2018/types/src/generated/types/DataAlertValueRightOperandInputRepresentation.d.ts +28 -0
  193. package/dist/es/es2018/types/src/generated/types/DataAlertWeeklyScheduleInputRepresentation.d.ts +30 -0
  194. package/dist/es/es2018/types/src/generated/types/DataAlertWeeklyScheduleRepresentation.d.ts +29 -0
  195. package/dist/es/es2018/types/src/generated/types/DataAssetDependentCollectionRepresentation.d.ts +30 -0
  196. package/dist/es/es2018/types/src/generated/types/DataAssetDependentRepresentation.d.ts +29 -0
  197. package/dist/es/es2018/types/src/generated/types/DataAssetRepresentation.d.ts +75 -0
  198. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCollectionRepresentation.d.ts +30 -0
  199. package/dist/es/es2018/types/src/generated/types/DataAssetRequestCountRepresentation.d.ts +29 -0
  200. package/dist/es/es2018/types/src/generated/types/DataAssetRequestInputRepresentation.d.ts +55 -0
  201. package/dist/es/es2018/types/src/generated/types/DataAssetRequestRepresentation.d.ts +123 -0
  202. package/dist/es/es2018/types/src/generated/types/FileTypeOutputRepresentation.d.ts +31 -0
  203. package/dist/es/es2018/types/src/generated/types/FlowCollectionRepresentation.d.ts +38 -0
  204. package/dist/es/es2018/types/src/generated/types/FlowMetadataRepresentation.d.ts +29 -0
  205. package/dist/es/es2018/types/src/generated/types/FlowRepresentation.d.ts +49 -0
  206. package/dist/es/es2018/types/src/generated/types/FlowVariableRepresentation.d.ts +53 -0
  207. package/dist/es/es2018/types/src/generated/types/FollowInputRepresentation.d.ts +37 -0
  208. package/dist/es/es2018/types/src/generated/types/FollowedAssetCollectionRepresentation.d.ts +30 -0
  209. package/dist/es/es2018/types/src/generated/types/FollowedAssetInputRepresentation.d.ts +37 -0
  210. package/dist/es/es2018/types/src/generated/types/FollowedAssetRepresentation.d.ts +66 -0
  211. package/dist/es/es2018/types/src/generated/types/FollowedTimeRangeRepresentation.d.ts +31 -0
  212. package/dist/es/es2018/types/src/generated/types/FollowerAssetCollectionRepresentation.d.ts +42 -0
  213. package/dist/es/es2018/types/src/generated/types/FollowerAssetRepresentation.d.ts +58 -0
  214. package/dist/es/es2018/types/src/generated/types/FollowerCollectionRepresentation.d.ts +30 -0
  215. package/dist/es/es2018/types/src/generated/types/FollowerInputRepresentation.d.ts +40 -0
  216. package/dist/es/es2018/types/src/generated/types/MarketplaceListingInputRepresentation.d.ts +34 -0
  217. package/dist/es/es2018/types/src/generated/types/MarketplaceListingRepresentation.d.ts +38 -0
  218. package/dist/es/es2018/types/src/generated/types/MarketplaceTemplateInputRepresentation.d.ts +47 -0
  219. package/dist/es/es2018/types/src/generated/types/MarketplaceTemplateOutputRepresentation.d.ts +38 -0
  220. package/dist/es/es2018/types/src/generated/types/OrgCollectionRepresentation.d.ts +32 -0
  221. package/dist/es/es2018/types/src/generated/types/OrgRepresentation.d.ts +37 -0
  222. package/dist/es/es2018/types/src/generated/types/SFDriveCredentialInputRepresentation.d.ts +29 -0
  223. package/dist/es/es2018/types/src/generated/types/SFDriveCredentialRepresentation.d.ts +48 -0
  224. package/dist/es/es2018/types/src/generated/types/SetupRecordAccessCollectionRepresentation.d.ts +43 -0
  225. package/dist/es/es2018/types/src/generated/types/SetupRecordAccessInputRepresentation.d.ts +31 -0
  226. package/dist/es/es2018/types/src/generated/types/SetupRecordAccessItemInputRepresentation.d.ts +37 -0
  227. package/dist/es/es2018/types/src/generated/types/SetupRecordAccessRepresentation.d.ts +51 -0
  228. package/dist/es/es2018/types/src/generated/types/SetupRecordShareCollectionRepresentation.d.ts +49 -0
  229. package/dist/es/es2018/types/src/generated/types/SetupRecordShareErrorRepresentation.d.ts +35 -0
  230. package/dist/es/es2018/types/src/generated/types/SetupRecordShareInputRepresentation.d.ts +37 -0
  231. package/dist/es/es2018/types/src/generated/types/SetupRecordShareRepresentation.d.ts +48 -0
  232. package/dist/es/es2018/types/src/generated/types/SetupRecordShareUserOrGroupRepresentation.d.ts +43 -0
  233. package/dist/es/es2018/types/src/generated/types/SlackAppInfoRepresentation.d.ts +41 -0
  234. package/dist/es/es2018/types/src/generated/types/SlackEmojiOutputRepresentation.d.ts +40 -0
  235. package/dist/es/es2018/types/src/generated/types/SlackFileOutputRepresentation.d.ts +59 -0
  236. package/dist/es/es2018/types/src/generated/types/SlackMessageOutputRepresentation.d.ts +102 -0
  237. package/dist/es/es2018/types/src/generated/types/SlackReactionOutputRepresentation.d.ts +53 -0
  238. package/dist/es/es2018/types/src/generated/types/SlackUserInfoOutputRepresentation.d.ts +77 -0
  239. package/dist/es/es2018/types/src/generated/types/SubscriptionDigestConfigInputRepresentation.d.ts +31 -0
  240. package/dist/es/es2018/types/src/generated/types/SubscriptionDigestConfigOutputRepresentation.d.ts +44 -0
  241. package/dist/es/es2018/types/src/generated/types/TableauExternalMonitoringEventInputRepresentation.d.ts +28 -0
  242. package/dist/es/es2018/types/src/generated/types/TableauExternalMonitoringEventItemInputRepresentation.d.ts +40 -0
  243. package/dist/es/es2018/types/src/generated/types/TableauExternalMonitoringEventItemRepresentation.d.ts +44 -0
  244. package/dist/es/es2018/types/src/generated/types/TableauMarketplaceListingInstallationProgressResponse.d.ts +34 -0
  245. package/dist/es/es2018/types/src/generated/types/TableauMarketplaceListingInstallationResponse.d.ts +31 -0
  246. package/dist/es/es2018/types/src/generated/types/UnifiedAnalyticsLogLinesRepresentation.d.ts +44 -0
  247. package/dist/es/es2018/types/src/generated/types/UnifiedAnalyticsLoglineInputRepresentation.d.ts +35 -0
  248. package/dist/es/es2018/types/src/generated/types/UnifiedAnalyticsLoglinesInputRepresentation.d.ts +28 -0
  249. package/dist/es/es2018/types/src/generated/types/UnifiedFilterInputRepresentation.d.ts +33 -0
  250. package/dist/es/es2018/types/src/generated/types/UnifiedFilterRepresentation.d.ts +34 -0
  251. package/dist/es/es2018/types/src/generated/types/UniqueFollowerCountRepresentation.d.ts +29 -0
  252. package/dist/es/es2018/types/src/generated/types/UpdateFollowedAssetInputRepresentation.d.ts +35 -0
  253. package/dist/es/es2018/types/src/generated/types/UpdateSetupRecordAccessInputRepresentation.d.ts +28 -0
  254. package/dist/es/es2018/types/src/generated/types/UpdateSetupRecordAccessItemInputRepresentation.d.ts +31 -0
  255. package/dist/es/es2018/types/src/generated/types/VisualizationBundleRepresentation.d.ts +45 -0
  256. package/dist/es/es2018/types/src/generated/types/VisualizationCollectionRepresentation.d.ts +38 -0
  257. package/dist/es/es2018/types/src/generated/types/VisualizationInputRepresentation.d.ts +75 -0
  258. package/dist/es/es2018/types/src/generated/types/VisualizationRepresentation.d.ts +97 -0
  259. package/dist/es/es2018/types/src/generated/types/WorkspaceAssetCollectionRepresentation.d.ts +38 -0
  260. package/dist/es/es2018/types/src/generated/types/WorkspaceAssetInputRepresentation.d.ts +34 -0
  261. package/dist/es/es2018/types/src/generated/types/WorkspaceAssetRepresentation.d.ts +53 -0
  262. package/dist/es/es2018/types/src/generated/types/WorkspaceCollectionRepresentation.d.ts +38 -0
  263. package/dist/es/es2018/types/src/generated/types/WorkspaceInputRepresentation.d.ts +37 -0
  264. package/dist/es/es2018/types/src/generated/types/WorkspaceRepresentation.d.ts +65 -0
  265. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  266. package/package.json +66 -0
  267. package/sfdc/index.d.ts +1 -0
  268. package/sfdc/index.js +14917 -0
  269. package/src/raml/api.raml +3801 -0
  270. package/src/raml/luvio.raml +479 -0
@@ -0,0 +1,3801 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '62.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
+ AnnotationAssetRepresentation:
29
+ description: Metadata about the asset which is annotated in unified analytics
30
+ type: object
31
+ properties:
32
+ assetId:
33
+ description: Asset ID
34
+ type: string
35
+ assetType:
36
+ description: ID of the annotation conversation
37
+ type: string
38
+ enum:
39
+ - Dashboard
40
+ AnnotationCollectionRepresentation:
41
+ description: Unified Analytics Annotation collection representation.
42
+ type: object
43
+ properties:
44
+ annotations:
45
+ description: List of annotations being returned
46
+ type: array
47
+ items:
48
+ type: AnnotationRepresentation
49
+ total:
50
+ description: Size of list of annotations being returned
51
+ type: integer
52
+ AnnotationConversationInputRepresentation:
53
+ description: Annotation conversation input representation in unified analytics
54
+ type: object
55
+ properties:
56
+ appId:
57
+ description: Application ID of the conversation
58
+ type: string
59
+ channelId:
60
+ description: The channel ID where the conversation is happening
61
+ type: string
62
+ messageTimestamp:
63
+ description: Id of the slack message
64
+ type: string
65
+ teamId:
66
+ description: Workspace ID of where the conversation is
67
+ type: string
68
+ AnnotationConversationRepresentation:
69
+ description: Metadata about annotation conversation in unified analytics
70
+ type: object
71
+ properties:
72
+ channelId:
73
+ description: ID of the slack channel
74
+ type: string
75
+ channelName:
76
+ description: Name of the channel
77
+ type: string
78
+ conversationId:
79
+ description: ID of the annotation conversation
80
+ type: string
81
+ message:
82
+ description: First message of the annotation and it's metadata.
83
+ type: SlackMessageOutputRepresentation | nil
84
+ required: false
85
+ teamId:
86
+ description: ID of the slack workspace
87
+ type: string
88
+ AnnotationInputRepresentation:
89
+ description: Input representation for Annotations
90
+ type: object
91
+ properties:
92
+ anchor?:
93
+ description: The annotation anchor metadata
94
+ type: any #Hand rolled
95
+ annotationTool:
96
+ description: The tool used to create the annotation
97
+ type: string
98
+ enum:
99
+ - Slack
100
+ assetId:
101
+ description: Asset ID
102
+ type: string
103
+ assetType:
104
+ description: Asset type which can be annotated
105
+ type: string
106
+ enum:
107
+ - Dashboard
108
+ collaborationObject:
109
+ description: The conversation metadata
110
+ type: any #Hand rolled
111
+ status:
112
+ description: The status of the annotation
113
+ type: string
114
+ enum:
115
+ - Open
116
+ - Resolved
117
+ AnnotationRepresentation:
118
+ description: Metadata about annotation anchor in unified analytics
119
+ discriminatorValue: Annotation
120
+ type: object # Hand rolled to expose id in the caching
121
+ properties:
122
+ anchor:
123
+ description: Conversation metadata
124
+ type: DashboardAnnotationAnchorRepresentation
125
+ required: false
126
+ annotationTool:
127
+ description: Annotation tool type enum.
128
+ type: string
129
+ enum:
130
+ - Slack
131
+ asset:
132
+ description: Annotations metadata
133
+ type: AnnotationAssetRepresentation
134
+ collaborationObject:
135
+ description: Conversation metadata
136
+ type: AnnotationConversationRepresentation
137
+ status:
138
+ description: Annotation Status
139
+ type: string
140
+ enum:
141
+ - Open
142
+ - Resolved
143
+ id:
144
+ description: Database record id of the asset.
145
+ type: string
146
+ AnalyticsAssetsQueryResultsWorkspaceRepresentation:
147
+ description: Workspace of an analytics asset item
148
+ type: BaseAnalyticsRepresentation
149
+ properties: {}
150
+ BaseAnalyticsAssetRepresentation:
151
+ description: Base analytic asset representation.
152
+ type: BaseAnalyticsRepresentation
153
+ properties:
154
+ createdBy:
155
+ description: Created by of the asset.
156
+ type: AnalyticsUserRepresentation
157
+ createdDate:
158
+ description: Created date of the asset
159
+ type: string
160
+ lastModifiedBy:
161
+ description: Last modified by of the asset.
162
+ type: AnalyticsUserRepresentation
163
+ lastModifiedDate:
164
+ description: Last modified date of the asset.
165
+ type: string
166
+ AnalyticsAssetsQueryResultsItemRepresentation:
167
+ description: An item in the results of assets query
168
+ type: BaseAnalyticsRepresentation
169
+ properties:
170
+ assetType?:
171
+ description: The type of the asset.
172
+ type: string | nil
173
+ workspace?:
174
+ description: The workspace of the asset.
175
+ type: AnalyticsAssetsQueryResultsWorkspaceRepresentation | nil
176
+ assetParentIdentifier?:
177
+ description: Id of an asset's parent
178
+ type: string | nil
179
+ AnalyticsAssetsQueryInputRepresentation:
180
+ description: Unified Analytics Assets Query Input Representation
181
+ type: object
182
+ properties:
183
+ filters?:
184
+ description: Filters parameter value
185
+ type: object
186
+ properties:
187
+ //:
188
+ type: any
189
+ limit?:
190
+ description: Limit parameter value
191
+ type: integer
192
+ offset?:
193
+ description: Offset parameter value
194
+ type: integer
195
+ orderBy?:
196
+ description: OrderBy parameter value
197
+ type: string
198
+ enum:
199
+ - AssetType
200
+ - CreatedBy
201
+ - CreatedDate
202
+ - LastModifiedBy
203
+ - LastModifiedDate
204
+ - Name
205
+ - Workspace
206
+ searchTerm:
207
+ description: Search term parameter value
208
+ type: string
209
+ sortDirection?:
210
+ description: SortDirection parameter value
211
+ type: string
212
+ enum:
213
+ - Ascending
214
+ - Descending
215
+ AnalyticsAssetsQueryResultsRepresentation:
216
+ description: Results of Assets Query
217
+ type: object
218
+ properties:
219
+ queryKey:
220
+ description: Search id based on input items
221
+ type: string
222
+ items:
223
+ description: The content of the page.
224
+ type: array
225
+ items:
226
+ type: AnalyticsAssetsQueryResultsItemRepresentation
227
+ nextOffset:
228
+ description: The offset of the next page.
229
+ type: integer
230
+ size:
231
+ description: The size of the page.
232
+ type: integer
233
+ AnalyticsUserRepresentation:
234
+ description: Representation of a user.
235
+ type: BaseAnalyticsRepresentation
236
+ properties:
237
+ profilePhotoUrl:
238
+ description: The Chatter profile photo of the user.
239
+ type: string | nil
240
+ required: false
241
+ AssetSlackChannelCollectionRepresentation:
242
+ description: asset slack channel collection
243
+ type: object
244
+ properties:
245
+ assetSlackChannels:
246
+ description: asset slack channels
247
+ type: array
248
+ items:
249
+ type: AssetSlackChannelRepresentation
250
+ AssetSlackChannelInputRepresentation:
251
+ description: Analytics Slack Channels Input
252
+ type: object
253
+ properties:
254
+ assetId:
255
+ description: Id of the analytics asset
256
+ type: string
257
+ channelName:
258
+ description: Slack channel name
259
+ type: string
260
+ teamId:
261
+ description: Slack workspace Id
262
+ type: string
263
+ AssetSlackChannelRepresentation:
264
+ description: Slack channel metadata
265
+ type: object
266
+ properties:
267
+ assetId:
268
+ description: Analytics Asset Id
269
+ type: string
270
+ channelId:
271
+ description: Slack channel Id
272
+ type: string
273
+ channelName:
274
+ description: Slack channel name
275
+ type: string
276
+ id:
277
+ description: Id of the asset + channel record
278
+ type: string
279
+ teamId:
280
+ description: Slack workspace Id
281
+ type: string
282
+ AnalyticsUsersQueryInputRepresentation:
283
+ description: Unified Analytics Users Query Input Representation
284
+ type: object
285
+ properties:
286
+ searchTerm:
287
+ description: Search term parameter value
288
+ type: string
289
+ required: false
290
+ userCapability:
291
+ description: User permission
292
+ type: string
293
+ required: false
294
+ useAutoSuggest:
295
+ description: Use auto suggest term parameter value
296
+ type: boolean
297
+ required: false
298
+ limit:
299
+ description: Limit parameter value
300
+ type: integer
301
+ required: false
302
+ offset:
303
+ description: Offset parameter value
304
+ type: integer
305
+ required: false
306
+ AnalyticsUsersQueryResultsRepresentation:
307
+ description: Results of Users Query
308
+ type: object
309
+ properties:
310
+ items:
311
+ description: The content of the page.
312
+ type: array
313
+ items:
314
+ type: AnalyticsUserRepresentation
315
+ nextOffset:
316
+ description: The offset of the next page.
317
+ type: integer
318
+ queryKey:
319
+ description: The query key to help in caching the results.
320
+ type: string
321
+ size:
322
+ description: The size of the page.
323
+ type: integer
324
+ FollowInputRepresentation:
325
+ description: Follow input representation in unified analytics.
326
+ type: object
327
+ properties:
328
+ assetId:
329
+ description: Asset ID
330
+ type: string
331
+ assetType:
332
+ description: Followed asset type
333
+ type: string
334
+ enum:
335
+ - SemanticMetricDefinition
336
+ - SemanticSubMetric
337
+ followerType:
338
+ description: Follower type
339
+ type: string
340
+ enum:
341
+ - Group
342
+ - User
343
+ followedTimeRange:
344
+ description: Time Range filter representation
345
+ type: FollowedTimeRangeRepresentation
346
+ required: false
347
+ UpdateFollowedAssetInputRepresentation:
348
+ description: Update followed asset input representation in unified analytics.
349
+ type: object
350
+ properties:
351
+ assetId:
352
+ description: Asset ID
353
+ type: string
354
+ required: false
355
+ followedTimeRange:
356
+ description: Time Range filter representation
357
+ type: FollowedTimeRangeRepresentation | nil
358
+ required: false
359
+ updateAllAssets:
360
+ description: Whether or not to update all followed assets
361
+ type: boolean
362
+ required: false
363
+ FollowedAssetCollectionRepresentation:
364
+ description: Collection of Followed Assets
365
+ type: object
366
+ properties:
367
+ followedAssets:
368
+ description: List of followed assets being returned.
369
+ type: array
370
+ items:
371
+ type: FollowedAssetRepresentation
372
+ FollowedAssetInputRepresentation:
373
+ description: Followed asset input representation in unified analytics.
374
+ type: object
375
+ properties:
376
+ followedAssetType:
377
+ description: Followed asset type
378
+ type: string
379
+ enum:
380
+ - SemanticMetricDefinition
381
+ - SemanticSubMetric
382
+ followerId:
383
+ description: Follower ID
384
+ type: string
385
+ limit:
386
+ description: Limit parameter value
387
+ type: integer
388
+ offset:
389
+ description: Offset parameter value
390
+ type: integer
391
+ FollowedAssetRepresentation:
392
+ description: Followed Asset
393
+ discriminator: id # Hand-rolled W-16142351: invalid inheritance
394
+ type: object # Hand-rolled W-16142351: invalid inheritance
395
+ properties:
396
+ description:
397
+ description: Description of the asset.
398
+ type: string
399
+ required: false
400
+ id:
401
+ description: Database record id of the asset.
402
+ type: string
403
+ label:
404
+ description: Label of the asset.
405
+ type: string
406
+ name:
407
+ description: Name of the asset.
408
+ type: string
409
+ createdBy:
410
+ description: Created by of the asset.
411
+ type: any
412
+ createdDate:
413
+ description: Created date of the asset
414
+ type: string
415
+ lastModifiedBy:
416
+ description: Last modified by of the asset.
417
+ type: any
418
+ required: false
419
+ lastModifiedDate:
420
+ description: Last modified date of the asset.
421
+ type: string
422
+ required: false
423
+ assetType:
424
+ description: Asset type
425
+ type: string
426
+ enum:
427
+ - SemanticMetricDefinition
428
+ - SemanticSubMetric
429
+ followedTimeRange:
430
+ description: Time Range filter representation
431
+ type: FollowedTimeRangeRepresentation | nil
432
+ required: false
433
+ FollowedTimeRangeRepresentation:
434
+ description: Followed Time Range Representation
435
+ type: object
436
+ properties:
437
+ fieldName: string
438
+ operator: string # SemanticFilterOperatorTypeEnum
439
+ values:
440
+ type: array
441
+ items:
442
+ type: string | number
443
+ FollowerAssetCollectionRepresentation:
444
+ description: Collection of Follower Assets
445
+ type: object
446
+ properties:
447
+ followerId:
448
+ description: ID of the follower
449
+ type: string
450
+ followerAssets:
451
+ description: List of follower assets being returned
452
+ type: array
453
+ items:
454
+ type: FollowerAssetRepresentation
455
+ FollowerAssetRepresentation:
456
+ description: Represent follower and asset mapping
457
+ type: object
458
+ properties:
459
+ followedAssetId:
460
+ description: Followed asset ID
461
+ type: string
462
+ followedAssetType:
463
+ description: Followed asset type
464
+ type: string
465
+ enum:
466
+ - SemanticMetricDefinition
467
+ - SemanticSubMetric
468
+ followerId:
469
+ description: Follower ID
470
+ type: string
471
+ followerType:
472
+ description: Follower type
473
+ type: string
474
+ enum:
475
+ - Group
476
+ - User
477
+ createdBy:
478
+ description: The user who created this record
479
+ type: AnalyticsUserRepresentation
480
+ createdDate:
481
+ description: Created date
482
+ type: string
483
+ followedTimeRange:
484
+ description: Time Range filter representation
485
+ type: FollowedTimeRangeRepresentation | nil
486
+ required: false
487
+ FollowerCollectionRepresentation:
488
+ description: Collection of Followers
489
+ type: object
490
+ properties:
491
+ followers:
492
+ description: List of followers being returned.
493
+ type: array
494
+ items:
495
+ type: AnalyticsUserRepresentation
496
+ FollowerInputRepresentation:
497
+ description: Follower input representation in unified analytics.
498
+ type: object
499
+ properties:
500
+ followedAssetId:
501
+ description: Followed asset ID
502
+ type: string
503
+ followerId:
504
+ description: Follower ID
505
+ type: string
506
+ followerType:
507
+ description: Follower type
508
+ type: string
509
+ enum:
510
+ - Group
511
+ - User
512
+ limit:
513
+ description: Limit parameter value
514
+ type: integer
515
+ offset:
516
+ description: Offset parameter value
517
+ type: integer
518
+ UniqueFollowerCountRepresentation:
519
+ description: Unique count of followers
520
+ type: object
521
+ properties:
522
+ uniqueFollowerCount:
523
+ description: Unique count of followers
524
+ type: integer
525
+ VisualizationCollectionRepresentation:
526
+ description: A collection of unified analytics visualizations.
527
+ type: object
528
+ properties:
529
+ visualizations:
530
+ description: List of visualizations being returned.
531
+ type: array
532
+ items:
533
+ type: VisualizationRepresentation
534
+ VisualizationInputRepresentation:
535
+ description: Unified Analytics Visualization Input Representation
536
+ type: object
537
+ properties:
538
+ id:
539
+ description: Visualization id.
540
+ type: string
541
+ required: false
542
+ description:
543
+ description: Description.
544
+ type: string
545
+ required: false
546
+ label:
547
+ description: Master label.
548
+ type: string
549
+ name:
550
+ description: Unique developer name.
551
+ type: string
552
+ required: false
553
+ dataSource:
554
+ description: The Datasource of the visualization
555
+ type: object
556
+ properties:
557
+ //:
558
+ type: any
559
+ workspace:
560
+ description: The workspace name the visualization belongs to.
561
+ type: object
562
+ properties:
563
+ //:
564
+ type: any
565
+ visualSpecification:
566
+ description: The visualization specification.
567
+ type: object
568
+ properties:
569
+ //:
570
+ type: any
571
+ fields:
572
+ description: The visualization fields.
573
+ type: object
574
+ required: false
575
+ properties:
576
+ //:
577
+ type: any
578
+ view:
579
+ description: The visualization view.
580
+ type: object
581
+ required: false
582
+ properties:
583
+ //:
584
+ type: any
585
+ interactions:
586
+ description: Interactions representation
587
+ type: array
588
+ required: false
589
+ items:
590
+ type: any
591
+ VisualizationRepresentation:
592
+ description: Unified analytics visualization representation.
593
+ discriminator: name # TODO Hand-rolled W-15315791: invalid inheritance
594
+ type: object # TODO Hand-rolled W-15315791: invalid inheritance
595
+ properties:
596
+ id:
597
+ description: Visualization id.
598
+ type: string
599
+ description:
600
+ description: Description of the asset.
601
+ type: string
602
+ required: false
603
+ label:
604
+ description: Label of the asset.
605
+ type: string
606
+ name:
607
+ description: Name of the asset.
608
+ type: string
609
+ createdBy:
610
+ description: Created by of the asset.
611
+ type: AnalyticsUserRepresentation
612
+ createdDate:
613
+ description: Created date of the asset
614
+ type: string
615
+ lastModifiedBy:
616
+ description: Last modified by of the asset.
617
+ type: AnalyticsUserRepresentation
618
+ required: false
619
+ lastModifiedDate:
620
+ description: Last modified date of the asset.
621
+ type: string
622
+ required: false
623
+ dataSource:
624
+ description: Datasource of this visualization.
625
+ type: object
626
+ properties:
627
+ //:
628
+ type: any
629
+ workspace:
630
+ description: The workspace name the visualization belongs to.
631
+ type: object
632
+ properties:
633
+ //:
634
+ type: any
635
+ visualSpecification:
636
+ description: The visualization specification.
637
+ type: object
638
+ properties:
639
+ //:
640
+ type: any
641
+ fields:
642
+ description: The visualization fields.
643
+ type: object
644
+ required: false
645
+ properties:
646
+ //:
647
+ type: any
648
+ view:
649
+ description: The visualization view.
650
+ type: object
651
+ required: false
652
+ properties:
653
+ //:
654
+ type: any
655
+ interactions:
656
+ description: Interactions representation
657
+ type: array
658
+ required: false
659
+ items:
660
+ type: any
661
+ VisualizationBundleRepresentation:
662
+ description: Unified analytics visualization with additional information.
663
+ type: object
664
+ properties:
665
+ visualization:
666
+ description: The details of the visualization.
667
+ type: VisualizationRepresentation
668
+ properties:
669
+ //:
670
+ type: any
671
+ dataSource:
672
+ description: The metadata of the visualization's source entity.
673
+ type: object
674
+ required: false
675
+ properties:
676
+ //:
677
+ type: any
678
+ AnalyticsLibraryAssetCollectionOutputRepresentation:
679
+ description: The output representation of the list for AnalyticsLibraryAssetPreview
680
+ type: object
681
+ properties:
682
+ analyticsLibraryAssetPreviewRepresentationList:
683
+ description: Get a list of AnalyticsLibraryAssetsPreviewRepresentation.
684
+ type: array
685
+ items:
686
+ type: BaseAnalyticsLibraryAssetRepresentation
687
+ id:
688
+ description: The ID for caching response for this API
689
+ type: string
690
+ totalCount:
691
+ description: Total count of library assets after filtering based on given
692
+ input
693
+ type: integer
694
+ BaseAnalyticsLibraryAssetRepresentation:
695
+ description: Output representation of the AnalyticsLibraryAsset Preview
696
+ discriminator: id # TODO Hand-rolled W-15628417: Invalid discriminator
697
+ type: object
698
+ properties:
699
+ assetSource:
700
+ description: 'Type of asset source: 1P,3P like AppExchange etc'
701
+ type: string
702
+ assetType:
703
+ description: 'Type of asset: SDM, App etc'
704
+ type: string
705
+ description:
706
+ description: Description of template
707
+ type: string | nil
708
+ id:
709
+ description: The ID or fully qualified API name of template.
710
+ type: string
711
+ name:
712
+ description: Name of template
713
+ type: string
714
+ BaseAnalyticsRepresentation:
715
+ description: Base analytic representation.
716
+ discriminator: id # TODO Hand-rolled W-15315791: Invalid discriminator
717
+ type: object
718
+ properties:
719
+ description:
720
+ description: Description of the asset.
721
+ type: string
722
+ required: false
723
+ id:
724
+ description: Database record id of the asset.
725
+ type: string
726
+ label:
727
+ description: Label of the asset.
728
+ type: string
729
+ required: false
730
+ name:
731
+ description: Name of the asset.
732
+ type: string
733
+ required: false
734
+ FlowCollectionRepresentation:
735
+ description: A collection of unified analytics flows.
736
+ type: object
737
+ properties:
738
+ flows:
739
+ description: List of flows being returned.
740
+ type: array
741
+ items:
742
+ type: FlowRepresentation
743
+ FlowRepresentation:
744
+ description: Unified analytics flow representation.
745
+ discriminator: id
746
+ type: object
747
+ properties:
748
+ description:
749
+ description: Description of the asset.
750
+ type: string
751
+ required: false
752
+ id:
753
+ description: Database record id of the asset.
754
+ type: string
755
+ label:
756
+ description: Label of the asset.
757
+ type: string
758
+ required: false
759
+ activeVersionId:
760
+ description: Flow active version id
761
+ type: string
762
+ required: false
763
+ apiName:
764
+ description: Flow API name
765
+ type: string
766
+ namespacePrefix:
767
+ description: Flow namespace prefix
768
+ type: string
769
+ required: false
770
+ processType:
771
+ description: Flow process type
772
+ type: string
773
+ required: false
774
+ metadata:
775
+ description: Flow metadata
776
+ type: FlowMetadataRepresentation
777
+ required: false
778
+ FlowMetadataRepresentation:
779
+ description: Unified analytics flow metadata representation.
780
+ discriminatorValue: FlowMetadata
781
+ type: object
782
+ properties:
783
+ variables:
784
+ description: Flow metadata variables.
785
+ type: array
786
+ items:
787
+ type: FlowVariableRepresentation
788
+ FlowVariableRepresentation:
789
+ description: Unified analytics flow variable representation.
790
+ discriminatorValue: FlowVariable
791
+ type: object
792
+ properties:
793
+ dataType:
794
+ description: Flow variable data type.
795
+ type: string
796
+ required: true
797
+ description:
798
+ description: Flow variable description.
799
+ type: string
800
+ required: false
801
+ isCollection:
802
+ description: Flow variable is collection flag.
803
+ type: boolean
804
+ required: true
805
+ isInput:
806
+ description: Flow variable input flag.
807
+ type: boolean
808
+ required: true
809
+ isOutput:
810
+ description: Flow variable output flag.
811
+ type: boolean
812
+ required: true
813
+ name:
814
+ description: Flow variable name.
815
+ type: string
816
+ required: true
817
+ objectType:
818
+ description: Flow object type.
819
+ type: string
820
+ required: false
821
+ value:
822
+ description: Flow variable value.
823
+ type: object
824
+ required: false
825
+ properties:
826
+ //:
827
+ type: any
828
+ DashboardCollectionRepresentation:
829
+ description: A collection of unified analytics dashboards.
830
+ type: object
831
+ properties:
832
+ dashboards:
833
+ description: List of dashboards being returned.
834
+ type: array
835
+ items:
836
+ type: DashboardRepresentation
837
+ DashboardAnchorInputRepresentation:
838
+ description: Details about the widget in unified analytics
839
+ type: object # TODO Hand Rolled
840
+ properties:
841
+ widgetId:
842
+ description: Widget ID
843
+ type: string
844
+ DashboardAnnotationAnchorRepresentation:
845
+ description: Unified Analytics dashboard annotation anchor representation
846
+ type: object # TODO Hand Rolled
847
+ properties:
848
+ widgetId:
849
+ description: The ID of the widget.
850
+ type: string
851
+ DashboardInputRepresentation:
852
+ description: Unified Analytics Dashboard Input Representation
853
+ type: object
854
+ properties:
855
+ description:
856
+ description: Description.
857
+ type: string
858
+ required: false
859
+ id:
860
+ description: Database id.
861
+ type: string
862
+ required: false
863
+ workspaceIdOrApiName:
864
+ description: The ID or ApiName of the workspace from which this dashboard originates.
865
+ type: string
866
+ required: false
867
+ label:
868
+ description: Master label.
869
+ type: string
870
+ name:
871
+ description: Unique developer name.
872
+ type: string
873
+ required: false
874
+ layouts:
875
+ description: List of layouts in the dashboard.
876
+ type: array
877
+ items:
878
+ type: any
879
+ widgets:
880
+ description: Map of widgets in the dashboard.
881
+ type: object
882
+ properties:
883
+ //:
884
+ type: any
885
+ style:
886
+ description: Dashboard level styling attributes.
887
+ type: object
888
+ required: false
889
+ properties:
890
+ //:
891
+ type: any
892
+ DashboardRepresentation:
893
+ description: Unified analytics dashboard representation.
894
+ discriminator: id
895
+ type: object
896
+ properties:
897
+ description:
898
+ description: Description of the asset.
899
+ type: string
900
+ required: false
901
+ id:
902
+ description: Database record id of the asset.
903
+ type: string
904
+ workspaceIdOrApiName:
905
+ description: The ID or ApiName of the workspace from which this dashboard originates.
906
+ type: string
907
+ required: false
908
+ label:
909
+ description: Label of the asset.
910
+ type: string
911
+ name:
912
+ description: Name of the asset.
913
+ type: string
914
+ createdBy:
915
+ description: Created by of the asset.
916
+ type: any
917
+ createdDate:
918
+ description: Created date of the asset
919
+ type: string
920
+ lastModifiedBy:
921
+ description: Last modified by of the asset.
922
+ type: any
923
+ required: false
924
+ lastModifiedDate:
925
+ description: Last modified date of the asset.
926
+ type: string
927
+ required: false
928
+ layouts:
929
+ description: All grid layouts for this dashboard.
930
+ type: array
931
+ items:
932
+ type: any
933
+ url:
934
+ description: URL to this dashboard.
935
+ type: string
936
+ widgets:
937
+ description: Widgets in the dashboard.
938
+ type: object
939
+ properties:
940
+ //:
941
+ type: any
942
+ style:
943
+ description: Dashboard level styling attributes.
944
+ type: object
945
+ required: false
946
+ properties:
947
+ //:
948
+ type: any
949
+ DataAssetDependentCollectionRepresentation:
950
+ description: Represents a List of dependent assets for a given asset
951
+ type: object
952
+ properties:
953
+ dependentDataAssets:
954
+ description: Array of Dependent Assets
955
+ type: array
956
+ items:
957
+ type: DataAssetDependentRepresentation
958
+ DataAssetDependentRepresentation:
959
+ description: Represents a Dependent asset
960
+ type: object
961
+ properties:
962
+ dataAsset:
963
+ description: Represents a Data asset
964
+ type: DataAssetRepresentation
965
+ DataAssetRepresentation:
966
+ description: Represents a Data asset
967
+ discriminator: assetId # TODO Hand-rolled W-17712133: invalid inheritance
968
+ type: object
969
+ properties:
970
+ id:
971
+ description: DataAsset id.
972
+ type: string
973
+ required: false
974
+ description:
975
+ description: Description of the DataAsset.
976
+ type: string
977
+ required: false
978
+ label:
979
+ description: Label of the DataAsset.
980
+ type: string
981
+ name:
982
+ description: Name of the DataAsset.
983
+ type: string
984
+ createdBy:
985
+ description: Created by of the DataAsset.
986
+ type: AnalyticsUserRepresentation
987
+ createdDate:
988
+ description: Created date of the DataAsset
989
+ type: string
990
+ required: false
991
+ lastModifiedBy:
992
+ description: Last modified by of the DataAsset.
993
+ type: AnalyticsUserRepresentation
994
+ lastModifiedDate:
995
+ description: Last modified date of the DataAsset.
996
+ type: string
997
+ assetId:
998
+ description: Represents id of the DataAsset
999
+ type: string
1000
+ assetType:
1001
+ description: Type of the DataAsset
1002
+ type: string
1003
+ enum:
1004
+ - AnalyticsDashboard
1005
+ - AnalyticsVisualization
1006
+ - MktCalculatedInsightsObject
1007
+ - MktDataModelObject
1008
+ - SemanticModel
1009
+ workspaceId:
1010
+ description: Id of the workspace which the DataAsset is part of
1011
+ type: string
1012
+ required: false
1013
+ synchronizationStatus:
1014
+ description: Synchronization status of the DataAsset
1015
+ type: string
1016
+ enum:
1017
+ - SYNC
1018
+ - NEW
1019
+ required: false
1020
+ createdWorkspace:
1021
+ description: Workspace where the DataAsset was created
1022
+ type: string
1023
+ required: false
1024
+ DataAssetRequestCollectionRepresentation:
1025
+ description: Collection of Data Asset Requests
1026
+ type: object
1027
+ properties:
1028
+ dataAssetRequests:
1029
+ description: List of data asset requests being returned
1030
+ type: array
1031
+ items:
1032
+ type: DataAssetRequestRepresentation
1033
+ DataAssetRequestCountRepresentation:
1034
+ description: Represents a data asset request count
1035
+ type: object
1036
+ properties:
1037
+ count:
1038
+ description: Count of data asset requests
1039
+ type: integer
1040
+ DataAlertCollectionRepresentation:
1041
+ description: A collection of unified analytics data alerts.
1042
+ type: object
1043
+ properties:
1044
+ dataAlerts:
1045
+ description: List of data alerts being returned.
1046
+ type: array
1047
+ items:
1048
+ type: DataAlertRepresentation
1049
+ totalSize:
1050
+ description: Total size of data alert array returned.
1051
+ type: integer
1052
+ nextPageUrl:
1053
+ description: Next page url for pagination.
1054
+ type: string | nil
1055
+ DataAlertValueInputRepresentation:
1056
+ description: Abstract input representation for operands
1057
+ type: object
1058
+ discriminator: type
1059
+ properties:
1060
+ type:
1061
+ description: type of operand
1062
+ type: string
1063
+ enum:
1064
+ - Insights
1065
+ - RawValue
1066
+ DataAlertValueRightOperandInputRepresentation:
1067
+ description: Abstract input representation for operands
1068
+ type: object
1069
+ discriminator: type
1070
+ properties:
1071
+ type:
1072
+ description: type of operand
1073
+ type: string
1074
+ enum:
1075
+ - Insights
1076
+ - RawValue
1077
+ DataAlertRawValueInputRepresentation:
1078
+ description: Abstract input representation for raw value operands
1079
+ type: DataAlertValueInputRepresentation
1080
+ discriminatorValue: RawValue
1081
+ properties:
1082
+ dataType:
1083
+ description: 'data types for the raw value: percentage, currency etc. '
1084
+ type: string
1085
+ enum:
1086
+ - Number
1087
+ - Currency
1088
+ - Percentage
1089
+ value:
1090
+ description: raw value of the operand
1091
+ type: string
1092
+ DataAlertMetricValueInputRepresentation:
1093
+ description: Input representation for metric operands
1094
+ type: DataAlertValueInputRepresentation
1095
+ discriminatorValue: Insights
1096
+ properties:
1097
+ metricId:
1098
+ description: metric or sub-metric Id
1099
+ type: string
1100
+ insightType:
1101
+ description: type of insight
1102
+ type: string
1103
+ enum:
1104
+ - GoalProgress
1105
+ - Popc
1106
+ - RecordLevelOutliers
1107
+ - RiskyMonopoly
1108
+ - Unspecified
1109
+ - UnusualChange
1110
+ params:
1111
+ description: additional metric params
1112
+ type: object
1113
+ properties:
1114
+ //:
1115
+ type: string
1116
+ factKey:
1117
+ description: fact key
1118
+ type: string
1119
+ timeContext:
1120
+ description: time filter
1121
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
1122
+ filterContext:
1123
+ description: filter context
1124
+ type: array
1125
+ items:
1126
+ type: UnifiedFilterInputRepresentation # TODO Hand-rolled @W-17927490
1127
+ modelApiNameOrId:
1128
+ description: Id or API name of the semantic data model
1129
+ type: string
1130
+ sdmId:
1131
+ description: SDM ID of the semantic data model
1132
+ type: string
1133
+ UnifiedFilterInputRepresentation:
1134
+ description: Message representing the Unified Filter.
1135
+ type: object
1136
+ properties:
1137
+ fieldName:
1138
+ description: FieldName
1139
+ type: string
1140
+ required: false
1141
+ operator:
1142
+ enum:
1143
+ - Equals
1144
+ - DoesNotEquals
1145
+ - EqualsIgnoreCase
1146
+ - DoesNotEqualsIgnoreCase
1147
+ - Between
1148
+ - LessThan
1149
+ - LessThanOrEqualTo
1150
+ - GreaterThan
1151
+ - GreaterThanOrEqualTo
1152
+ - IsEmpty
1153
+ - IsNotEmpty
1154
+ - Contains
1155
+ - ContainsIgnoreCase
1156
+ - NotContains
1157
+ - NotContainsIgnoreCase
1158
+ - StartsWith
1159
+ - StartsWithIgnoreCase
1160
+ - DoesNotStartWith
1161
+ - DoesNotStartWithIgnoreCase
1162
+ - EndsWith
1163
+ - EndsWithIgnoreCase
1164
+ - DoesNotEndWith
1165
+ - DoesNotEndWithIgnoreCase
1166
+ - IsNull
1167
+ - IsNotNull
1168
+ - LastNDays
1169
+ - NextNDays
1170
+ - PreviousWeek
1171
+ - CurrentWeek
1172
+ - NextWeek
1173
+ - PreviousMonth
1174
+ - CurrentMonth
1175
+ - NextMonth
1176
+ - PreviousQuarter
1177
+ - CurrentQuarter
1178
+ - NextQuarter
1179
+ - PreviousYear
1180
+ - CurrentYear
1181
+ - NextYear
1182
+ - PreviousFiscalQuarter
1183
+ - CurrentFiscalQuarter
1184
+ - NextFiscalQuarter
1185
+ - PreviousFiscalYear
1186
+ - CurrentFiscalYear
1187
+ - NextFiscalYear
1188
+ - PreviousMonthToDate
1189
+ - CurrentMonthToDate
1190
+ - PreviousQuarterToDate
1191
+ - CurrentQuarterToDate
1192
+ - PreviousYearToDate
1193
+ - CurrentYearToDate
1194
+ - PreviousFiscalQuarterToDate
1195
+ - CurrentFiscalQuarterToDate
1196
+ - PreviousFiscalYearToDate
1197
+ - CurrentFiscalYearToDate
1198
+ - Values
1199
+ type: string
1200
+ (amf-format): enum
1201
+ required: false
1202
+ values:
1203
+ description: An array of values. All values must be of the same type. We support strings, numbers, and booleans.
1204
+ type: array
1205
+ items:
1206
+ (amf-xone):
1207
+ - type: number
1208
+ - type: string
1209
+ - type: boolean
1210
+ type: any
1211
+ required: false
1212
+ DataAlertConditionInputRepresentation:
1213
+ description: A single condition representation
1214
+ type: object
1215
+ properties:
1216
+ leftOperand:
1217
+ description: Left operand of the condition
1218
+ type: DataAlertValueInputRepresentation # TODO Hand-rolled @W-17927490
1219
+ rightOperand:
1220
+ description: Right operand of the condition
1221
+ type: DataAlertValueRightOperandInputRepresentation # TODO Hand-rolled @W-17927490
1222
+ operator:
1223
+ description: operator of the condition
1224
+ type: string
1225
+ enum:
1226
+ - Equals
1227
+ - GreaterOrEqual
1228
+ - GreaterThan
1229
+ - LessOrEqual
1230
+ - LessThan
1231
+ - NotEqual
1232
+ DataAlertWeeklyScheduleInputRepresentation:
1233
+ description: Input representation for weekly alert alert schedule
1234
+ type: DataAlertScheduleInputRepresentation
1235
+ discriminatorValue: Weekly
1236
+ properties:
1237
+ daysOfWeek:
1238
+ description: days of the week to receive data alerts
1239
+ type: array
1240
+ items:
1241
+ type: string
1242
+ enum:
1243
+ - Friday
1244
+ - Monday
1245
+ - Saturday
1246
+ - Sunday
1247
+ - Thursday
1248
+ - Tuesday
1249
+ - Wednesday
1250
+ DataAlertContentInputRepresentation:
1251
+ description: Input representation for data alert content
1252
+ type: object
1253
+ discriminator: type
1254
+ properties:
1255
+ type:
1256
+ description: content type
1257
+ type: string
1258
+ enum:
1259
+ - Metric
1260
+ DataAlertMetricContentInputRepresentation:
1261
+ description: Input representation for content based on metric value
1262
+ type: DataAlertContentInputRepresentation
1263
+ discriminatorValue: Metric
1264
+ properties:
1265
+ instruction:
1266
+ description: input string instruction
1267
+ type: string
1268
+ modelApiNameOrId:
1269
+ description: Id or API name of the semantic data model
1270
+ type: array
1271
+ items:
1272
+ type: string
1273
+ DataAlertDailyScheduleInputRepresentation:
1274
+ description: Input representation for daily alert schedule
1275
+ type: DataAlertScheduleInputRepresentation
1276
+ discriminatorValue: Daily
1277
+ properties: {}
1278
+ DataAlertDeliveryConfigurationInputRepresentation:
1279
+ description: Delivery configuration for data alerts.
1280
+ type: object
1281
+ properties:
1282
+ receivers:
1283
+ description: list of recipients to be notified.
1284
+ type: array
1285
+ items:
1286
+ type: DataAlertReceiversInputRepresentation
1287
+ DataAlertInputRepresentation:
1288
+ description: A top level data alert metadata representation.
1289
+ type: object
1290
+ properties:
1291
+ analysisUtterance:
1292
+ description: user entered utterance for generating analysis.
1293
+ type: string
1294
+ content:
1295
+ type: DataAlertContentInputRepresentation # TODO Hand-rolled @W-17927490
1296
+ deliveryConfigurations:
1297
+ type: DataAlertDeliveryConfigurationInputRepresentation # TODO Hand-rolled @W-17927490
1298
+ schedule:
1299
+ description: data alert schedule
1300
+ type: DataAlertScheduleInputRepresentation # TODO Hand-rolled @W-17927490
1301
+ thresholds:
1302
+ description: thresholds to be evaluated
1303
+ type: DataAlertThresholdsInputRepresentation # TODO Hand-rolled @W-17927490
1304
+ utterance:
1305
+ description: user entered utterance
1306
+ type: string
1307
+ DataAlertNotificationRecipientsInputRepresentation:
1308
+ description: 'List of UNS recipients for Data alerts. May contain user or group
1309
+ Ids. '
1310
+ type: DataAlertReceiversInputRepresentation
1311
+ discriminatorValue: Notification
1312
+ properties:
1313
+ recipients:
1314
+ description: group or user Ids
1315
+ type: array
1316
+ items:
1317
+ type: string
1318
+ DataAlertReceiversInputRepresentation:
1319
+ description: Input representation for data alert recipients
1320
+ type: object
1321
+ discriminator: type
1322
+ properties:
1323
+ type:
1324
+ description: delivery type
1325
+ type: string
1326
+ enum:
1327
+ - Notification
1328
+ DataAlertScheduleInputRepresentation:
1329
+ description: Input representation for data alert schedule
1330
+ discriminator: type
1331
+ type: object
1332
+ properties:
1333
+ hoursOfDay:
1334
+ description: schedule time
1335
+ type: array
1336
+ items:
1337
+ type: integer
1338
+ type:
1339
+ description: schedule type
1340
+ type: string
1341
+ enum:
1342
+ - Cron
1343
+ - Daily
1344
+ - Weekly
1345
+ DataAlertThresholdsInputRepresentation:
1346
+ description: Data alert thresholds input representation.
1347
+ type: object
1348
+ properties:
1349
+ conditions:
1350
+ description: list of conditions to be evaluated.
1351
+ type: array
1352
+ items:
1353
+ type: DataAlertConditionInputRepresentation
1354
+ customLogicalOperation:
1355
+ description: logical operations between conditions
1356
+ type: string
1357
+ DataAlertRunOutputRepresentation:
1358
+ description: Output of running a Data Alert
1359
+ type: object
1360
+ properties:
1361
+ executedAt:
1362
+ description: Timestamp when the data alert was executed.
1363
+ type: string
1364
+ id:
1365
+ description: Database record id of the data alert.
1366
+ type: string
1367
+ triggered:
1368
+ description: Whether the data alert was triggered by this run.
1369
+ type: boolean
1370
+ DataAlertConditionRepresentation:
1371
+ description: Represents a condition for a data alert
1372
+ type: object
1373
+ properties:
1374
+ leftOperand:
1375
+ description: Left operand of the condition
1376
+ type: DataAlertValueRepresentation
1377
+ operator:
1378
+ description: Operator for the condition
1379
+ type: string
1380
+ enum:
1381
+ - Equals
1382
+ - GreaterOrEqual
1383
+ - GreaterThan
1384
+ - LessOrEqual
1385
+ - LessThan
1386
+ - NotEqual
1387
+ rightOperand:
1388
+ description: Right operand of the condition
1389
+ type: DataAlertValueRepresentation
1390
+ DataAlertContentRepresentation:
1391
+ description: Represents the content for a data alert
1392
+ type: object
1393
+ discriminator: type
1394
+ properties:
1395
+ type:
1396
+ description: Type of content
1397
+ type: string
1398
+ enum:
1399
+ - Metric
1400
+ DataAlertCronScheduleRepresentation:
1401
+ description: Represents the cron schedule for a data alert
1402
+ type: DataAlertScheduleRepresentation
1403
+ properties:
1404
+ cronExpression:
1405
+ description: Cron expression for the schedule
1406
+ type: string
1407
+ DataAlertDailyScheduleRepresentation:
1408
+ description: Represents the daily schedule for a data alert
1409
+ type: DataAlertScheduleRepresentation
1410
+ properties: {}
1411
+ DataAlertDeliveryConfigurationRepresentation:
1412
+ description: Represents the delivery configuration for a data alert
1413
+ type: object
1414
+ properties:
1415
+ receivers:
1416
+ description: Receivers for the data alert
1417
+ type: array
1418
+ items:
1419
+ type: DataAlertReceiversRepresentation
1420
+ DataAlertMetricContentRepresentation:
1421
+ description: Represents the metric content for a data alert
1422
+ type: DataAlertContentRepresentation
1423
+ properties:
1424
+ instruction:
1425
+ description: Instructions to generate notification content
1426
+ type: string
1427
+ modelApiNameOrId:
1428
+ description: Id or API name of the semantic data model
1429
+ type: array
1430
+ items:
1431
+ type: string
1432
+ DataAlertMetricValueRepresentation:
1433
+ description: Represents a metric value for a data alert condition
1434
+ type: DataAlertValueRepresentation
1435
+ properties:
1436
+ factKey:
1437
+ description: fact key
1438
+ type: string
1439
+ filterContext:
1440
+ description: filter context
1441
+ type: array
1442
+ items:
1443
+ type: UnifiedFilterRepresentation
1444
+ insightType:
1445
+ description: type of insight
1446
+ type: string
1447
+ enum:
1448
+ - GoalProgress
1449
+ - Popc
1450
+ - RecordLevelOutliers
1451
+ - RiskyMonopoly
1452
+ - Unspecified
1453
+ - UnusualChange
1454
+ metricId:
1455
+ description: metric or sub-metric Id
1456
+ type: string
1457
+ modelApiNameOrId:
1458
+ description: Id or API name of the semantic data model
1459
+ type: string
1460
+ params:
1461
+ description: additional metric params
1462
+ type: object
1463
+ properties:
1464
+ //:
1465
+ type: string
1466
+ timeContext:
1467
+ description: time filter
1468
+ type: UnifiedFilterRepresentation
1469
+ DataAlertNotificationRecipientsRepresentation:
1470
+ description: Represents notification recipients for a data alert
1471
+ type: DataAlertReceiversRepresentation
1472
+ properties:
1473
+ recipients:
1474
+ description: list of notification recipients
1475
+ type: array
1476
+ items:
1477
+ type: string
1478
+ DataAlertRawValueRepresentation:
1479
+ description: Represents a raw value for a data alert condition
1480
+ type: DataAlertValueRepresentation
1481
+ properties:
1482
+ dataType:
1483
+ description: Data type of the raw value
1484
+ type: string
1485
+ enum:
1486
+ - Number
1487
+ - Percent
1488
+ - Text
1489
+ value:
1490
+ description: Raw value
1491
+ type: string
1492
+ DataAlertReceiversRepresentation:
1493
+ description: Represents receivers for a data alert
1494
+ type: object
1495
+ discriminator: type
1496
+ properties:
1497
+ type:
1498
+ description: delivery type
1499
+ type: string
1500
+ enum:
1501
+ - Notification
1502
+ DataAlertRepresentation:
1503
+ description: Output representation for Data Alert
1504
+ discriminatorValue: DataAlert
1505
+ type: object #Hand-rolled W-18183450: invalid inheritance
1506
+ properties:
1507
+ id:
1508
+ description: ID of the Data Alert
1509
+ type: string
1510
+ alertName:
1511
+ description: User entered alert name.
1512
+ type: string
1513
+ content:
1514
+ description: Notification content configuration. Contains the config needed
1515
+ to generate the notification content.
1516
+ type: DataAlertContentRepresentation
1517
+ deliveryConfigurations:
1518
+ description: Data alert delivery configurations.
1519
+ type: DataAlertDeliveryConfigurationRepresentation
1520
+ createdDate:
1521
+ description: Creation date of the data alert
1522
+ type: string
1523
+ lastModifiedDate:
1524
+ description: Last modified date of the data alert
1525
+ type: string
1526
+ schedule:
1527
+ description: Data alert schedule.
1528
+ type: DataAlertScheduleRepresentation
1529
+ thresholds:
1530
+ description: Thresholds to be evaluated.
1531
+ type: DataAlertThresholdsRepresentation
1532
+ DataAlertScheduleRepresentation:
1533
+ description: Represents the schedule for a data alert
1534
+ type: object
1535
+ discriminator: type
1536
+ properties:
1537
+ hoursOfDay:
1538
+ description: Schedule time
1539
+ type: array
1540
+ items:
1541
+ type: integer
1542
+ type:
1543
+ description: Type of schedule
1544
+ type: string
1545
+ enum:
1546
+ - Cron
1547
+ - Daily
1548
+ - Weekly
1549
+ DataAlertThresholdsRepresentation:
1550
+ description: Represents the thresholds for a data alert
1551
+ type: object
1552
+ properties:
1553
+ conditions:
1554
+ description: Conditions for the data alert
1555
+ type: array
1556
+ items:
1557
+ type: DataAlertConditionRepresentation
1558
+ customLogicalOperation:
1559
+ description: Logical operations between conditions
1560
+ type: string
1561
+ DataAlertValueRepresentation:
1562
+ description: Represents a value for a data alert condition
1563
+ discriminator: type
1564
+ type: object
1565
+ properties:
1566
+ type:
1567
+ description: Type of data value
1568
+ type: string
1569
+ enum:
1570
+ - Insights
1571
+ - RawValue
1572
+ DataAlertWeeklyScheduleRepresentation:
1573
+ description: Represents the weekly schedule for a data alert
1574
+ type: DataAlertScheduleRepresentation
1575
+ properties:
1576
+ daysOfWeek:
1577
+ description: Days of the week for the schedule
1578
+ type: array
1579
+ items:
1580
+ type: string
1581
+ enum:
1582
+ - Friday
1583
+ - Monday
1584
+ - Saturday
1585
+ - Sunday
1586
+ - Thursday
1587
+ - Tuesday
1588
+ - Wednesday
1589
+ DataAssetRequestInputRepresentation:
1590
+ description: DataAssetRequest input representation in unified analytics.
1591
+ type: object
1592
+ properties:
1593
+ assetId:
1594
+ description: Id of Asset being promoted
1595
+ type: string
1596
+ required: false
1597
+ id:
1598
+ description: Id for the request
1599
+ type: string
1600
+ required: false
1601
+ label:
1602
+ description: Label to be used for the request
1603
+ type: string
1604
+ required: false
1605
+ numberOfDependencies:
1606
+ description: Number of dependencies associated with the asset being tracked
1607
+ type: integer
1608
+ required: false
1609
+ rejectionComment:
1610
+ description: Rejection comment
1611
+ type: string
1612
+ required: false
1613
+ requestType:
1614
+ description: Type of the request
1615
+ type: string
1616
+ required: false
1617
+ enum:
1618
+ - Promotion
1619
+ - Reuse
1620
+ requesterComment:
1621
+ description: Requester comment
1622
+ type: string
1623
+ required: false
1624
+ sourceRequestId:
1625
+ description: Id for the source request
1626
+ type: string
1627
+ required: false
1628
+ status:
1629
+ description: Status of the request
1630
+ type: string
1631
+ required: false
1632
+ enum:
1633
+ - Accepted
1634
+ - Cancelled
1635
+ - Completed
1636
+ - Extracting
1637
+ - ExtractionComplete
1638
+ - Failed
1639
+ - ManageAccess
1640
+ - ManageCsv
1641
+ - ManageDataPolicy
1642
+ - MarkAcceptedOrRejected
1643
+ - MarkComplete
1644
+ - Migrating
1645
+ - MigrationSucceeded
1646
+ - Rejected
1647
+ - Requested
1648
+ - ReviewContent
1649
+ workspaceIdOrApiName:
1650
+ description: Workspace id or name of personal org related to the request
1651
+ type: string
1652
+ required: false
1653
+ DataAssetRequestRepresentation:
1654
+ description: Represents a data asset request
1655
+ type: object
1656
+ properties:
1657
+ acknowledgedBy:
1658
+ description: The user who approved or rejected this request
1659
+ type: AnalyticsUserRepresentation | nil
1660
+ acknowledgedDate:
1661
+ description: Acknowledged date
1662
+ type: string | nil
1663
+ assetId:
1664
+ description: assetId associated with the request
1665
+ type: string
1666
+ assetLabel:
1667
+ description: Asset Label
1668
+ type: string | nil
1669
+ cancelledBy:
1670
+ description: The user who cancelled this request
1671
+ type: AnalyticsUserRepresentation | nil
1672
+ cancelledDate:
1673
+ description: Cancelled date
1674
+ type: string | nil
1675
+ completedBy:
1676
+ description: The user who completed this request
1677
+ type: AnalyticsUserRepresentation | nil
1678
+ completedDate:
1679
+ description: Completed date
1680
+ type: string | nil
1681
+ failedDate:
1682
+ description: Failed date
1683
+ type: string | nil
1684
+ lastModifiedDate:
1685
+ description: Last modified date for the data asset record
1686
+ type: string
1687
+ lastModifiedBy:
1688
+ description: The user who last modified this request
1689
+ type: AnalyticsUserRepresentation
1690
+ id:
1691
+ description: Data Asset Request Id
1692
+ type: string
1693
+ installedDate:
1694
+ description: Installed date
1695
+ type: string | nil
1696
+ label:
1697
+ description: Data Asset Request Label
1698
+ type: string
1699
+ migrationSucceededDate:
1700
+ description: Migration Succeeded date
1701
+ type: string | nil
1702
+ numberOfDependencies:
1703
+ description: Number of dependencies associated with workspace asset being
1704
+ tracked in the request
1705
+ type: integer | nil
1706
+ personalOrgId:
1707
+ description: ID of personal org
1708
+ type: string | nil
1709
+ personalOrgWorkspaceId:
1710
+ description: Workspace ID from personal org
1711
+ type: string | nil
1712
+ productionOrgId:
1713
+ description: ID of production org
1714
+ type: string | nil
1715
+ productionOrgWorkspaceId:
1716
+ description: Workspace ID from production org
1717
+ type: string | nil
1718
+ rejectionComment:
1719
+ description: Rejection Comment
1720
+ type: string | nil
1721
+ requestType:
1722
+ description: Type of the request
1723
+ type: string
1724
+ enum:
1725
+ - Promotion
1726
+ - Reuse
1727
+ requestedBy:
1728
+ description: The user who requested this request
1729
+ type: AnalyticsUserRepresentation
1730
+ requestedDate:
1731
+ description: Requested date
1732
+ type: string
1733
+ requesterComment:
1734
+ description: Requester Comment
1735
+ type: string
1736
+ sourceRequestId:
1737
+ description: Data Asset Request Source Id
1738
+ type: string | nil
1739
+ status:
1740
+ description: Data Asset Request Status
1741
+ type: string
1742
+ enum:
1743
+ - Accepted
1744
+ - Cancelled
1745
+ - Completed
1746
+ - Extracting
1747
+ - ExtractionComplete
1748
+ - Failed
1749
+ - ManageAccess
1750
+ - ManageCsv
1751
+ - ManageDataPolicy
1752
+ - MarkAcceptedOrRejected
1753
+ - MarkComplete
1754
+ - Migrating
1755
+ - MigrationSucceeded
1756
+ - Rejected
1757
+ - Requested
1758
+ - ReviewContent
1759
+ targetRequestId:
1760
+ description: Data Asset Request Target Id
1761
+ type: string | nil
1762
+ workspaceAssetId:
1763
+ description: workspaceAssetId in the workspace
1764
+ type: string
1765
+ TableauMarketplaceListingInstallationProgressResponse:
1766
+ description: Representation of tableau marketplace's listing installation progress
1767
+ type: object
1768
+ properties:
1769
+ errors:
1770
+ description: Errors while installing the package
1771
+ type: array
1772
+ items:
1773
+ type: string
1774
+ id:
1775
+ description: The ID of the package installation request
1776
+ type: string
1777
+ status:
1778
+ description: Latest Status of Package installation request
1779
+ type: string
1780
+ TableauMarketplaceListingInstallationResponse:
1781
+ description: Representation of tableau marketplace's listing installation response
1782
+ type: object
1783
+ properties:
1784
+ packageInstallRequestID:
1785
+ description: The ID of the package installation request
1786
+ type: string
1787
+ success:
1788
+ description: Whether or not package installation request succeeds
1789
+ type: boolean
1790
+ AnalyticsLibraryCollectionQueryInputRepresentation:
1791
+ description: Input representation for Analytics Library Listing API
1792
+ type: object
1793
+ properties:
1794
+ assetTypes:
1795
+ description: 'AssetType Ex: App, Dashboard'
1796
+ type: array
1797
+ items:
1798
+ type: string | nil
1799
+ categoryFilters:
1800
+ description: Filters to filter analyticsLibrary templates based on assetTypes
1801
+ type: object
1802
+ required: false
1803
+ properties:
1804
+ //:
1805
+ type: array
1806
+ items:
1807
+ type: string | nil
1808
+ limit:
1809
+ description: Number of templates to retrieve
1810
+ type: integer | nil
1811
+ required: false
1812
+ offset:
1813
+ description: Offset
1814
+ type: integer | nil
1815
+ required: false
1816
+ searchToken:
1817
+ description: SearchToken to filter analytics library assets on name or description
1818
+ type: string | nil
1819
+ required: false
1820
+ sortBy:
1821
+ description: Sort by field
1822
+ type: string
1823
+ required: false
1824
+ enum:
1825
+ - Name
1826
+ sortDirection:
1827
+ description: Sort direction
1828
+ type: string
1829
+ required: false
1830
+ enum:
1831
+ - Ascending
1832
+ - Descending
1833
+ AnalyticsLibraryDashboardTemplateRepresentation:
1834
+ description: Output representation of dashboard template preview in analytics
1835
+ library
1836
+ type: BaseAnalyticsLibraryAssetRepresentation
1837
+ properties:
1838
+ templateBadge:
1839
+ description: The badge icon configured for template
1840
+ type: string
1841
+ templatePreviews:
1842
+ description: The preview images configured for the template
1843
+ type: array
1844
+ items:
1845
+ type: string
1846
+ AnalyticsLibraryImageRepresentation:
1847
+ description: AnalyticsLibrary Image reference representation
1848
+ type: object
1849
+ properties:
1850
+ url:
1851
+ description: Url path to retrieve image
1852
+ type: string
1853
+ SlackMessageOutputRepresentation: #Copy from lds-adapters-service-slack
1854
+ description: Contains the details of Slack Message
1855
+ type: object
1856
+ properties:
1857
+ appId:
1858
+ description: Id of the Slack App
1859
+ type: string
1860
+ broadcastThreadTs:
1861
+ description: Thread where the reply belong to (if this message is a broadcasted
1862
+ reply)
1863
+ type: string | nil
1864
+ channelId:
1865
+ description: Id of the Channel to which this message belong to
1866
+ type: string
1867
+ files:
1868
+ description: List of files attached to this message
1869
+ type: array
1870
+ items:
1871
+ type: SlackFileOutputRepresentation
1872
+ includesCustomEmoji:
1873
+ description: Does this message includes Custom emoji?
1874
+ type: boolean | nil
1875
+ isBroadcast:
1876
+ description: Is this a reply also sent to the Channel?
1877
+ type: boolean | nil
1878
+ isEditable:
1879
+ description: Can this message be edited?
1880
+ type: boolean
1881
+ isEdited:
1882
+ description: Is this an edited message?
1883
+ type: boolean | nil
1884
+ isFileReadAllowed:
1885
+ description: Does the App contains required scopes to read Slack files?
1886
+ type: boolean | nil
1887
+ latestReplyTimestamp:
1888
+ description: Latest Reply timestamp
1889
+ type: string | nil
1890
+ message:
1891
+ description: Content of the Message
1892
+ type: string
1893
+ messageEpochMillisecond:
1894
+ description: Epoch (Millisecond) Timestamp of the Message
1895
+ format: double
1896
+ type: number
1897
+ outbound:
1898
+ description: Is this a message sent by the context User?
1899
+ type: boolean
1900
+ reactions:
1901
+ description: List of reactions added to this message
1902
+ type: array
1903
+ items:
1904
+ type: SlackReactionOutputRepresentation
1905
+ replyCount:
1906
+ description: Number of replies for this message
1907
+ type: integer | nil
1908
+ replyUsers:
1909
+ description: List of Users who replied to this message
1910
+ type: array
1911
+ items:
1912
+ type: SlackUserInfoOutputRepresentation
1913
+ replyUsersCount:
1914
+ description: Number of users who replied to this message
1915
+ type: integer | nil
1916
+ slackMessageTs:
1917
+ description: Timestamp of the Message
1918
+ type: string
1919
+ subtype:
1920
+ description: Sub-type of Message
1921
+ type: string | nil
1922
+ teamId:
1923
+ description: Id of the Team to which this message belong to
1924
+ type: string
1925
+ threadTs:
1926
+ description: Timestamp of the thread to which this message belong to
1927
+ type: string | nil
1928
+ type:
1929
+ description: Type of Message
1930
+ type: string | nil
1931
+ uniqueKey:
1932
+ description: Unique Key for this message
1933
+ type: string
1934
+ url:
1935
+ description: Url for this message
1936
+ type: string
1937
+ userInfo:
1938
+ description: Details of the Slack User who posted this message
1939
+ type: SlackUserInfoOutputRepresentation
1940
+ SlackReactionOutputRepresentation:
1941
+ description: Contains the details of Slack reaction
1942
+ type: object
1943
+ properties:
1944
+ count:
1945
+ description: Number of reactions
1946
+ type: integer | nil
1947
+ hasUserReacted:
1948
+ description: Has the context user reacted?
1949
+ type: boolean
1950
+ isCustomEmoji:
1951
+ description: Is this a custom emoji?
1952
+ type: boolean | nil
1953
+ messageTs:
1954
+ description: Timestamp of the Slack message where this reaction was made
1955
+ type: string
1956
+ name:
1957
+ description: Name of the reaction
1958
+ type: string
1959
+ reactedUsers:
1960
+ description: Users who made this reaction
1961
+ type: array
1962
+ items:
1963
+ type: SlackUserInfoOutputRepresentation
1964
+ unicode:
1965
+ description: Unicode for the reaction
1966
+ type: string | nil
1967
+ uniqueKey:
1968
+ description: Unique Key for this reaction specific to a particular Slack message
1969
+ type: string | nil
1970
+ url:
1971
+ description: Url for the reaction
1972
+ type: string | nil
1973
+ SlackFileOutputRepresentation:
1974
+ description: Contains the details of files attached to the Slack Message
1975
+ type: object
1976
+ properties:
1977
+ contentDocument:
1978
+ description: Content Document data
1979
+ type: ContentDocumentOutputRepresentation | nil
1980
+ filetype:
1981
+ description: Type of the File
1982
+ type: string
1983
+ id:
1984
+ description: Slack Id of the File
1985
+ type: string
1986
+ mimetype:
1987
+ description: Mime type of the File
1988
+ type: string
1989
+ name:
1990
+ description: Name of the File
1991
+ type: string
1992
+ size:
1993
+ description: Size of the File
1994
+ type: integer
1995
+ slackPermalink:
1996
+ description: Slack Permalink for the File
1997
+ type: string
1998
+ title:
1999
+ description: Title of the File
2000
+ type: string
2001
+ token:
2002
+ description: Token used for the File
2003
+ type: string | nil
2004
+ uniqueKey:
2005
+ description: Unique Key for the File
2006
+ type: string
2007
+ url:
2008
+ description: Slack web URL for the File
2009
+ type: string
2010
+ ContentDocumentOutputRepresentation:
2011
+ description: Contains the details of Content Document
2012
+ type: object
2013
+ properties:
2014
+ filetype:
2015
+ description: File type of the Content Document record
2016
+ type: FileTypeOutputRepresentation
2017
+ id:
2018
+ description: Id of the Content Document record
2019
+ type: string
2020
+ latestPublishedVersion:
2021
+ description: Document URL for the Content Document record
2022
+ type: ContentVersionOutputRepresentation
2023
+ size:
2024
+ description: Size of the Content Document record
2025
+ type: integer
2026
+ title:
2027
+ description: Title of the Content Document record
2028
+ type: string
2029
+ ContentVersionOutputRepresentation:
2030
+ description: Contains the details of Content Version
2031
+ type: object
2032
+ properties:
2033
+ attachmentUrl:
2034
+ description: Attachment URL for the Content Version record
2035
+ type: string
2036
+ filetype:
2037
+ description: File type of the Content Version record
2038
+ type: FileTypeOutputRepresentation | nil
2039
+ id:
2040
+ description: Id of the Content Version record
2041
+ type: string
2042
+ size:
2043
+ description: Size of the Content Version record
2044
+ type: integer
2045
+ title:
2046
+ description: Title of the Content Version record
2047
+ type: string
2048
+ versionUrl:
2049
+ description: Version URL for the Content Version record
2050
+ type: string | nil
2051
+ FileTypeOutputRepresentation:
2052
+ description: Contains the details of FileType
2053
+ type: object
2054
+ properties:
2055
+ extension:
2056
+ description: Extension of the File
2057
+ type: string
2058
+ iconName:
2059
+ description: Icon Name of the File
2060
+ type: string
2061
+ MarketplaceTemplateInputRepresentation:
2062
+ description: Input representation for Marketplace Template Info.
2063
+ type: object
2064
+ properties:
2065
+ assetIdOrApiName:
2066
+ description: The source asset Id.
2067
+ type: string
2068
+ assetType:
2069
+ description: The source asset type.
2070
+ type: string
2071
+ description:
2072
+ description: The Template description.
2073
+ type: string
2074
+ label:
2075
+ description: The label of the template.
2076
+ type: string
2077
+ name:
2078
+ description: The Template name.
2079
+ type: string
2080
+ tags:
2081
+ description: The tags associated with the template.
2082
+ type: object
2083
+ properties:
2084
+ //:
2085
+ type: array
2086
+ items:
2087
+ type: string
2088
+ MarketplaceTemplateOutputRepresentation:
2089
+ description: Id of template created
2090
+ type: object
2091
+ properties:
2092
+ id:
2093
+ description: The ID of template
2094
+ type: string
2095
+ MarketplaceListingInputRepresentation:
2096
+ description: Input representation to publish asset to Marketplace.
2097
+ type: object
2098
+ properties:
2099
+ assetId:
2100
+ description: The ID of the asset.
2101
+ type: string
2102
+ assetType:
2103
+ description: The type of the asset.
2104
+ type: string
2105
+ enum:
2106
+ - DominoTemplate
2107
+ assetVersion:
2108
+ description: The version of the asset.
2109
+ type: number
2110
+ required: false
2111
+ MarketplaceListingRepresentation:
2112
+ description: The ID of marketplace listings.
2113
+ type: object
2114
+ properties:
2115
+ id:
2116
+ description: The ID of marketplace listings.
2117
+ type: string
2118
+ OrgCollectionRepresentation:
2119
+ description: A collection of unified analytics orgs.
2120
+ type: object
2121
+ properties:
2122
+ personalOrgs:
2123
+ description: List of Personal Orgs.
2124
+ type: array
2125
+ items:
2126
+ type: OrgRepresentation
2127
+ productionOrg:
2128
+ description: Production Org.
2129
+ type: OrgRepresentation
2130
+ OrgRepresentation:
2131
+ description: Unified analytics org representation.
2132
+ discriminatorValue: Org
2133
+ type: object
2134
+ properties:
2135
+ id:
2136
+ description: ID of this org.
2137
+ type: string
2138
+ isCurrentOrg:
2139
+ description: Is user currently logged in this org
2140
+ type: boolean
2141
+ label:
2142
+ description: Named label to display for this org
2143
+ type: string
2144
+ targetUrl:
2145
+ description: URL to switch to this org.
2146
+ type: string
2147
+ SetupRecordAccessCollectionRepresentation:
2148
+ description: A collection of record access mapping
2149
+ type: object
2150
+ properties:
2151
+ recordAccessMappings:
2152
+ description: List of shares being returned for a record
2153
+ type: array
2154
+ items:
2155
+ type: SetupRecordAccessRepresentation
2156
+ recordId:
2157
+ description: Id for record
2158
+ type: string
2159
+ SetupRecordAccessInputRepresentation:
2160
+ description: User Or Role Access Input Representation
2161
+ type: object
2162
+ properties:
2163
+ accessRequestItems:
2164
+ description: List of records shares
2165
+ type: array
2166
+ items:
2167
+ type: any
2168
+ sendNotificationToRecipients:
2169
+ description: check for sending notification to recipients
2170
+ type: boolean
2171
+ required: false
2172
+ SetupRecordAccessItemInputRepresentation:
2173
+ description: Record Access Item Input Representation
2174
+ type: object
2175
+ properties:
2176
+ accessType:
2177
+ description: Usage type of the asset.
2178
+ type: string
2179
+ enum:
2180
+ - Commenter
2181
+ - Editor
2182
+ - Manager
2183
+ - Viewer
2184
+ applicationDomain:
2185
+ description: Application Domain Type
2186
+ type: string
2187
+ enum:
2188
+ - Tableau
2189
+ setupObjectType:
2190
+ description: Type of the asset.
2191
+ type: string
2192
+ enum:
2193
+ - AnalyticsDashboard
2194
+ - AnalyticsVisualization
2195
+ - AnalyticsWorkspace
2196
+ userOrGroupId:
2197
+ description: Id of the User/Group
2198
+ type: string
2199
+ SetupRecordShareUserOrGroupRepresentation:
2200
+ description: User or Group Representation
2201
+ type: object
2202
+ properties:
2203
+ id:
2204
+ description: Id of the User or Group
2205
+ type: string
2206
+ required: false
2207
+ displayName:
2208
+ description: Display name of the User or Group
2209
+ type: string
2210
+ required: false
2211
+ profilePhotoUrl:
2212
+ description: Profile Photo URL of the User
2213
+ type: string
2214
+ required: false
2215
+ email:
2216
+ description: Email of the User
2217
+ type: string
2218
+ required: false
2219
+ username:
2220
+ description: Username of the User
2221
+ type: string
2222
+ required: false
2223
+ groupMemberCount:
2224
+ description: Count of users in group
2225
+ type: integer
2226
+ required: false
2227
+ SetupRecordAccessRepresentation:
2228
+ description: Record Access mapping for specific UserOrGroup
2229
+ discriminatorValue: RecordAccessMappingForUserOrGroup
2230
+ type: object
2231
+ properties:
2232
+ accessType:
2233
+ description: Access Type For Object.
2234
+ type: string
2235
+ enum:
2236
+ - Commenter
2237
+ - Editor
2238
+ - Manager
2239
+ - Viewer
2240
+ applicationDomain:
2241
+ description: Type of Application Domain
2242
+ type: string
2243
+ enum:
2244
+ - Tableau
2245
+ userOrGroupId:
2246
+ description: User/Group Id
2247
+ type: string
2248
+ userOrGroup:
2249
+ description: User/Group
2250
+ type: SetupRecordShareUserOrGroupRepresentation
2251
+ createdDate:
2252
+ description: Created Date
2253
+ type: string
2254
+ SetupRecordShareCollectionRepresentation:
2255
+ description: A collection of shares for a record
2256
+ type: object
2257
+ properties:
2258
+ failedRecordShares:
2259
+ description: List of Failed record shares
2260
+ type: array
2261
+ items:
2262
+ type: SetupRecordShareErrorRepresentation
2263
+ recordId:
2264
+ description: Id for record
2265
+ type: string
2266
+ setupObjectType:
2267
+ description: Type For Object.
2268
+ type: string
2269
+ enum:
2270
+ - AnalyticsDashboard
2271
+ - AnalyticsVisualization
2272
+ - AnalyticsWorkspace
2273
+ successfulRecordShares:
2274
+ description: List of shares being returned for a record
2275
+ type: array
2276
+ items:
2277
+ type: SetupRecordShareRepresentation
2278
+ SetupRecordShareErrorRepresentation:
2279
+ description: Setup Record Share Error
2280
+ discriminatorValue: SetupRecordShareError
2281
+ type: object
2282
+ properties:
2283
+ errorCode:
2284
+ description: Setup record share error code
2285
+ type: string
2286
+ errorMessage:
2287
+ description: Setup record share error message
2288
+ type: string
2289
+ userOrGroupId:
2290
+ description: Setup record share userOrGroup Id
2291
+ type: string
2292
+ SetupRecordShareInputRepresentation:
2293
+ description: Shared Record Input Item Representation
2294
+ type: object
2295
+ properties:
2296
+ limit:
2297
+ description: Limit parameter value
2298
+ type: integer
2299
+ offset:
2300
+ description: Offset parameter value
2301
+ type: integer
2302
+ recordId:
2303
+ description: Id of the record
2304
+ type: string
2305
+ userOrGroupId:
2306
+ description: Id of the User/Group
2307
+ type: string
2308
+ SetupRecordShareRepresentation:
2309
+ description: Record share representation.
2310
+ discriminatorValue: RecordShare
2311
+ type: object
2312
+ properties:
2313
+ accessType:
2314
+ description: Access Type For Object.
2315
+ type: string
2316
+ enum:
2317
+ - Commenter
2318
+ - Editor
2319
+ - Manager
2320
+ - Viewer
2321
+ applicationDomain:
2322
+ description: Type of Application Domain
2323
+ type: string
2324
+ enum:
2325
+ - Tableau
2326
+ createdBy:
2327
+ description: Created by of the share access for a record
2328
+ type: AnalyticsUserRepresentation
2329
+ createdDate:
2330
+ description: Created date of the share access for a record
2331
+ type: string
2332
+ lastModifiedBy:
2333
+ description: Last Modified by of the share access for a record
2334
+ type: AnalyticsUserRepresentation
2335
+ lastModifiedDate:
2336
+ description: Last Modified date of the share access for a record
2337
+ type: string
2338
+ userOrGroupId:
2339
+ description: User/Group Id
2340
+ type: string
2341
+ SlackAppInfoRepresentation:
2342
+ description: Analytics Slack App Info Representation
2343
+ type: object
2344
+ properties:
2345
+ authorizationUrl:
2346
+ description: Authorization Url for slack user to authorize Slack App.
2347
+ type: string
2348
+ isSlackAppAuthorized:
2349
+ description: Boolean indicating whether or not the app is authorized by the
2350
+ user already.
2351
+ type: boolean
2352
+ slackAppId:
2353
+ description: The Id of the Slack App.
2354
+ type: string
2355
+ slackUserId:
2356
+ description: The Id of the Slack User.
2357
+ type: string
2358
+ teamIds:
2359
+ description: List of the slack workspace Ids connected to AnalyticsSlackApp.
2360
+ type: array
2361
+ items:
2362
+ type: string
2363
+ SlackUserInfoOutputRepresentation:
2364
+ description: Contains the details of Slack User
2365
+ type: object
2366
+ properties:
2367
+ bot:
2368
+ description: Is this a Bot User?
2369
+ type: boolean
2370
+ displayName?:
2371
+ description: Display Name of the Slack User
2372
+ type: string | nil
2373
+ id?:
2374
+ description: Id of the Slack User
2375
+ type: string | nil
2376
+ image24?:
2377
+ description: 24x24 version of the Slack User image
2378
+ type: string | nil
2379
+ imageOriginal?:
2380
+ description: Original version of the Slack User image
2381
+ type: string | nil
2382
+ inHuddle?:
2383
+ description: Is this Slack User currently in a Huddle?
2384
+ type: boolean | nil
2385
+ isActive?:
2386
+ description: Is this Slack User currently active?
2387
+ type: boolean | nil
2388
+ isExternal?:
2389
+ description: Is Slack User external?
2390
+ type: boolean | nil
2391
+ profileUrl:
2392
+ description: User Profile url
2393
+ type: string | nil
2394
+ realName?:
2395
+ description: Real Name of the Slack User
2396
+ type: string | nil
2397
+ salesforceUserId:
2398
+ description: Id of the related Salesforce User mapped to the Slack User
2399
+ type: string | nil
2400
+ slackUserId:
2401
+ description: Id of the Slack User
2402
+ type: string
2403
+ slackUserImageUrl:
2404
+ description: Url of the Slack User Image
2405
+ type: string | nil
2406
+ slackUsername:
2407
+ description: Name of the Slack User
2408
+ type: string
2409
+ statusEmoji?:
2410
+ description: Status emoji of the Slack User
2411
+ type: SlackEmojiOutputRepresentation | nil
2412
+ statusMessage?:
2413
+ description: Status message of the Slack User
2414
+ type: string | nil
2415
+ teamId:
2416
+ description: Slack Workspace Id
2417
+ type: string
2418
+ SlackEmojiOutputRepresentation:
2419
+ description: Contains the details of Slack Emoji
2420
+ type: object
2421
+ properties:
2422
+ altText?:
2423
+ description: Alt text for the Slack Emoji
2424
+ type: string | nil
2425
+ isCustom:
2426
+ description: Is this a custom Slack Emoji?
2427
+ type: boolean | nil
2428
+ name:
2429
+ description: Name of the Slack Emoji
2430
+ type: string
2431
+ unicode?:
2432
+ description: Unicode for the Slack Emoji
2433
+ type: string | nil
2434
+ url?:
2435
+ description: Url of the Slack Emoji
2436
+ type: string | nil
2437
+ SubscriptionDigestConfigInputRepresentation:
2438
+ description: Subscription digest parameter input representation in unified analytics
2439
+ type: object
2440
+ properties:
2441
+ isEnabled:
2442
+ description: Is digest enabled.
2443
+ type: boolean
2444
+ scheduleType:
2445
+ description: Schedule Type.
2446
+ type: string
2447
+ enum:
2448
+ - Daily
2449
+ - Weekly
2450
+ SubscriptionDigestConfigOutputRepresentation:
2451
+ description: Subscription digest parameter input representation in unified analytics
2452
+ type: object
2453
+ properties:
2454
+ isEnabled:
2455
+ description: Is digest enabled.
2456
+ type: boolean
2457
+ scheduleType:
2458
+ description: Schedule Type.
2459
+ type: string
2460
+ enum:
2461
+ - Daily
2462
+ - Weekly
2463
+ userId:
2464
+ description: User ID.
2465
+ type: string
2466
+ TableauExternalMonitoringEventInputRepresentation:
2467
+ type: object
2468
+ description: Tableau External Monitoring Events Input Representation
2469
+ properties:
2470
+ events:
2471
+ description: Monitoring Events parameter value
2472
+ type: array
2473
+ items:
2474
+ type: any
2475
+ TableauExternalMonitoringEventItemInputRepresentation:
2476
+ type: object
2477
+ description: Tableau External Monitoring Event Input representation
2478
+ properties:
2479
+ additionalContext:
2480
+ description: Additional Context for Monitoring Event For Related eventType
2481
+ and eventCategory
2482
+ type: string
2483
+ entityId:
2484
+ description: EntityId Value
2485
+ type: string
2486
+ eventCategory:
2487
+ description: EventCategory Value
2488
+ type: string
2489
+ enum:
2490
+ - Collaboration
2491
+ - Dashboard
2492
+ - Semantic
2493
+ - Visualization
2494
+ - Workspace
2495
+ eventType:
2496
+ description: EventType Value
2497
+ type: string
2498
+ userId:
2499
+ description: OwnerId for publisher
2500
+ type: string
2501
+ TableauExternalMonitoringEventItemRepresentation:
2502
+ type: object
2503
+ description: Result for publishing monitoring events in Unified Analytics.
2504
+ properties:
2505
+ failureCount:
2506
+ description: Failure Count from Publishing Endpoint Response
2507
+ type: integer
2508
+ id:
2509
+ description: Unique Id for publishing batch of events
2510
+ type: string
2511
+ successCount:
2512
+ description: Success Count from Publishing Endpoint Response
2513
+ type: integer
2514
+ UnifiedAnalyticsLogLinesRepresentation:
2515
+ description: Result for publishing log lines in Unified Analytics.
2516
+ type: object
2517
+ properties:
2518
+ id:
2519
+ description: Unique identifier for log lines logged
2520
+ type: string
2521
+ failureCount:
2522
+ description: Failure count of log lines logged
2523
+ type: integer
2524
+ successCount:
2525
+ description: Success count of log lines logged
2526
+ type: integer
2527
+ UnifiedAnalyticsLoglineInputRepresentation:
2528
+ description: A logline code and the logline parameters
2529
+ type: object
2530
+ properties:
2531
+ fields:
2532
+ description: The logline parameters
2533
+ type: object
2534
+ properties:
2535
+ //:
2536
+ type: object
2537
+ logLineCode:
2538
+ description: The logline code
2539
+ type: string
2540
+ UnifiedAnalyticsLoglinesInputRepresentation:
2541
+ description: A collection of loglines sent from TUA UI to be recorded in splunk
2542
+ type: object
2543
+ properties:
2544
+ loglines:
2545
+ description: The list of loglines from TUA UI
2546
+ type: array
2547
+ items:
2548
+ type: any
2549
+ UnifiedFilterRepresentation:
2550
+ description: Unified filter representation.
2551
+ type: object
2552
+ properties:
2553
+ fieldName:
2554
+ description: fieldName
2555
+ type: string
2556
+ operator:
2557
+ description: operator
2558
+ type: string
2559
+ values:
2560
+ description: values
2561
+ type: array
2562
+ items:
2563
+ type: object
2564
+ UpdateSetupRecordAccessInputRepresentation:
2565
+ description: Update record share input representation
2566
+ type: object
2567
+ properties:
2568
+ updateSetupRecordAccessItems:
2569
+ description: List of records shares
2570
+ type: array
2571
+ items:
2572
+ type: any
2573
+ UpdateSetupRecordAccessItemInputRepresentation:
2574
+ description: Update record share input item representation
2575
+ type: object
2576
+ properties:
2577
+ accessType:
2578
+ description: Usage type of the asset.
2579
+ type: string
2580
+ enum:
2581
+ - Commenter
2582
+ - Editor
2583
+ - Manager
2584
+ - Viewer
2585
+ userOrGroupId:
2586
+ description: Id of the User/Group
2587
+ type: string
2588
+ WorkspaceCollectionRepresentation:
2589
+ description: A collection of unified analytics workspaces.
2590
+ type: object
2591
+ properties:
2592
+ workspaces:
2593
+ description: List of workspaces being returned.
2594
+ type: array
2595
+ items:
2596
+ type: WorkspaceRepresentation
2597
+ WorkspaceInputRepresentation:
2598
+ description: Unified Analytics Workspace Input Representation
2599
+ type: object
2600
+ properties:
2601
+ description:
2602
+ description: Description.
2603
+ type: string
2604
+ required: false
2605
+ id:
2606
+ description: Database id.
2607
+ type: string
2608
+ required: false
2609
+ label:
2610
+ description: Master label.
2611
+ type: string
2612
+ name:
2613
+ description: Unique developer name.
2614
+ type: string
2615
+ required: false
2616
+ WorkspaceRepresentation:
2617
+ description: Unified analytics workspace representation.
2618
+ discriminatorValue: Workspace
2619
+ type: object
2620
+ properties:
2621
+ description:
2622
+ description: Description of the asset.
2623
+ type: string
2624
+ required: false
2625
+ id:
2626
+ description: Database record id of the asset.
2627
+ type: string
2628
+ label:
2629
+ description: Label of the asset.
2630
+ type: string
2631
+ name:
2632
+ description: Name of the asset.
2633
+ type: string
2634
+ createdBy:
2635
+ description: Created by of the asset.
2636
+ type: AnalyticsUserRepresentation
2637
+ createdDate:
2638
+ description: Created date of the asset
2639
+ type: string
2640
+ url:
2641
+ description: URL to this workspace.
2642
+ type: string
2643
+ cacheableKey:
2644
+ description: Key to use for caching the workspace output.
2645
+ type: string
2646
+ lastModifiedBy:
2647
+ description: Last modified by of the asset.
2648
+ type: any
2649
+ required: false
2650
+ lastModifiedDate:
2651
+ description: Last modified date of the asset.
2652
+ type: string
2653
+ required: false
2654
+
2655
+ WorkspaceAssetCollectionRepresentation:
2656
+ description: A collection of assets in a workspace in unified analytics.
2657
+ type: object
2658
+ properties:
2659
+ workspaceAssets:
2660
+ description: List of workspace assets being returned.
2661
+ type: array
2662
+ items:
2663
+ type: WorkspaceAssetRepresentation
2664
+ WorkspaceAssetInputRepresentation:
2665
+ description: Unified Analytics Workspace asset Input Representation
2666
+ type: object
2667
+ properties:
2668
+ assetId:
2669
+ description: Id of the asset.
2670
+ type: string
2671
+ assetType:
2672
+ description: Type of the asset.
2673
+ type: string
2674
+ enum:
2675
+ - AnalyticsDashboard
2676
+ - AnalyticsVisualization
2677
+ - MktCalculatedInsightsObject
2678
+ - MktDataModelObject
2679
+ - SemanticModel
2680
+ assetUsageType:
2681
+ description: Usage type of the asset.
2682
+ type: string
2683
+ enum:
2684
+ - Created
2685
+ - Referenced
2686
+ WorkspaceAssetRepresentation:
2687
+ description: Unified analytics workspace asset representation.
2688
+ discriminatorValue: WorkspaceAsset
2689
+ type: object
2690
+ properties:
2691
+ assetId:
2692
+ description: Asset in the workspace.
2693
+ type: string
2694
+ assetType:
2695
+ description: Type of asset.
2696
+ type: string
2697
+ enum:
2698
+ - AnalyticsDashboard
2699
+ - AnalyticsVisualization
2700
+ - MktCalculatedInsightsObject
2701
+ - MktDataModelObject
2702
+ - SemanticModel
2703
+ assetUsageType:
2704
+ description: Usage type of this asset.
2705
+ type: string
2706
+ enum:
2707
+ - Created
2708
+ - Referenced
2709
+ createdBy:
2710
+ description: CreatedBy of the workspace association.
2711
+ type: AnalyticsUserRepresentation
2712
+ createdDate:
2713
+ description: Created date of the workspace association
2714
+ type: string
2715
+ url:
2716
+ description: URL to this workspace asset.
2717
+ type: string
2718
+ CdpAssetBaseInputRepresentation:
2719
+ description: Represents a base asset
2720
+ type: object
2721
+ discriminator: id
2722
+ properties:
2723
+ id:
2724
+ description: Id
2725
+ type: string
2726
+ name:
2727
+ description: Name
2728
+ type: string
2729
+ namespace:
2730
+ description: Namespace
2731
+ type: string
2732
+ SFDriveCredentialInputRepresentation:
2733
+ description: Input representation for sf drive credentials
2734
+ type: CdpAssetBaseInputRepresentation
2735
+ properties:
2736
+ path:
2737
+ description: The path in sfdrive for which credentials are needed.
2738
+ type: string
2739
+ SFDriveCredentialRepresentation:
2740
+ description: Response representation for SFDrive Credentials Request
2741
+ type: object
2742
+ properties:
2743
+ accessCredential:
2744
+ description: Access Credentials for location in SF Drive
2745
+ type: object
2746
+ properties:
2747
+ //:
2748
+ type: string
2749
+ fullyQualifiedLocationInDrive:
2750
+ description: Fully Qualified Location in SF Drive
2751
+ type: string
2752
+ tenantKeyId:
2753
+ description: Tenant Key Id
2754
+ type: string
2755
+ /tableau:
2756
+ /admin/monitoring/events:
2757
+ post:
2758
+ displayName: postTableauExternalClientMonitoringEvent
2759
+ description: Publish list of Tableau External Client Monitoring Events
2760
+ responses:
2761
+ '200':
2762
+ description: Success
2763
+ body:
2764
+ application/json:
2765
+ type: TableauExternalMonitoringEventItemRepresentation
2766
+ body:
2767
+ application/json:
2768
+ type: TableauExternalMonitoringEventInputRepresentation
2769
+ # required: false # TODO Hand-rolled W-16187742 not supported
2770
+ (oas-body-name): unifiedAnalyticsMonitoringEvents
2771
+ /annotations:
2772
+ get:
2773
+ displayName: getAnnotationCollection
2774
+ description: Get all available Unified Analytics Annotations for the user.
2775
+ responses:
2776
+ '200':
2777
+ description: Success
2778
+ body:
2779
+ application/json:
2780
+ type: AnnotationCollectionRepresentation
2781
+ queryParameters:
2782
+ assetIds:
2783
+ type: array
2784
+ required: false
2785
+ items:
2786
+ type: string
2787
+ (oas-collectionFormat): csv
2788
+ includeTopMessage:
2789
+ description: optional parameter to fetch top level thread message or not.
2790
+ type: boolean
2791
+ required: false
2792
+ limit:
2793
+ type: integer
2794
+ required: false
2795
+ offset:
2796
+ type: integer
2797
+ required: false
2798
+ slackAppId:
2799
+ description: optional parameter to override the slack app Id. If not present,
2800
+ we will use TUA slack app.
2801
+ type: string
2802
+ required: false
2803
+ post:
2804
+ displayName: postAnnotationCollection
2805
+ description: Create a new Annotation.
2806
+ responses:
2807
+ '200':
2808
+ description: Success
2809
+ body:
2810
+ application/json:
2811
+ type: AnnotationRepresentation
2812
+ body:
2813
+ application/json:
2814
+ type: AnnotationInputRepresentation
2815
+ (oas-body-name): annotation
2816
+ /annotations/slack-app-info:
2817
+ get:
2818
+ displayName: getSlackAppInfo
2819
+ description: Get Slack App Info required for Analytics Annotations feature.
2820
+ responses:
2821
+ '200':
2822
+ description: Success
2823
+ body:
2824
+ application/json:
2825
+ type: SlackAppInfoRepresentation
2826
+ /assets/query:
2827
+ post:
2828
+ displayName: postAnalyticsAssetsQuery
2829
+ description: Query Unified Analytics assets.
2830
+ responses:
2831
+ '200':
2832
+ description: Success
2833
+ body:
2834
+ application/json:
2835
+ type: AnalyticsAssetsQueryResultsRepresentation
2836
+ body:
2837
+ application/json:
2838
+ type: AnalyticsAssetsQueryInputRepresentation
2839
+ # required: false # TODO Hand-rolled W-15315791 not supported
2840
+ (oas-body-name): assetsQueryInput
2841
+ /dashboards:
2842
+ get:
2843
+ displayName: getDashboardCollection
2844
+ description: Get all available Unified Analytics Dashboards.
2845
+ responses:
2846
+ '200':
2847
+ description: Success
2848
+ body:
2849
+ application/json:
2850
+ type: DashboardCollectionRepresentation
2851
+ queryParameters:
2852
+ limit:
2853
+ type: integer
2854
+ required: false
2855
+ minorVersion:
2856
+ type: integer
2857
+ required: false
2858
+ offset:
2859
+ type: integer
2860
+ required: false
2861
+ post:
2862
+ displayName: postDashboardCollection
2863
+ description: Create a new Dashboard.
2864
+ responses:
2865
+ '200':
2866
+ description: Success
2867
+ body:
2868
+ application/json:
2869
+ type: DashboardRepresentation
2870
+ queryParameters:
2871
+ minorVersion:
2872
+ type: integer
2873
+ required: false
2874
+ body:
2875
+ application/json:
2876
+ type: DashboardInputRepresentation
2877
+ (oas-body-name): dashboard
2878
+ /dashboards/{dashboardIdOrApiName}:
2879
+ delete:
2880
+ displayName: deleteDashboard
2881
+ description: Delete Unified Analytics Dashboard by Id or Name.
2882
+ responses:
2883
+ '200':
2884
+ description: Success
2885
+ get:
2886
+ displayName: getDashboard
2887
+ description: Get Unified Analytics Dashboard by Id or Name.
2888
+ responses:
2889
+ '200':
2890
+ description: Success
2891
+ body:
2892
+ application/json:
2893
+ type: DashboardRepresentation
2894
+ queryParameters:
2895
+ minorVersion:
2896
+ type: integer
2897
+ required: false
2898
+ patch:
2899
+ displayName: patchDashboard
2900
+ description: Update Unified Analytics Dashboard Metadata by Id or Name.
2901
+ responses:
2902
+ '200':
2903
+ description: Success
2904
+ body:
2905
+ application/json:
2906
+ type: DashboardRepresentation
2907
+ queryParameters:
2908
+ minorVersion:
2909
+ type: integer
2910
+ required: false
2911
+ body:
2912
+ application/json:
2913
+ type: DashboardInputRepresentation
2914
+ (oas-body-name): dashboard
2915
+ uriParameters:
2916
+ dashboardIdOrApiName:
2917
+ type: string
2918
+ required: true
2919
+ /dataAlerts:
2920
+ get:
2921
+ displayName: getDataAlertCollection
2922
+ description: Get all available Data Alerts.
2923
+ responses:
2924
+ '200':
2925
+ description: Success
2926
+ body:
2927
+ application/json:
2928
+ type: DataAlertCollectionRepresentation
2929
+ queryParameters:
2930
+ ownerId:
2931
+ type: string
2932
+ required: true
2933
+ limit:
2934
+ type: integer
2935
+ required: false
2936
+ offset:
2937
+ type: integer
2938
+ required: false
2939
+ post:
2940
+ displayName: postDataAlertCollection
2941
+ description: Create a new data alert.
2942
+ responses:
2943
+ '200':
2944
+ description: Success
2945
+ body:
2946
+ application/json:
2947
+ type: DataAlertRepresentation
2948
+ queryParameters:
2949
+ runNow:
2950
+ description: optional parameter to trigger data alert flow to run immediately.
2951
+ type: boolean
2952
+ required: false
2953
+ body:
2954
+ application/json:
2955
+ type: DataAlertInputRepresentation
2956
+ (oas-body-name): dataAlert
2957
+ /dataAlerts/{dataAlertId}:
2958
+ get: #This is a mocked path only.
2959
+ displayName: getDataAlertCollection
2960
+ description: Get all available Data Alerts.
2961
+ responses:
2962
+ '200':
2963
+ description: Success
2964
+ body:
2965
+ application/json:
2966
+ type: DataAlertRepresentation
2967
+ delete:
2968
+ displayName: deleteDataAlert
2969
+ description: Delete a data alert
2970
+ responses:
2971
+ '200':
2972
+ description: Success
2973
+ put:
2974
+ displayName: updateDataAlert
2975
+ description: update a data alert
2976
+ responses:
2977
+ '200':
2978
+ description: Success
2979
+ body:
2980
+ application/json:
2981
+ type: DataAlertRepresentation
2982
+ queryParameters:
2983
+ runNow:
2984
+ description: optional parameter to trigger data alert flow to run immediately.
2985
+ type: boolean
2986
+ required: false
2987
+ body:
2988
+ application/json:
2989
+ type: DataAlertInputRepresentation
2990
+ (oas-body-name): dataAlert
2991
+ uriParameters:
2992
+ dataAlertId:
2993
+ type: string
2994
+ required: true
2995
+ /dataAlerts/{dataAlertId}/run:
2996
+ post:
2997
+ displayName: postDataAlertRun
2998
+ description: Run a data alert immediately.
2999
+ responses:
3000
+ '200':
3001
+ description: Success
3002
+ body:
3003
+ application/json:
3004
+ type: DataAlertRunOutputRepresentation
3005
+ uriParameters:
3006
+ dataAlertId:
3007
+ type: string
3008
+ required: true
3009
+ /data-assets:
3010
+ /requests:
3011
+ get:
3012
+ displayName: getDataAssetRequestCollection
3013
+ description: Gets data asset requests based on query parameters
3014
+ responses:
3015
+ '200':
3016
+ description: Success
3017
+ body:
3018
+ application/json:
3019
+ type: DataAssetRequestCollectionRepresentation
3020
+ queryParameters:
3021
+ assetId:
3022
+ type: string
3023
+ required: false
3024
+ assetType:
3025
+ type: string
3026
+ required: false
3027
+ createdBy:
3028
+ type: string
3029
+ required: false
3030
+ limit:
3031
+ type: integer
3032
+ required: false
3033
+ offset:
3034
+ type: integer
3035
+ required: false
3036
+ orderBy:
3037
+ type: string
3038
+ required: false
3039
+ requestType:
3040
+ type: string
3041
+ required: false
3042
+ searchQueryTerm:
3043
+ type: string
3044
+ required: false
3045
+ sortBy:
3046
+ type: string
3047
+ required: false
3048
+ status:
3049
+ type: string
3050
+ required: false
3051
+ workspaceIdOrApiName:
3052
+ type: string
3053
+ required: false
3054
+ post:
3055
+ displayName: postDataAssetRequest
3056
+ description: Request creation of a task for a data asset
3057
+ responses:
3058
+ '200':
3059
+ description: Success
3060
+ body:
3061
+ application/json:
3062
+ type: DataAssetRequestRepresentation
3063
+ body:
3064
+ application/json:
3065
+ type: DataAssetRequestInputRepresentation
3066
+ # required: false # TODO Hand-rolled W-17118037 not supported
3067
+ (oas-body-name): dataAssetRequestInput
3068
+ /count:
3069
+ get:
3070
+ displayName: getDataAssetRequestCount
3071
+ description: Gets data asset requests count based on query parameters
3072
+ responses:
3073
+ '200':
3074
+ description: Success
3075
+ body:
3076
+ application/json:
3077
+ type: DataAssetRequestCountRepresentation
3078
+ queryParameters:
3079
+ assetId:
3080
+ type: string
3081
+ required: false
3082
+ assetType:
3083
+ type: string
3084
+ required: false
3085
+ createdBy:
3086
+ type: string
3087
+ required: false
3088
+ searchQueryTerm:
3089
+ type: string
3090
+ required: false
3091
+ status:
3092
+ type: string
3093
+ required: false
3094
+ taskType:
3095
+ type: string
3096
+ required: false
3097
+ workspaceIdOrApiName:
3098
+ type: string
3099
+ required: false
3100
+ /{requestIdOrApiName}:
3101
+ get:
3102
+ displayName: getDataAssetRequest
3103
+ description: Get data asset request by Id or Api Name
3104
+ responses:
3105
+ '200':
3106
+ description: Success
3107
+ body:
3108
+ application/json:
3109
+ type: DataAssetRequestRepresentation
3110
+ patch:
3111
+ displayName: patchDataAssetRequest
3112
+ description: Request update of a data asset request
3113
+ responses:
3114
+ '200':
3115
+ description: Success
3116
+ body:
3117
+ application/json:
3118
+ type: DataAssetRequestRepresentation
3119
+ body:
3120
+ application/json:
3121
+ type: DataAssetRequestInputRepresentation
3122
+ (oas-body-name): dataAssetRequestInput
3123
+ uriParameters:
3124
+ requestIdOrApiName:
3125
+ type: string
3126
+ required: true
3127
+ /dependencies:
3128
+ /{assetId}:
3129
+ get:
3130
+ displayName: getDataAssetDependencies
3131
+ description: Gets the dependencies of an Data asset
3132
+ queryParameters:
3133
+ includeSynchronizationInfo:
3134
+ type: boolean
3135
+ required: false
3136
+ description: Include synchronization information in the response
3137
+ responses:
3138
+ '200':
3139
+ description: Success
3140
+ body:
3141
+ application/json:
3142
+ type: DataAssetDependentCollectionRepresentation
3143
+ uriParameters:
3144
+ assetId:
3145
+ type: string
3146
+ required: true
3147
+ /follow/followers/{followerId}/follows:
3148
+ post:
3149
+ displayName: postFollow
3150
+ description: Follow an asset
3151
+ responses:
3152
+ '200':
3153
+ description: Success
3154
+ body:
3155
+ application/json:
3156
+ type: FollowerAssetRepresentation
3157
+ body:
3158
+ application/json:
3159
+ type: FollowInputRepresentation
3160
+ (oas-body-name): followerAsset
3161
+ patch:
3162
+ displayName: patchFollow
3163
+ description: Update a followed asset
3164
+ responses:
3165
+ '200':
3166
+ description: Success
3167
+ body:
3168
+ application/json:
3169
+ type: FollowerAssetCollectionRepresentation
3170
+ body:
3171
+ application/json:
3172
+ type: UpdateFollowedAssetInputRepresentation
3173
+ (oas-body-name): followerAsset
3174
+ uriParameters:
3175
+ followerId:
3176
+ type: string
3177
+ required: true
3178
+ /follow/followers/{followerId}/follows/{followedAssetId}:
3179
+ delete:
3180
+ displayName: deleteFollow
3181
+ description: Unfollow an asset
3182
+ responses:
3183
+ '200':
3184
+ description: Success
3185
+ uriParameters:
3186
+ followedAssetId:
3187
+ type: string
3188
+ required: true
3189
+ followerId:
3190
+ type: string
3191
+ required: true
3192
+ get:
3193
+ # No implementation in connect api
3194
+ # GET resource is required to allow DELETE resource with key annotation (messageTimestamp)
3195
+ responses:
3196
+ '200':
3197
+ body:
3198
+ application/json:
3199
+ type: FollowedAssetRepresentation
3200
+ /follow/assets/{followedAssetId}/followers:
3201
+ get:
3202
+ displayName: getFollowerCollection
3203
+ description: Get all followers of a followed asset filterable by follower type.
3204
+ responses:
3205
+ '200':
3206
+ description: Success
3207
+ body:
3208
+ application/json:
3209
+ type: FollowerCollectionRepresentation
3210
+ queryParameters:
3211
+ followerId:
3212
+ type: string
3213
+ required: false
3214
+ followerType:
3215
+ type: string
3216
+ required: false
3217
+ limit:
3218
+ type: integer
3219
+ required: false
3220
+ offset:
3221
+ type: integer
3222
+ required: false
3223
+ uriParameters:
3224
+ followedAssetId:
3225
+ type: string
3226
+ required: true
3227
+ /follow/followers/{followerId}/followed-assets:
3228
+ get:
3229
+ displayName: getFollowedAssetCollection
3230
+ description: Get all followed assets of a follower filterable by asset type.
3231
+ responses:
3232
+ '200':
3233
+ description: Success
3234
+ body:
3235
+ application/json:
3236
+ type: FollowedAssetCollectionRepresentation
3237
+ queryParameters:
3238
+ followedAssetType:
3239
+ type: string
3240
+ required: false
3241
+ limit:
3242
+ type: integer
3243
+ required: false
3244
+ offset:
3245
+ type: integer
3246
+ required: false
3247
+ uriParameters:
3248
+ followerId:
3249
+ type: string
3250
+ required: true
3251
+ /follow/assets/{followedAssetId}/follower-count:
3252
+ get:
3253
+ displayName: getUniqueFollowerCount
3254
+ description: Get unique follower count for a followed asset.
3255
+ responses:
3256
+ '200':
3257
+ description: Success
3258
+ body:
3259
+ application/json:
3260
+ type: UniqueFollowerCountRepresentation
3261
+ queryParameters:
3262
+ followedAssetType:
3263
+ type: string
3264
+ required: false
3265
+ uriParameters:
3266
+ followedAssetId:
3267
+ type: string
3268
+ required: true
3269
+ /loglines:
3270
+ post:
3271
+ displayName: postUnifiedAnalyticsLoglines
3272
+ description: Post a collection of ui loglines
3273
+ responses:
3274
+ '200':
3275
+ description: Success
3276
+ body:
3277
+ application/json:
3278
+ type: UnifiedAnalyticsLogLinesRepresentation
3279
+ body:
3280
+ application/json:
3281
+ type: UnifiedAnalyticsLoglinesInputRepresentation
3282
+ # required: false # TODO Hand-rolled W-15315791 not supported
3283
+ (oas-body-name): loglines
3284
+ /orgs:
3285
+ get:
3286
+ displayName: getOrg
3287
+ description: Get all available Unified Analytics Orgs.
3288
+ responses:
3289
+ '200':
3290
+ description: Success
3291
+ body:
3292
+ application/json:
3293
+ type: OrgCollectionRepresentation
3294
+ /records/{recordId}/shares:
3295
+ delete:
3296
+ displayName: deleteSetupRecordShareCollection
3297
+ description: Delete all shares for an record
3298
+ responses:
3299
+ '200':
3300
+ description: Success
3301
+ get:
3302
+ displayName: getSetupRecordShareCollection
3303
+ description: Get record shares for requested registered grantee for a record
3304
+ responses:
3305
+ '200':
3306
+ description: Success
3307
+ body:
3308
+ application/json:
3309
+ type: SetupRecordAccessCollectionRepresentation
3310
+ queryParameters:
3311
+ limit:
3312
+ type: integer
3313
+ required: false
3314
+ offset:
3315
+ type: integer
3316
+ required: false
3317
+ userOrGroupId:
3318
+ type: string
3319
+ required: false
3320
+ orderBy:
3321
+ description: Order By value, default is Created Date
3322
+ type: string
3323
+ required: false
3324
+ enum:
3325
+ - CreatedDate
3326
+ - UserDisplayName
3327
+ sortOrder:
3328
+ description: Sort Order value, default is descending
3329
+ type: string
3330
+ required: false
3331
+ enum:
3332
+ - DESC
3333
+ - ASC
3334
+ filterByRecipientType:
3335
+ description: recipient filter value, default is none
3336
+ type: array
3337
+ required: false
3338
+ items:
3339
+ type: string
3340
+ enum:
3341
+ - User
3342
+ - Group
3343
+ patch:
3344
+ displayName: patchSetupRecordShareCollection
3345
+ description: Update an record share to be associated with a record Item
3346
+ responses:
3347
+ '200':
3348
+ description: Success
3349
+ body:
3350
+ application/json:
3351
+ type: SetupRecordShareCollectionRepresentation
3352
+ (oas-body-name): recordShareObjects
3353
+ body:
3354
+ application/json:
3355
+ type: UpdateSetupRecordAccessInputRepresentation
3356
+ post:
3357
+ displayName: postSetupRecordShareCollection
3358
+ description: Add record shares to be associated with a record
3359
+ responses:
3360
+ '200':
3361
+ description: Success
3362
+ body:
3363
+ application/json:
3364
+ type: SetupRecordShareCollectionRepresentation
3365
+ (oas-body-name): recordShareObjects
3366
+ body:
3367
+ application/json:
3368
+ type: SetupRecordAccessInputRepresentation
3369
+ uriParameters:
3370
+ recordId:
3371
+ type: string
3372
+ required: true
3373
+ /records/{recordId}/shares/{userOrGroupId}:
3374
+ delete:
3375
+ displayName: deleteSetupRecordShare
3376
+ description: Delete a record shares for a record and a user or group
3377
+ responses:
3378
+ '200':
3379
+ description: Success
3380
+ uriParameters:
3381
+ recordId:
3382
+ type: string
3383
+ required: true
3384
+ userOrGroupId:
3385
+ type: string
3386
+ required: true
3387
+ get:
3388
+ # No implementation in connect api
3389
+ # GET resource is required to allow DELETE resource with key annotation (messageTimestamp)
3390
+ responses:
3391
+ '200':
3392
+ body:
3393
+ application/json:
3394
+ type: SetupRecordAccessRepresentation
3395
+ /slack/channels:
3396
+ get:
3397
+ displayName: getAssetSlackChannelCollection
3398
+ description: Get all the slack channels associated with a analytical asset
3399
+ responses:
3400
+ '200':
3401
+ description: Success
3402
+ body:
3403
+ application/json:
3404
+ type: AssetSlackChannelCollectionRepresentation
3405
+ queryParameters:
3406
+ assetId:
3407
+ type: string
3408
+ required: true
3409
+ post:
3410
+ displayName: postAssetSlackChannelCollection
3411
+ description: Create a new slack channel for analytical asset.
3412
+ responses:
3413
+ '200':
3414
+ description: Success
3415
+ body:
3416
+ application/json:
3417
+ type: AssetSlackChannelRepresentation
3418
+ body:
3419
+ application/json:
3420
+ type: AssetSlackChannelInputRepresentation
3421
+ (oas-body-name): assetChannel
3422
+ /users/query:
3423
+ post:
3424
+ displayName: postAnalyticsUsersQuery
3425
+ description: Query Unified Analytics users.
3426
+ responses:
3427
+ '200':
3428
+ description: Success
3429
+ body:
3430
+ application/json:
3431
+ type: AnalyticsUsersQueryResultsRepresentation
3432
+ body:
3433
+ application/json:
3434
+ type: AnalyticsUsersQueryInputRepresentation
3435
+ # required: false # TODO Hand-rolled W-16116281 not supported
3436
+ (oas-body-name): usersQueryInput
3437
+ /visualizations:
3438
+ get:
3439
+ displayName: getVisualizationCollection
3440
+ description: Get all available Unified Analytics Visualizations.
3441
+ responses:
3442
+ '200':
3443
+ description: Success
3444
+ body:
3445
+ application/json:
3446
+ type: VisualizationCollectionRepresentation
3447
+ queryParameters:
3448
+ limit:
3449
+ type: integer
3450
+ required: false
3451
+ offset:
3452
+ type: integer
3453
+ required: false
3454
+ minorVersion:
3455
+ type: integer
3456
+ required: false
3457
+ post:
3458
+ displayName: postVisualization
3459
+ description: Creates a new Visualization.
3460
+ responses:
3461
+ '200':
3462
+ description: Success
3463
+ body:
3464
+ application/json:
3465
+ type: VisualizationRepresentation
3466
+ queryParameters:
3467
+ minorVersion:
3468
+ type: integer
3469
+ required: false
3470
+ body:
3471
+ application/json:
3472
+ type: VisualizationInputRepresentation
3473
+ (oas-body-name): visualization
3474
+ /visualizations/{visualizationIdOrApiName}:
3475
+ delete:
3476
+ displayName: deleteVisualization
3477
+ description: Delete Unified Analytics Visualization by Id or Name.
3478
+ responses:
3479
+ '200':
3480
+ description: Success
3481
+ get:
3482
+ displayName: getVisualization
3483
+ description: Get Unified Analytics Visualization by Id or Name.
3484
+ responses:
3485
+ '200':
3486
+ description: Success
3487
+ body:
3488
+ application/json:
3489
+ type: VisualizationRepresentation
3490
+ queryParameters:
3491
+ minorVersion:
3492
+ type: integer
3493
+ required: false
3494
+ patch:
3495
+ displayName: patchVisualization
3496
+ description: Update Visualization Metadata by Id or Name.
3497
+ responses:
3498
+ '200':
3499
+ description: Success
3500
+ body:
3501
+ application/json:
3502
+ type: VisualizationRepresentation
3503
+ queryParameters:
3504
+ minorVersion:
3505
+ type: integer
3506
+ required: false
3507
+ body:
3508
+ application/json:
3509
+ type: VisualizationInputRepresentation
3510
+ (oas-body-name): visualization
3511
+ uriParameters:
3512
+ visualizationIdOrApiName:
3513
+ type: string
3514
+ required: true
3515
+ /visualizations/{visualizationIdOrApiName}/bundle:
3516
+ get:
3517
+ displayName: getVisualizationBundle
3518
+ description: Get Unified Analytics Visualization Bundle
3519
+ responses:
3520
+ '200':
3521
+ description: Success
3522
+ body:
3523
+ application/json:
3524
+ type: VisualizationBundleRepresentation
3525
+ queryParameters:
3526
+ minorVersion:
3527
+ type: integer
3528
+ required: false
3529
+ uriParameters:
3530
+ visualizationIdOrApiName:
3531
+ type: string
3532
+ required: true
3533
+ /workspaces:
3534
+ get:
3535
+ displayName: getWorkspaceCollection
3536
+ description: Get all available Unified Analytics Workspaces.
3537
+ responses:
3538
+ '200':
3539
+ description: Success
3540
+ body:
3541
+ application/json:
3542
+ type: WorkspaceCollectionRepresentation
3543
+ queryParameters:
3544
+ limit:
3545
+ type: integer
3546
+ required: false
3547
+ offset:
3548
+ type: integer
3549
+ required: false
3550
+ post:
3551
+ displayName: postWorkspaceCollection
3552
+ description: Create a new Workspace.
3553
+ responses:
3554
+ '200':
3555
+ description: Success
3556
+ body:
3557
+ application/json:
3558
+ type: WorkspaceRepresentation
3559
+ body:
3560
+ application/json:
3561
+ type: WorkspaceInputRepresentation
3562
+ #required: false
3563
+ (oas-body-name): workspace
3564
+ /workspaces/{workspaceIdOrApiName}:
3565
+ delete:
3566
+ displayName: deleteWorkspace
3567
+ description: Delete Unified Analytics Workspace by Id or Name.
3568
+ responses:
3569
+ '200':
3570
+ description: Success
3571
+ get:
3572
+ displayName: getWorkspace
3573
+ description: Get Unified Analytics Workspace by Id or Name.
3574
+ responses:
3575
+ '200':
3576
+ description: Success
3577
+ body:
3578
+ application/json:
3579
+ type: WorkspaceRepresentation
3580
+ patch:
3581
+ displayName: patchWorkspace
3582
+ description: Update Unified Analytics Workspace Metadata by Id or Name.
3583
+ responses:
3584
+ '200':
3585
+ description: Success
3586
+ body:
3587
+ application/json:
3588
+ type: WorkspaceRepresentation
3589
+ body:
3590
+ application/json:
3591
+ type: WorkspaceInputRepresentation
3592
+ (oas-body-name): workspace
3593
+ uriParameters:
3594
+ workspaceIdOrApiName:
3595
+ type: string
3596
+ required: true
3597
+ /workspaces/{workspaceIdOrApiName}/assets:
3598
+ get:
3599
+ displayName: getWorkspaceAssetCollection
3600
+ description: Get all available assets in a Unified Analytics Workspace filterable by asset usage type
3601
+ responses:
3602
+ '200':
3603
+ description: Success
3604
+ body:
3605
+ application/json:
3606
+ type: WorkspaceAssetCollectionRepresentation
3607
+ queryParameters:
3608
+ assetUsageType:
3609
+ type: string
3610
+ required: false
3611
+ limit:
3612
+ type: integer
3613
+ required: false
3614
+ offset:
3615
+ type: integer
3616
+ required: false
3617
+ post:
3618
+ displayName: postWorkspaceAssetCollection
3619
+ description: Add an asset to be associated with a workspace
3620
+ responses:
3621
+ '200':
3622
+ description: Success
3623
+ body:
3624
+ application/json:
3625
+ type: WorkspaceAssetRepresentation
3626
+ body:
3627
+ application/json:
3628
+ type: WorkspaceAssetInputRepresentation
3629
+ (oas-body-name): workspaceAsset
3630
+ uriParameters:
3631
+ workspaceIdOrApiName:
3632
+ type: string
3633
+ required: true
3634
+ /workspaces/{workspaceIdOrApiName}/assets/{assetId}:
3635
+ delete:
3636
+ displayName: deleteWorkspaceAsset
3637
+ description: Delete an asset from a workspace
3638
+ responses:
3639
+ '200':
3640
+ description: Success
3641
+ uriParameters:
3642
+ assetId:
3643
+ type: string
3644
+ required: true
3645
+ workspaceIdOrApiName:
3646
+ type: string
3647
+ required: true
3648
+ get:
3649
+ # No implementation in connect api
3650
+ # GET resource is required to allow DELETE resource with key annotation (messageTimestamp)
3651
+ responses:
3652
+ '200':
3653
+ body:
3654
+ application/json:
3655
+ type: WorkspaceAssetRepresentation
3656
+ /flows:
3657
+ get:
3658
+ displayName: getFlowCollection
3659
+ description: Get available flows.
3660
+ responses:
3661
+ '200':
3662
+ description: Success
3663
+ body:
3664
+ application/json:
3665
+ type: FlowCollectionRepresentation
3666
+ queryParameters:
3667
+ limit:
3668
+ type: integer
3669
+ required: false
3670
+ offset:
3671
+ type: integer
3672
+ required: false
3673
+ /flows/{flowApiName}:
3674
+ get:
3675
+ displayName: getFlowByName
3676
+ description: Get Flow by Api Name.
3677
+ responses:
3678
+ '200':
3679
+ description: Success
3680
+ body:
3681
+ application/json:
3682
+ type: FlowRepresentation
3683
+ uriParameters:
3684
+ flowApiName:
3685
+ type: string
3686
+ required: true
3687
+ /subscriptions/digest/{digestConfigOwner}:
3688
+ get:
3689
+ displayName: getSubscriptionDigestConfig
3690
+ description: Get user's subscription digest configuration
3691
+ responses:
3692
+ '200':
3693
+ description: Success
3694
+ body:
3695
+ application/json:
3696
+ type: SubscriptionDigestConfigOutputRepresentation
3697
+ patch:
3698
+ displayName: patchSubscriptionDigestConfig
3699
+ description: Update user's subscription digest configuration
3700
+ responses:
3701
+ '200':
3702
+ description: Success
3703
+ body:
3704
+ application/json:
3705
+ type: SubscriptionDigestConfigOutputRepresentation
3706
+ body:
3707
+ application/json:
3708
+ type: SubscriptionDigestConfigInputRepresentation
3709
+ # required: false
3710
+ (oas-body-name): digestConfig
3711
+ uriParameters:
3712
+ digestConfigOwner:
3713
+ type: string
3714
+ required: true
3715
+ /tableau/library/assets/query:
3716
+ post:
3717
+ displayName: postAnalyticsLibraryAssetCollection
3718
+ description: Fetch List of Assets from Analytics Library
3719
+ responses:
3720
+ '200':
3721
+ description: Success
3722
+ body:
3723
+ application/json:
3724
+ type: AnalyticsLibraryAssetCollectionOutputRepresentation
3725
+ body:
3726
+ application/json:
3727
+ type: AnalyticsLibraryCollectionQueryInputRepresentation
3728
+ # required: false
3729
+ (oas-body-name): libraryAssetsQueryInput
3730
+ /ssot/sf-drive/actions/generate-credential:
3731
+ post:
3732
+ displayName: postSfDriveCredentials
3733
+ description: 'Input: https://docs.google.com/document/d/19ifMR8eZA_9iDBolz-fHm0m0e1t3TuTsaiBkHTOxS_Q'
3734
+ responses:
3735
+ '200':
3736
+ description: Success
3737
+ body:
3738
+ application/json:
3739
+ type: SFDriveCredentialRepresentation
3740
+ body:
3741
+ application/json:
3742
+ type: SFDriveCredentialInputRepresentation
3743
+ (oas-body-name): generateSFDriveCredentialsInput
3744
+
3745
+ /tableau/marketplace/listings/{listingId}/install:
3746
+ get:
3747
+ displayName: initiateMarketplaceListingInstallation
3748
+ description: Initiate Marketplace Listing Installation
3749
+ responses:
3750
+ '200':
3751
+ description: Success
3752
+ body:
3753
+ application/json:
3754
+ type: TableauMarketplaceListingInstallationResponse
3755
+ uriParameters:
3756
+ listingId:
3757
+ type: string
3758
+ required: true
3759
+
3760
+ /tableau/marketplace/installations/{installationId}:
3761
+ get:
3762
+ displayName: getMarketplaceListingInstallationProgress
3763
+ description: Fetch progress of Tableau Marketplace Listing Installation
3764
+ responses:
3765
+ '200':
3766
+ description: Success
3767
+ body:
3768
+ application/json:
3769
+ type: TableauMarketplaceListingInstallationProgressResponse
3770
+ uriParameters:
3771
+ installationId:
3772
+ type: string
3773
+ required: true
3774
+ /tableau/marketplace/templates:
3775
+ post:
3776
+ displayName: postMarketplaceTemplateBuilder
3777
+ description: Create a new template.
3778
+ responses:
3779
+ '200':
3780
+ description: Success
3781
+ body:
3782
+ application/json:
3783
+ type: MarketplaceTemplateOutputRepresentation
3784
+ body:
3785
+ application/json:
3786
+ type: MarketplaceTemplateInputRepresentation
3787
+ (oas-body-name): templateInput
3788
+ /tableau/marketplace/listings:
3789
+ post:
3790
+ displayName: publishToMarketplace
3791
+ description: Publish an asset to Tableau Marketplace.
3792
+ responses:
3793
+ '200':
3794
+ description: Success
3795
+ body:
3796
+ application/json:
3797
+ type: MarketplaceListingRepresentation
3798
+ body:
3799
+ application/json:
3800
+ type: MarketplaceListingInputRepresentation
3801
+ (oas-body-name): marketplaceListingInputRepresentation