@qlik/api 1.45.0 → 1.46.0

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 (489) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +2 -2
  4. package/apps.js +2 -2
  5. package/assistants.d.ts +2 -2
  6. package/assistants.js +2 -2
  7. package/audits.d.ts +2 -2
  8. package/audits.js +2 -2
  9. package/auth-types.d.ts +1 -1
  10. package/auth.d.ts +2 -2
  11. package/auth.js +2 -2
  12. package/automation-connections.d.ts +2 -2
  13. package/automation-connections.js +2 -2
  14. package/automations.d.ts +2 -2
  15. package/automations.js +2 -2
  16. package/automl-deployments.d.ts +2 -2
  17. package/automl-deployments.js +2 -2
  18. package/automl-predictions.d.ts +2 -2
  19. package/automl-predictions.js +2 -2
  20. package/brands.d.ts +2 -2
  21. package/brands.js +2 -2
  22. package/chunks/{api-keys-C-ZqA-wl.d.ts → api-keys-D0c8ujRu.d.ts} +3 -3
  23. package/chunks/{apps-k7oY1h_6.d.ts → apps-CdqN0t8i.d.ts} +3 -3
  24. package/chunks/{assistants-BsDbpzl4.d.ts → assistants-BW8V6f0F.d.ts} +36 -36
  25. package/chunks/{audits-5CBpwcdx.d.ts → audits-D0ad6UDR.d.ts} +3 -3
  26. package/chunks/{auth-DFOXWfqh.d.ts → auth-DKv6n_GN.d.ts} +1 -1
  27. package/chunks/{auth-Do2Z8IEt.js → auth-DnVBiC8q.js} +1 -1
  28. package/chunks/{auth-DH6Zx6GE.js → auth-PA8-Loxu.js} +1 -1
  29. package/chunks/{auth-functions-By9Ryr3H.js → auth-functions-B3j26XdM.js} +31 -1
  30. package/chunks/{auth-types-B1c_1Nca.d.ts → auth-types-ua5FEdjz.d.ts} +5 -0
  31. package/chunks/{automation-connections-DRQDgw7Q.d.ts → automation-connections-BJuPyGkj.d.ts} +3 -3
  32. package/chunks/{automations-C0rperoU.d.ts → automations-DDzikXsW.d.ts} +3 -3
  33. package/chunks/{automl-deployments-B-WuR_zE.d.ts → automl-deployments-RC6MYluL.d.ts} +3 -3
  34. package/chunks/{automl-predictions-CewW0eZn.d.ts → automl-predictions-BC_cxfIy.d.ts} +3 -3
  35. package/chunks/{brands-C4eALPrs.d.ts → brands-JtflEMN1.d.ts} +3 -3
  36. package/chunks/{collections-Djmd9gof.d.ts → collections-B17vc2zP.d.ts} +3 -3
  37. package/chunks/{conditions-BRDxUbgu.d.ts → conditions-JgsgLbSx.d.ts} +3 -3
  38. package/chunks/{consumption-UNw8R7jN.d.ts → consumption-BBGQgCsU.d.ts} +3 -3
  39. package/chunks/{csp-origins-_4HBSdgU.d.ts → csp-origins-C2z2ryaw.d.ts} +3 -3
  40. package/chunks/{csrf-token-CsvbqXyY.d.ts → csrf-token-Cwz241tT.d.ts} +3 -3
  41. package/chunks/{data-alerts-DSV3VOnW.d.ts → data-alerts-rxwsP4C7.d.ts} +3 -3
  42. package/chunks/{data-assets-C3U3T_lj.d.ts → data-assets-BRJ0MQgV.d.ts} +3 -3
  43. package/chunks/{data-connections-CYbObLbP.d.ts → data-connections-9H_4Pih5.d.ts} +3 -3
  44. package/chunks/{data-credentials-CgCjw_Cn.d.ts → data-credentials-AULREOtn.d.ts} +3 -3
  45. package/chunks/{data-files-DH19MfYE.d.ts → data-files-CDxGxSIx.d.ts} +3 -3
  46. package/chunks/{data-qualities-BogHQw4I.d.ts → data-qualities-B-v0Njga.d.ts} +3 -3
  47. package/chunks/{data-sets-B27GmshO.d.ts → data-sets-ChmF7dI4.d.ts} +3 -3
  48. package/chunks/{data-sources-3oHpGsDR.d.ts → data-sources-oBO7aHct.d.ts} +3 -3
  49. package/chunks/{data-stores-BjfzMp9W.d.ts → data-stores-C2RE1Aos.d.ts} +3 -3
  50. package/chunks/{dcaas-A7hfpAI5.d.ts → dcaas-D4iZGtLn.d.ts} +3 -3
  51. package/chunks/{di-projects-BmqI8HAl.d.ts → di-projects-BxX0b3lC.d.ts} +3 -3
  52. package/chunks/{direct-access-agents-CfUpbi73.d.ts → direct-access-agents-XxiAo3y9.d.ts} +3 -3
  53. package/chunks/{encryption-CjBmNQDZ.d.ts → encryption-1JNNXFB7.d.ts} +3 -3
  54. package/chunks/{extensions-D05y2FWk.d.ts → extensions-qbclNpnA.d.ts} +3 -3
  55. package/chunks/{glossaries-vYbykU3r.d.ts → glossaries-g1PPnHoM.d.ts} +17 -17
  56. package/chunks/{groups-BapgngJf.d.ts → groups-DrqKqkAv.d.ts} +3 -3
  57. package/chunks/{identity-providers-CAxsp9hP.d.ts → identity-providers-iRAccwIg.d.ts} +3 -3
  58. package/chunks/{interceptors-BF556LaK.d.ts → interceptors-DHkfs1ua.d.ts} +1 -1
  59. package/chunks/{invoke-fetch-hML-5n7w.js → invoke-fetch-BxHtZ6mc.js} +1 -1
  60. package/chunks/{invoke-fetch-DLQ5LN79.js → invoke-fetch-DUEcQxLv.js} +2 -2
  61. package/chunks/{items-CjVrNg57.d.ts → items-N3gAR5AS.d.ts} +3 -3
  62. package/chunks/{knowledgebases-BFiV7Fwh.d.ts → knowledgebases-B0tcNrg8.d.ts} +3 -3
  63. package/chunks/{licenses-yZKgQ2k6.d.ts → licenses-CrB0eiUU.d.ts} +3 -3
  64. package/chunks/{lineage-graphs-Bkc04N-t.d.ts → lineage-graphs-BL1kIsvQ.d.ts} +3 -3
  65. package/chunks/{ml-CPzq_j0K.d.ts → ml-CQQZV57e.d.ts} +3 -3
  66. package/chunks/{notes-C5HjmBeI.d.ts → notes-BWDOf71L.d.ts} +3 -3
  67. package/chunks/{notifications-DfP7aWPH.d.ts → notifications--FW8kp8T.d.ts} +3 -3
  68. package/chunks/{oauth-clients-BmMEDuET.d.ts → oauth-clients-BDI9_NJw.d.ts} +3 -3
  69. package/chunks/{oauth-tokens-Dimf19DE.d.ts → oauth-tokens-CqViLZD0.d.ts} +3 -3
  70. package/chunks/{public-runtime-modules-n0gcxl0_.js → public-runtime-modules-BWdSJoOb.js} +8 -5
  71. package/chunks/{qix-CbiHOu7Z.d.ts → qix-8oI6W8Iq.d.ts} +3 -3
  72. package/chunks/{qix-B_hHiSSK.js → qix-CkFE9Ji0.js} +1 -1
  73. package/chunks/{qix-Wsz3JE_a.js → qix-OogL83RB.js} +3 -3
  74. package/chunks/{qix-chunk-entrypoint-w25mSjTi.js → qix-chunk-entrypoint-BtxQC2m8.js} +1 -1
  75. package/chunks/{questions-CFN7BgWt.d.ts → questions-DAXXmfTM.d.ts} +3 -3
  76. package/chunks/{quotas-BUH2e2K_.d.ts → quotas-BV0q47cU.d.ts} +3 -3
  77. package/chunks/{reload-tasks-DN3X2-30.d.ts → reload-tasks-DORwZo4c.d.ts} +3 -3
  78. package/chunks/{reloads-CpY6F3Y0.d.ts → reloads-C7RAAgAu.d.ts} +3 -3
  79. package/chunks/{report-templates-D5KOFkRi.d.ts → report-templates-C3P0_-D3.d.ts} +3 -3
  80. package/chunks/{reports-CRwCogRL.d.ts → reports-C7saF89N.d.ts} +3 -3
  81. package/chunks/{roles-DCzyiLdU.d.ts → roles-DBdOYajz.d.ts} +3 -3
  82. package/chunks/{sharing-tasks-DsxFrADQ.d.ts → sharing-tasks-Dm9L1sMF.d.ts} +3 -3
  83. package/chunks/{spaces-B0cx23Nc.d.ts → spaces-CjF6Q30z.d.ts} +3 -3
  84. package/chunks/{tasks-DWfE5JM_.d.ts → tasks-CX1ohkzr.d.ts} +3 -3
  85. package/chunks/{temp-contents-CU94UTZU.d.ts → temp-contents-D-NhmvhI.d.ts} +3 -3
  86. package/chunks/{tenants-DvtbiwAP.d.ts → tenants-BbFJ4gEC.d.ts} +3 -3
  87. package/chunks/{themes-BPkyCLWS.d.ts → themes-DCHwpvan.d.ts} +3 -3
  88. package/chunks/{transports-DlRmSWLj.d.ts → transports-CQoT2abX.d.ts} +15 -15
  89. package/chunks/{ui-config-BqX-bPjf.d.ts → ui-config-8gkgFE8J.d.ts} +3 -3
  90. package/chunks/{users-CuQ0nboa.d.ts → users-D7kk0z77.d.ts} +3 -3
  91. package/chunks/{web-integrations-D54LCd0Z.d.ts → web-integrations-BMiMloLY.d.ts} +3 -3
  92. package/chunks/{web-notifications-sUlHGnmy.d.ts → web-notifications-CGGnIRRw.d.ts} +3 -3
  93. package/chunks/{webhooks-Dw0FIeFq.d.ts → webhooks-tylLbUkb.d.ts} +3 -3
  94. package/collections.d.ts +2 -2
  95. package/collections.js +2 -2
  96. package/conditions.d.ts +2 -2
  97. package/conditions.js +2 -2
  98. package/consumption.d.ts +2 -2
  99. package/consumption.js +2 -2
  100. package/csp-origins.d.ts +2 -2
  101. package/csp-origins.js +2 -2
  102. package/csrf-token.d.ts +2 -2
  103. package/csrf-token.js +2 -2
  104. package/data-alerts.d.ts +2 -2
  105. package/data-alerts.js +2 -2
  106. package/data-assets.d.ts +2 -2
  107. package/data-assets.js +2 -2
  108. package/data-connections.d.ts +2 -2
  109. package/data-connections.js +2 -2
  110. package/data-credentials.d.ts +2 -2
  111. package/data-credentials.js +2 -2
  112. package/data-files.d.ts +2 -2
  113. package/data-files.js +2 -2
  114. package/data-qualities.d.ts +2 -2
  115. package/data-qualities.js +2 -2
  116. package/data-sets.d.ts +2 -2
  117. package/data-sets.js +2 -2
  118. package/data-sources.d.ts +2 -2
  119. package/data-sources.js +2 -2
  120. package/data-stores.d.ts +2 -2
  121. package/data-stores.js +2 -2
  122. package/dcaas.d.ts +2 -2
  123. package/dcaas.js +2 -2
  124. package/di-projects.d.ts +2 -2
  125. package/di-projects.js +2 -2
  126. package/direct-access-agents.d.ts +2 -2
  127. package/direct-access-agents.js +2 -2
  128. package/encryption.d.ts +2 -2
  129. package/encryption.js +2 -2
  130. package/extensions.d.ts +2 -2
  131. package/extensions.js +2 -2
  132. package/global-types.d.ts +1 -1
  133. package/glossaries.d.ts +2 -2
  134. package/glossaries.js +9 -9
  135. package/groups.d.ts +2 -2
  136. package/groups.js +2 -2
  137. package/identity-providers.d.ts +2 -2
  138. package/identity-providers.js +2 -2
  139. package/index.d.ts +79 -79
  140. package/index.js +188 -185
  141. package/interceptors.d.ts +2 -2
  142. package/invoke-fetch-types.d.ts +1 -1
  143. package/items.d.ts +2 -2
  144. package/items.js +2 -2
  145. package/knowledgebases.d.ts +2 -2
  146. package/knowledgebases.js +2 -2
  147. package/licenses.d.ts +2 -2
  148. package/licenses.js +2 -2
  149. package/lineage-graphs.d.ts +2 -2
  150. package/lineage-graphs.js +2 -2
  151. package/ml.d.ts +2 -2
  152. package/ml.js +2 -2
  153. package/notes.d.ts +2 -2
  154. package/notes.js +2 -2
  155. package/notifications.d.ts +2 -2
  156. package/notifications.js +2 -2
  157. package/oauth-clients.d.ts +2 -2
  158. package/oauth-clients.js +2 -2
  159. package/oauth-tokens.d.ts +2 -2
  160. package/oauth-tokens.js +2 -2
  161. package/package.json +3 -3
  162. package/qix.d.ts +3 -3
  163. package/qix.js +2 -2
  164. package/questions.d.ts +2 -2
  165. package/questions.js +2 -2
  166. package/quotas.d.ts +2 -2
  167. package/quotas.js +2 -2
  168. package/reload-tasks.d.ts +2 -2
  169. package/reload-tasks.js +2 -2
  170. package/reloads.d.ts +2 -2
  171. package/reloads.js +2 -2
  172. package/report-templates.d.ts +2 -2
  173. package/report-templates.js +2 -2
  174. package/reports.d.ts +2 -2
  175. package/reports.js +2 -2
  176. package/roles.d.ts +2 -2
  177. package/roles.js +2 -2
  178. package/sharing-tasks.d.ts +2 -2
  179. package/sharing-tasks.js +2 -2
  180. package/spaces.d.ts +2 -2
  181. package/spaces.js +2 -2
  182. package/tasks.d.ts +2 -2
  183. package/tasks.js +2 -2
  184. package/temp-contents.d.ts +2 -2
  185. package/temp-contents.js +2 -2
  186. package/tenants.d.ts +2 -2
  187. package/tenants.js +2 -2
  188. package/themes.d.ts +2 -2
  189. package/themes.js +2 -2
  190. package/transports.d.ts +2 -2
  191. package/transports.js +8 -8
  192. package/ui-config.d.ts +2 -2
  193. package/ui-config.js +2 -2
  194. package/users.d.ts +2 -2
  195. package/users.js +2 -2
  196. package/web-integrations.d.ts +2 -2
  197. package/web-integrations.js +2 -2
  198. package/web-notifications.d.ts +2 -2
  199. package/web-notifications.js +2 -2
  200. package/webhooks.d.ts +2 -2
  201. package/webhooks.js +2 -2
  202. package/website/assets/navigation.js +1 -1
  203. package/website/assets/search.js +1 -1
  204. package/website/functions/assistants.getAssistantStarters.html +3 -3
  205. package/website/functions/assistants.getAssistantThreads.html +3 -3
  206. package/website/functions/assistants.getAssistants.html +3 -3
  207. package/website/functions/automations.getAutomations.html +3 -3
  208. package/website/functions/glossaries.changeGlossaryTermStatus.html +1 -1
  209. package/website/functions/glossaries.createGlossary.html +1 -1
  210. package/website/functions/glossaries.createGlossaryTermLink.html +1 -1
  211. package/website/functions/glossaries.importGlossary.html +2 -2
  212. package/website/functions/glossaries.patchGlossary.html +1 -1
  213. package/website/functions/glossaries.patchGlossaryCategory.html +1 -1
  214. package/website/functions/knowledgebases.getKnowledgebases.html +3 -3
  215. package/website/functions/transports.deleteEmailConfig.html +1 -1
  216. package/website/functions/transports.getEmailConfig.html +1 -1
  217. package/website/functions/transports.patchEmailConfig.html +1 -1
  218. package/website/functions/transports.sendTestEmail.html +1 -1
  219. package/website/functions/transports.validateEmailConfig.html +1 -1
  220. package/website/functions/transports.verifyEmailConfigConnection.html +1 -1
  221. package/website/interfaces/index.QlikAPI.html +60 -60
  222. package/website/interfaces/qix.GenericObject.html +1 -1
  223. package/website/modules/api-keys.html +1 -1
  224. package/website/modules/apps.html +1 -1
  225. package/website/modules/assistants.html +1 -1
  226. package/website/modules/audits.html +1 -1
  227. package/website/modules/automation-connections.html +1 -1
  228. package/website/modules/automations.html +1 -1
  229. package/website/modules/automl-deployments.html +1 -1
  230. package/website/modules/automl-predictions.html +1 -1
  231. package/website/modules/brands.html +1 -1
  232. package/website/modules/collections.html +1 -1
  233. package/website/modules/conditions.html +1 -1
  234. package/website/modules/consumption.html +1 -1
  235. package/website/modules/csp-origins.html +1 -1
  236. package/website/modules/csrf-token.html +1 -1
  237. package/website/modules/data-alerts.html +1 -1
  238. package/website/modules/data-assets.html +1 -1
  239. package/website/modules/data-connections.html +1 -1
  240. package/website/modules/data-credentials.html +1 -1
  241. package/website/modules/data-files.html +1 -1
  242. package/website/modules/data-qualities.html +1 -1
  243. package/website/modules/data-sets.html +1 -1
  244. package/website/modules/data-sources.html +1 -1
  245. package/website/modules/data-stores.html +1 -1
  246. package/website/modules/dcaas.html +1 -1
  247. package/website/modules/di-projects.html +1 -1
  248. package/website/modules/direct-access-agents.html +1 -1
  249. package/website/modules/encryption.html +1 -1
  250. package/website/modules/extensions.html +1 -1
  251. package/website/modules/glossaries.html +1 -1
  252. package/website/modules/groups.html +1 -1
  253. package/website/modules/identity-providers.html +1 -1
  254. package/website/modules/items.html +1 -1
  255. package/website/modules/knowledgebases.html +1 -1
  256. package/website/modules/licenses.html +1 -1
  257. package/website/modules/lineage-graphs.html +1 -1
  258. package/website/modules/ml.html +1 -1
  259. package/website/modules/notes.html +1 -1
  260. package/website/modules/notifications.html +1 -1
  261. package/website/modules/oauth-clients.html +1 -1
  262. package/website/modules/oauth-tokens.html +1 -1
  263. package/website/modules/questions.html +1 -1
  264. package/website/modules/quotas.html +1 -1
  265. package/website/modules/reload-tasks.html +1 -1
  266. package/website/modules/reloads.html +1 -1
  267. package/website/modules/report-templates.html +1 -1
  268. package/website/modules/reports.html +1 -1
  269. package/website/modules/roles.html +1 -1
  270. package/website/modules/sharing-tasks.html +1 -1
  271. package/website/modules/spaces.html +1 -1
  272. package/website/modules/tasks.html +1 -1
  273. package/website/modules/temp-contents.html +1 -1
  274. package/website/modules/tenants.html +1 -1
  275. package/website/modules/themes.html +1 -1
  276. package/website/modules/transports.html +1 -1
  277. package/website/modules/ui-config.html +1 -1
  278. package/website/modules/users.html +1 -1
  279. package/website/modules/web-integrations.html +1 -1
  280. package/website/modules/web-notifications.html +1 -1
  281. package/website/modules/webhooks.html +1 -1
  282. package/website/types/api-keys.ApiKeysAPI.html +34 -0
  283. package/website/types/apps.AppsAPI.html +241 -0
  284. package/website/types/assistants.AssistantsAPI.html +156 -0
  285. package/website/types/assistants.CreateAssistantHttpError.html +2 -2
  286. package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
  287. package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
  288. package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
  289. package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
  290. package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
  291. package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
  292. package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
  293. package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
  294. package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
  295. package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
  296. package/website/types/assistants.ErrorResponseCode.html +1 -11
  297. package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
  298. package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
  299. package/website/types/assistants.GetAssistantHttpError.html +2 -2
  300. package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
  301. package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
  302. package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
  303. package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
  304. package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
  305. package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
  306. package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
  307. package/website/types/assistants.GetAssistantsHttpError.html +2 -2
  308. package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
  309. package/website/types/assistants.PatchAssistantHttpError.html +2 -2
  310. package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
  311. package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
  312. package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
  313. package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
  314. package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
  315. package/website/types/audits.AuditsAPI.html +27 -0
  316. package/website/types/automation-connections.AutomationConnectionsAPI.html +39 -0
  317. package/website/types/automations.AutomationsAPI.html +100 -0
  318. package/website/types/automl-deployments.AutomlDeploymentsAPI.html +9 -0
  319. package/website/types/automl-predictions.AutomlPredictionsAPI.html +32 -0
  320. package/website/types/brands.BrandsAPI.html +59 -0
  321. package/website/types/collections.CollectionsAPI.html +53 -0
  322. package/website/types/conditions.ConditionsAPI.html +50 -0
  323. package/website/types/consumption.ConsumptionAPI.html +7 -0
  324. package/website/types/csp-origins.CspOriginsAPI.html +27 -0
  325. package/website/{interfaces → types}/csrf-token.CsrfTokenAPI.html +4 -7
  326. package/website/types/data-alerts.DataAlertsAPI.html +73 -0
  327. package/website/types/data-assets.DataAssetsAPI.html +23 -0
  328. package/website/types/data-connections.DataConnectionsAPI.html +54 -0
  329. package/website/types/data-credentials.DataCredentialsAPI.html +35 -0
  330. package/website/types/data-files.DataFilesAPI.html +86 -0
  331. package/website/types/data-qualities.DataQualitiesAPI.html +18 -0
  332. package/website/types/data-sets.DataSetsAPI.html +27 -0
  333. package/website/types/data-sources.DataSourcesAPI.html +25 -0
  334. package/website/types/data-stores.DataStoresAPI.html +47 -0
  335. package/website/types/dcaas.DcaasAPI.html +15 -0
  336. package/website/types/di-projects.DiProjectsAPI.html +104 -0
  337. package/website/types/direct-access-agents.DirectAccessAgentsAPI.html +72 -0
  338. package/website/types/encryption.EncryptionAPI.html +40 -0
  339. package/website/types/extensions.ExtensionsAPI.html +32 -0
  340. package/website/types/glossaries.GlossariesAPI.html +127 -0
  341. package/website/types/groups.GroupsAPI.html +36 -0
  342. package/website/types/identity-providers.IdentityProvidersAPI.html +33 -0
  343. package/website/types/items.ItemsAPI.html +37 -0
  344. package/website/types/knowledgebases.KnowledgebasesAPI.html +90 -0
  345. package/website/types/licenses.LicensesAPI.html +36 -0
  346. package/website/types/lineage-graphs.LineageGraphsAPI.html +60 -0
  347. package/website/types/ml.MlAPI.html +230 -0
  348. package/website/{interfaces → types}/notes.NotesAPI.html +7 -13
  349. package/website/{interfaces → types}/notifications.NotificationsAPI.html +5 -12
  350. package/website/types/oauth-clients.OauthClientsAPI.html +53 -0
  351. package/website/types/oauth-tokens.OauthTokensAPI.html +11 -0
  352. package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
  353. package/website/types/qix.RpcObject.html +1 -1
  354. package/website/types/qix.VariableListItem.html +1 -1
  355. package/website/types/questions.QuestionsAPI.html +12 -0
  356. package/website/types/quotas.QuotasAPI.html +12 -0
  357. package/website/types/reload-tasks.ReloadTasksAPI.html +24 -0
  358. package/website/types/reloads.ReloadsAPI.html +22 -0
  359. package/website/types/report-templates.ReportTemplatesAPI.html +33 -0
  360. package/website/types/reports.ReportsAPI.html +17 -0
  361. package/website/types/roles.RolesAPI.html +24 -0
  362. package/website/types/sharing-tasks.SharingTasksAPI.html +62 -0
  363. package/website/types/spaces.SpacesAPI.html +84 -0
  364. package/website/types/tasks.TasksAPI.html +49 -0
  365. package/website/types/temp-contents.TempContentsAPI.html +17 -0
  366. package/website/types/tenants.TenantsAPI.html +29 -0
  367. package/website/types/themes.ThemesAPI.html +32 -0
  368. package/website/types/transports.TransportsAPI.html +23 -0
  369. package/website/types/ui-config.UiConfigAPI.html +30 -0
  370. package/website/types/users.UsersAPI.html +41 -0
  371. package/website/types/web-integrations.WebIntegrationsAPI.html +24 -0
  372. package/website/types/web-notifications.WebNotificationsAPI.html +30 -0
  373. package/website/types/webhooks.WebhooksAPI.html +47 -0
  374. package/website/variables/index.apiKeys.html +1 -1
  375. package/website/variables/index.apps.html +1 -1
  376. package/website/variables/index.assistants.html +1 -1
  377. package/website/variables/index.audits.html +1 -1
  378. package/website/variables/index.automationConnections.html +1 -1
  379. package/website/variables/index.automations.html +1 -1
  380. package/website/variables/index.automlDeployments.html +1 -1
  381. package/website/variables/index.automlPredictions.html +1 -1
  382. package/website/variables/index.brands.html +1 -1
  383. package/website/variables/index.collections.html +1 -1
  384. package/website/variables/index.conditions.html +1 -1
  385. package/website/variables/index.consumption.html +1 -1
  386. package/website/variables/index.cspOrigins.html +1 -1
  387. package/website/variables/index.csrfToken.html +1 -1
  388. package/website/variables/index.dataAlerts.html +1 -1
  389. package/website/variables/index.dataAssets.html +1 -1
  390. package/website/variables/index.dataConnections.html +1 -1
  391. package/website/variables/index.dataCredentials.html +1 -1
  392. package/website/variables/index.dataFiles.html +1 -1
  393. package/website/variables/index.dataQualities.html +1 -1
  394. package/website/variables/index.dataSets.html +1 -1
  395. package/website/variables/index.dataSources.html +1 -1
  396. package/website/variables/index.dataStores.html +1 -1
  397. package/website/variables/index.dcaas.html +1 -1
  398. package/website/variables/index.diProjects.html +1 -1
  399. package/website/variables/index.directAccessAgents.html +1 -1
  400. package/website/variables/index.encryption.html +1 -1
  401. package/website/variables/index.extensions.html +1 -1
  402. package/website/variables/index.glossaries.html +1 -1
  403. package/website/variables/index.groups.html +1 -1
  404. package/website/variables/index.identityProviders.html +1 -1
  405. package/website/variables/index.items.html +1 -1
  406. package/website/variables/index.knowledgebases.html +1 -1
  407. package/website/variables/index.licenses.html +1 -1
  408. package/website/variables/index.lineageGraphs.html +1 -1
  409. package/website/variables/index.ml.html +1 -1
  410. package/website/variables/index.notes.html +1 -1
  411. package/website/variables/index.notifications.html +1 -1
  412. package/website/variables/index.oauthClients.html +1 -1
  413. package/website/variables/index.oauthTokens.html +1 -1
  414. package/website/variables/index.questions.html +1 -1
  415. package/website/variables/index.quotas.html +1 -1
  416. package/website/variables/index.reloadTasks.html +1 -1
  417. package/website/variables/index.reloads.html +1 -1
  418. package/website/variables/index.reportTemplates.html +1 -1
  419. package/website/variables/index.reports.html +1 -1
  420. package/website/variables/index.roles.html +1 -1
  421. package/website/variables/index.sharingTasks.html +1 -1
  422. package/website/variables/index.spaces.html +1 -1
  423. package/website/variables/index.tasks.html +1 -1
  424. package/website/variables/index.tempContents.html +1 -1
  425. package/website/variables/index.tenants.html +1 -1
  426. package/website/variables/index.themes.html +1 -1
  427. package/website/variables/index.transports.html +1 -1
  428. package/website/variables/index.uiConfig.html +1 -1
  429. package/website/variables/index.users.html +1 -1
  430. package/website/variables/index.webIntegrations.html +1 -1
  431. package/website/variables/index.webNotifications.html +1 -1
  432. package/website/variables/index.webhooks.html +1 -1
  433. package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
  434. package/website/interfaces/api-keys.ApiKeysAPI.html +0 -66
  435. package/website/interfaces/apps.AppsAPI.html +0 -486
  436. package/website/interfaces/assistants.AssistantsAPI.html +0 -300
  437. package/website/interfaces/audits.AuditsAPI.html +0 -55
  438. package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +0 -73
  439. package/website/interfaces/automations.AutomationsAPI.html +0 -199
  440. package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +0 -19
  441. package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +0 -56
  442. package/website/interfaces/brands.BrandsAPI.html +0 -115
  443. package/website/interfaces/collections.CollectionsAPI.html +0 -119
  444. package/website/interfaces/conditions.ConditionsAPI.html +0 -87
  445. package/website/interfaces/consumption.ConsumptionAPI.html +0 -20
  446. package/website/interfaces/csp-origins.CspOriginsAPI.html +0 -65
  447. package/website/interfaces/data-alerts.DataAlertsAPI.html +0 -162
  448. package/website/interfaces/data-assets.DataAssetsAPI.html +0 -40
  449. package/website/interfaces/data-connections.DataConnectionsAPI.html +0 -125
  450. package/website/interfaces/data-credentials.DataCredentialsAPI.html +0 -67
  451. package/website/interfaces/data-files.DataFilesAPI.html +0 -268
  452. package/website/interfaces/data-qualities.DataQualitiesAPI.html +0 -33
  453. package/website/interfaces/data-sets.DataSetsAPI.html +0 -50
  454. package/website/interfaces/data-sources.DataSourcesAPI.html +0 -50
  455. package/website/interfaces/data-stores.DataStoresAPI.html +0 -92
  456. package/website/interfaces/dcaas.DcaasAPI.html +0 -26
  457. package/website/interfaces/di-projects.DiProjectsAPI.html +0 -192
  458. package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +0 -131
  459. package/website/interfaces/encryption.EncryptionAPI.html +0 -68
  460. package/website/interfaces/extensions.ExtensionsAPI.html +0 -59
  461. package/website/interfaces/glossaries.GlossariesAPI.html +0 -271
  462. package/website/interfaces/groups.GroupsAPI.html +0 -73
  463. package/website/interfaces/identity-providers.IdentityProvidersAPI.html +0 -60
  464. package/website/interfaces/items.ItemsAPI.html +0 -97
  465. package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +0 -175
  466. package/website/interfaces/licenses.LicensesAPI.html +0 -70
  467. package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +0 -133
  468. package/website/interfaces/ml.MlAPI.html +0 -552
  469. package/website/interfaces/oauth-clients.OauthClientsAPI.html +0 -99
  470. package/website/interfaces/oauth-tokens.OauthTokensAPI.html +0 -22
  471. package/website/interfaces/questions.QuestionsAPI.html +0 -23
  472. package/website/interfaces/quotas.QuotasAPI.html +0 -22
  473. package/website/interfaces/reload-tasks.ReloadTasksAPI.html +0 -46
  474. package/website/interfaces/reloads.ReloadsAPI.html +0 -56
  475. package/website/interfaces/report-templates.ReportTemplatesAPI.html +0 -63
  476. package/website/interfaces/reports.ReportsAPI.html +0 -36
  477. package/website/interfaces/roles.RolesAPI.html +0 -47
  478. package/website/interfaces/sharing-tasks.SharingTasksAPI.html +0 -131
  479. package/website/interfaces/spaces.SpacesAPI.html +0 -171
  480. package/website/interfaces/tasks.TasksAPI.html +0 -102
  481. package/website/interfaces/temp-contents.TempContentsAPI.html +0 -33
  482. package/website/interfaces/tenants.TenantsAPI.html +0 -50
  483. package/website/interfaces/themes.ThemesAPI.html +0 -59
  484. package/website/interfaces/transports.TransportsAPI.html +0 -38
  485. package/website/interfaces/ui-config.UiConfigAPI.html +0 -51
  486. package/website/interfaces/users.UsersAPI.html +0 -112
  487. package/website/interfaces/web-integrations.WebIntegrationsAPI.html +0 -46
  488. package/website/interfaces/web-notifications.WebNotificationsAPI.html +0 -57
  489. package/website/interfaces/webhooks.WebhooksAPI.html +0 -101
@@ -0,0 +1,54 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataConnectionsAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data-connections.html">data-connections</a></li><li><a href="" aria-current="page">DataConnectionsAPI</a></li></ul><h1>Type Alias DataConnectionsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">DataConnectionsAPI</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#createdataconnection">createDataConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.createDataConnection.html" class="tsd-signature-type tsd-kind-function">createDataConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletedataconnection">deleteDataConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.deleteDataConnection.html" class="tsd-signature-type tsd-kind-function">deleteDataConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletedataconnections">deleteDataConnections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.deleteDataConnections.html" class="tsd-signature-type tsd-kind-function">deleteDataConnections</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#duplicatedataaconnection">duplicateDataAConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.duplicateDataAConnection.html" class="tsd-signature-type tsd-kind-function">duplicateDataAConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdataconnection">getDataConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.getDataConnection.html" class="tsd-signature-type tsd-kind-function">getDataConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdataconnections">getDataConnections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.getDataConnections.html" class="tsd-signature-type tsd-kind-function">getDataConnections</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchdataconnection">patchDataConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.patchDataConnection.html" class="tsd-signature-type tsd-kind-function">patchDataConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#updatedataconnection">updateDataConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.updateDataConnection.html" class="tsd-signature-type tsd-kind-function">updateDataConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#updatedataconnections">updateDataConnections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.updateDataConnections.html" class="tsd-signature-type tsd-kind-function">updateDataConnections</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
2
+ <a href="#createdataconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Data<wbr/>Connection</span></a>
3
+ <a href="#deletedataconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Connection</span></a>
4
+ <a href="#deletedataconnections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Connections</span></a>
5
+ <a href="#duplicatedataaconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>duplicate<wbr/>Data<wbr/>A<wbr/>Connection</span></a>
6
+ <a href="#getdataconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Connection</span></a>
7
+ <a href="#getdataconnections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Connections</span></a>
8
+ <a href="#patchdataconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Data<wbr/>Connection</span></a>
9
+ <a href="#updatedataconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Connection</span></a>
10
+ <a href="#updatedataconnections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Connections</span></a>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for data-connections api requests.</p>
12
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createdataconnection"><span>create<wbr/>Data<wbr/>Connection</span><a href="#createdataconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createDataConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.createDataConnection.html" class="tsd-signature-type tsd-kind-function">createDataConnection</a></div><div class="tsd-comment tsd-typography"><p>Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.</p>
13
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
14
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateDataConnectionHttpError</p>
15
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedataconnection"><span>delete<wbr/>Data<wbr/>Connection</span><a href="#deletedataconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.deleteDataConnection.html" class="tsd-signature-type tsd-kind-function">deleteDataConnection</a></div><div class="tsd-comment tsd-typography"><p>Deletes the specified data connection by ID (or by name when type=connectionname is set in query)</p>
16
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">deleteDataConnection</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;82ee7b44-0c4d-491b-bd38-82640c0430a5&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> type: </span><span class="hl-1">&quot;connectionname&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> spaceId: </span><span class="hl-1">&quot;611bcebaeec1203d88211ac4&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
17
+ </code><button type="button">Copy</button></pre>
18
+
19
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid">Param: qID<a href="#param-qid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Connection ID</p>
20
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
21
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataConnectionHttpError</p>
22
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedataconnections"><span>delete<wbr/>Data<wbr/>Connections</span><a href="#deletedataconnections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataConnections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.deleteDataConnections.html" class="tsd-signature-type tsd-kind-function">deleteDataConnections</a></div><div class="tsd-comment tsd-typography"><p>Delete multiple connections, only available to Admin</p>
23
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
24
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataConnectionsHttpError</p>
25
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="duplicatedataaconnection"><span>duplicate<wbr/>Data<wbr/>A<wbr/>Connection</span><a href="#duplicatedataaconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">duplicateDataAConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.duplicateDataAConnection.html" class="tsd-signature-type tsd-kind-function">duplicateDataAConnection</a></div><div class="tsd-comment tsd-typography"><p>Duplicate a connection</p>
26
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
27
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DuplicateDataAConnectionHttpError</p>
28
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdataconnection"><span>get<wbr/>Data<wbr/>Connection</span><a href="#getdataconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.getDataConnection.html" class="tsd-signature-type tsd-kind-function">getDataConnection</a></div><div class="tsd-comment tsd-typography"><p>Retrieves a connection by connection ID, or by name when the query parameter &quot;type&quot; is set to &quot;connectionname.&quot;</p>
29
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataConnection</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;82ee7b44-0c4d-491b-bd38-82640c0430a5&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> extended: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> type: </span><span class="hl-1">&quot;connectionname&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> credentialId: </span><span class="hl-1">&quot;22379dc5-076e-4fec-ae20-5529a8a57dc2&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> byCredentialName: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> spaceId: </span><span class="hl-1">&quot;611bcebaeec1203d88211ac4&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> noCache: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> parseConnection: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
30
+ </code><button type="button">Copy</button></pre>
31
+
32
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-1">Param: qID<a href="#param-qid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Connection ID</p>
33
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
34
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataConnectionHttpError</p>
35
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdataconnections"><span>get<wbr/>Data<wbr/>Connections</span><a href="#getdataconnections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataConnections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.getDataConnections.html" class="tsd-signature-type tsd-kind-function">getDataConnections</a></div><div class="tsd-comment tsd-typography"><p>Gets a list of connections</p>
36
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataConnections</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> dataName: </span><span class="hl-1">&quot;data&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> extended: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> spaceId: </span><span class="hl-1">&quot;611bcebaeec1203d88211ac4&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> personal: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> owner: </span><span class="hl-1">&quot;928e2a66-01ba-4678-aa32-e74c213896fa&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> ownedByMe: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> limit: </span><span class="hl-2">30</span><span class="hl-0">,</span><br/><span class="hl-0"> sort: </span><span class="hl-1">&quot;+qName&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> page: </span><span class="hl-1">&quot;page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> noDatafiles: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> userId: </span><span class="hl-1">&quot;6K9xjsItDexffolu5vg1oWYkY8x7f-0G&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> caseinsensitive: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> locale: </span><span class="hl-1">&quot;en&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> includeQris: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeDisabled: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
37
+ </code><button type="button">Copy</button></pre>
38
+
39
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-2">Param: query<a href="#param-query-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
40
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataConnectionsHttpError</p>
41
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchdataconnection"><span>patch<wbr/>Data<wbr/>Connection</span><a href="#patchdataconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchDataConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.patchDataConnection.html" class="tsd-signature-type tsd-kind-function">patchDataConnection</a></div><div class="tsd-comment tsd-typography"><p>Patches a connection specified by connection ID (or by name when type=connectionname is set in query).</p>
42
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-2">Param: qID<a href="#param-qid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Connection ID</p>
43
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-3">Param: query<a href="#param-query-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
44
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
45
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchDataConnectionHttpError</p>
46
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatedataconnection"><span>update<wbr/>Data<wbr/>Connection</span><a href="#updatedataconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateDataConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.updateDataConnection.html" class="tsd-signature-type tsd-kind-function">updateDataConnection</a></div><div class="tsd-comment tsd-typography"><p>Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.</p>
47
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-3">Param: qID<a href="#param-qid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Connection ID</p>
48
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-4">Param: query<a href="#param-query-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
49
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-4">Param: body<a href="#param-body-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
50
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateDataConnectionHttpError</p>
51
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatedataconnections"><span>update<wbr/>Data<wbr/>Connections</span><a href="#updatedataconnections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateDataConnections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-connections.updateDataConnections.html" class="tsd-signature-type tsd-kind-function">updateDataConnections</a></div><div class="tsd-comment tsd-typography"><p>Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection.</p>
52
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-5">Param: body<a href="#param-body-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
53
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateDataConnectionsHttpError</p>
54
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clearcache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a><a href="#createdataconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Data<wbr/>Connection</span></a><a href="#deletedataconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Connection</span></a><a href="#deletedataconnections"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Connections</span></a><a href="#duplicatedataaconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>duplicate<wbr/>Data<wbr/>A<wbr/>Connection</span></a><a href="#getdataconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Connection</span></a><a href="#getdataconnections"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Connections</span></a><a href="#patchdataconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Data<wbr/>Connection</span></a><a href="#updatedataconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Connection</span></a><a href="#updatedataconnections"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Connections</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,35 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataCredentialsAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data-credentials.html">data-credentials</a></li><li><a href="" aria-current="page">DataCredentialsAPI</a></li></ul><h1>Type Alias DataCredentialsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">DataCredentialsAPI</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletedatacredential">deleteDataCredential</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.deleteDataCredential.html" class="tsd-signature-type tsd-kind-function">deleteDataCredential</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#filterorphaneddatacredentials">filterOrphanedDataCredentials</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.filterOrphanedDataCredentials.html" class="tsd-signature-type tsd-kind-function">filterOrphanedDataCredentials</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatacredential">getDataCredential</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.getDataCredential.html" class="tsd-signature-type tsd-kind-function">getDataCredential</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchdatacredential">patchDataCredential</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.patchDataCredential.html" class="tsd-signature-type tsd-kind-function">patchDataCredential</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#updatedatacredential">updateDataCredential</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.updateDataCredential.html" class="tsd-signature-type tsd-kind-function">updateDataCredential</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
2
+ <a href="#deletedatacredential" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Credential</span></a>
3
+ <a href="#filterorphaneddatacredentials" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter<wbr/>Orphaned<wbr/>Data<wbr/>Credentials</span></a>
4
+ <a href="#getdatacredential" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Credential</span></a>
5
+ <a href="#patchdatacredential" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Data<wbr/>Credential</span></a>
6
+ <a href="#updatedatacredential" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Credential</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for data-credentials api requests.</p>
8
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedatacredential"><span>delete<wbr/>Data<wbr/>Credential</span><a href="#deletedatacredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataCredential</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.deleteDataCredential.html" class="tsd-signature-type tsd-kind-function">deleteDataCredential</a></div><div class="tsd-comment tsd-typography"><p>Deletes the specified credential by ID (or by name when type=credentialname is set in query)</p>
9
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">deleteDataCredential</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;027d2703-e745-43ec-8876-a2e6ac341700&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> byCredentialName: </span><span class="hl-2">false</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
10
+ </code><button type="button">Copy</button></pre>
11
+
12
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid">Param: qID<a href="#param-qid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Credential ID</p>
13
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
14
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataCredentialHttpError</p>
15
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filterorphaneddatacredentials"><span>filter<wbr/>Orphaned<wbr/>Data<wbr/>Credentials</span><a href="#filterorphaneddatacredentials" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filterOrphanedDataCredentials</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.filterOrphanedDataCredentials.html" class="tsd-signature-type tsd-kind-function">filterOrphanedDataCredentials</a></div><div class="tsd-comment tsd-typography"><p>Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body</p>
16
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
17
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>FilterOrphanedDataCredentialsHttpError</p>
18
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatacredential"><span>get<wbr/>Data<wbr/>Credential</span><a href="#getdatacredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataCredential</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.getDataCredential.html" class="tsd-signature-type tsd-kind-function">getDataCredential</a></div><div class="tsd-comment tsd-typography"><p>Gets a credential by ID (or by name when bycredentialname=true is set in query)</p>
19
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataCredential</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;027d2703-e745-43ec-8876-a2e6ac341700&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> byCredentialName: </span><span class="hl-2">false</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
20
+ </code><button type="button">Copy</button></pre>
21
+
22
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-1">Param: qID<a href="#param-qid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Credential ID</p>
23
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
24
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataCredentialHttpError</p>
25
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchdatacredential"><span>patch<wbr/>Data<wbr/>Credential</span><a href="#patchdatacredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchDataCredential</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.patchDataCredential.html" class="tsd-signature-type tsd-kind-function">patchDataCredential</a></div><div class="tsd-comment tsd-typography"><p>Patches a credential specified by ID (or by name when bycredentialname=true is set in query)</p>
26
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-2">Param: qID<a href="#param-qid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Credential ID</p>
27
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-2">Param: query<a href="#param-query-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
28
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
29
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchDataCredentialHttpError</p>
30
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatedatacredential"><span>update<wbr/>Data<wbr/>Credential</span><a href="#updatedatacredential" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateDataCredential</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-credentials.updateDataCredential.html" class="tsd-signature-type tsd-kind-function">updateDataCredential</a></div><div class="tsd-comment tsd-typography"><p>Updates a credential specified by ID (or by name when bycredentialname=true is set in query)</p>
31
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-qid-3">Param: qID<a href="#param-qid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Credential ID</p>
32
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-3">Param: query<a href="#param-query-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
33
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
34
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateDataCredentialHttpError</p>
35
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clearcache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a><a href="#deletedatacredential"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Credential</span></a><a href="#filterorphaneddatacredentials"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter<wbr/>Orphaned<wbr/>Data<wbr/>Credentials</span></a><a href="#getdatacredential"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Credential</span></a><a href="#patchdatacredential"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Data<wbr/>Credential</span></a><a href="#updatedatacredential"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Credential</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,86 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataFilesAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data-files.html">data-files</a></li><li><a href="" aria-current="page">DataFilesAPI</a></li></ul><h1>Type Alias DataFilesAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">DataFilesAPI</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#changedatafileowner">changeDataFileOwner</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.changeDataFileOwner.html" class="tsd-signature-type tsd-kind-function">changeDataFileOwner</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletedatafile">deleteDataFile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.deleteDataFile.html" class="tsd-signature-type tsd-kind-function">deleteDataFile</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletedatafiles">deleteDataFiles</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.deleteDataFiles.html" class="tsd-signature-type tsd-kind-function">deleteDataFiles</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatafile">getDataFile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFile.html" class="tsd-signature-type tsd-kind-function">getDataFile</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatafileconnection">getDataFileConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFileConnection.html" class="tsd-signature-type tsd-kind-function">getDataFileConnection</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatafiles">getDataFiles</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFiles.html" class="tsd-signature-type tsd-kind-function">getDataFiles</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatafilesconnections">getDataFilesConnections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFilesConnections.html" class="tsd-signature-type tsd-kind-function">getDataFilesConnections</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatafilesquotas">getDataFilesQuotas</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFilesQuotas.html" class="tsd-signature-type tsd-kind-function">getDataFilesQuotas</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#movedatafile">moveDataFile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.moveDataFile.html" class="tsd-signature-type tsd-kind-function">moveDataFile</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#movedatafiles">moveDataFiles</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.moveDataFiles.html" class="tsd-signature-type tsd-kind-function">moveDataFiles</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#reuploaddatafile">reuploadDataFile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.reuploadDataFile.html" class="tsd-signature-type tsd-kind-function">reuploadDataFile</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#uploaddatafile">uploadDataFile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.uploadDataFile.html" class="tsd-signature-type tsd-kind-function">uploadDataFile</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#changedatafileowner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>change<wbr/>Data<wbr/>File<wbr/>Owner</span></a>
2
+ <a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
3
+ <a href="#deletedatafile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>File</span></a>
4
+ <a href="#deletedatafiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Files</span></a>
5
+ <a href="#getdatafile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>File</span></a>
6
+ <a href="#getdatafileconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>File<wbr/>Connection</span></a>
7
+ <a href="#getdatafiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files</span></a>
8
+ <a href="#getdatafilesconnections" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files<wbr/>Connections</span></a>
9
+ <a href="#getdatafilesquotas" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files<wbr/>Quotas</span></a>
10
+ <a href="#movedatafile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Data<wbr/>File</span></a>
11
+ <a href="#movedatafiles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Data<wbr/>Files</span></a>
12
+ <a href="#reuploaddatafile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reupload<wbr/>Data<wbr/>File</span></a>
13
+ <a href="#uploaddatafile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upload<wbr/>Data<wbr/>File</span></a>
14
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="changedatafileowner"><span>change<wbr/>Data<wbr/>File<wbr/>Owner</span><a href="#changedatafileowner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">changeDataFileOwner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.changeDataFileOwner.html" class="tsd-signature-type tsd-kind-function">changeDataFileOwner</a></div><div class="tsd-comment tsd-typography"><p>This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly
15
+ set as part of a create or update operation. For data files or folders that reside in a personal space,
16
+ changing the owner has the effect of moving the data file to the new owner's personal space. Note that,
17
+ If a given file or folder is not in the root of a personal space, this operation will not succeed, since
18
+ the parent folder does not reside in the target owner's personal space. If the owner of a folder in the
19
+ root of a personal space is changed, the owner of all subfolders and files within those subfolders will
20
+ also recursively change.</p>
21
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the data file or folder whose owner will be updated.</p>
22
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
23
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ChangeDataFileOwnerHttpError</p>
24
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for data-files api requests.</p>
25
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedatafile"><span>delete<wbr/>Data<wbr/>File</span><a href="#deletedatafile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.deleteDataFile.html" class="tsd-signature-type tsd-kind-function">deleteDataFile</a></div><div class="tsd-comment tsd-typography"><p>Delete the specified data file or folder. Deleting a folder will also recursively delete all files and
26
+ subfolders that reside within the specified folder.</p>
27
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">deleteDataFile</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc&quot;</span><br/><span class="hl-0">)</span>
28
+ </code><button type="button">Copy</button></pre>
29
+
30
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the data file or folder to delete.</p>
31
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataFileHttpError</p>
32
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedatafiles"><span>delete<wbr/>Data<wbr/>Files</span><a href="#deletedatafiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataFiles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.deleteDataFiles.html" class="tsd-signature-type tsd-kind-function">deleteDataFiles</a></div><div class="tsd-comment tsd-typography"><p>Delete the specified set of data files and/or folders as a single batch.</p>
33
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
34
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataFilesHttpError</p>
35
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatafile"><span>get<wbr/>Data<wbr/>File</span><a href="#getdatafile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFile.html" class="tsd-signature-type tsd-kind-function">getDataFile</a></div><div class="tsd-comment tsd-typography"><p>Get descriptive info for the specified data file.</p>
36
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataFile</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc&quot;</span><br/><span class="hl-0">)</span>
37
+ </code><button type="button">Copy</button></pre>
38
+
39
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-2">Param: id<a href="#param-id-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the data file.</p>
40
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataFileHttpError</p>
41
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatafileconnection"><span>get<wbr/>Data<wbr/>File<wbr/>Connection</span><a href="#getdatafileconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataFileConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFileConnection.html" class="tsd-signature-type tsd-kind-function">getDataFileConnection</a></div><div class="tsd-comment tsd-typography"><p>Get the built-in connection used by the engine to load/write data files given a connection ID.</p>
42
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataFileConnection</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc&quot;</span><br/><span class="hl-0">)</span>
43
+ </code><button type="button">Copy</button></pre>
44
+
45
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-3">Param: id<a href="#param-id-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the connection.</p>
46
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataFileConnectionHttpError</p>
47
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatafiles"><span>get<wbr/>Data<wbr/>Files</span><a href="#getdatafiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataFiles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFiles.html" class="tsd-signature-type tsd-kind-function">getDataFiles</a></div><div class="tsd-comment tsd-typography"><p>Get descriptive info for the specified data files.</p>
48
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataFiles</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> allowInternalFiles: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> appId: </span><span class="hl-1">&quot;f34b91a1-0dc3-44ac-a847-51cb84122c84&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> baseNameWildcard: </span><span class="hl-1">&quot;*SomeFileName*&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> connectionId: </span><span class="hl-1">&quot;ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> excludeFiles: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> excludeSubFolders: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> folderId: </span><span class="hl-1">&quot;ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> folderPath: </span><span class="hl-1">&quot;some/folder&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> includeAllSpaces: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> includeFolders: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> includeFolderStats: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> limit: </span><span class="hl-2">5</span><span class="hl-0">,</span><br/><span class="hl-0"> name: </span><span class="hl-1">&quot;MyFile.csv&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> notOwnerId: </span><span class="hl-1">&quot;lDL4DIINndhL_iJkcbqWyJenuwizP-2D&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> ownerId: </span><span class="hl-1">&quot;lDL4DIINndhL_iJkcbqWyJenuwizP-2D&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> page: </span><span class="hl-1">&quot;NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
49
+ </code><button type="button">Copy</button></pre>
50
+
51
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
52
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataFilesHttpError</p>
53
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatafilesconnections"><span>get<wbr/>Data<wbr/>Files<wbr/>Connections</span><a href="#getdatafilesconnections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataFilesConnections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFilesConnections.html" class="tsd-signature-type tsd-kind-function">getDataFilesConnections</a></div><div class="tsd-comment tsd-typography"><p>The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
54
+ the given user has access to.</p>
55
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataFilesConnections</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> appId: </span><span class="hl-1">&quot;f34b91a1-0dc3-44ac-a847-51cb84122c84&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> includeSpaceStats: </span><span class="hl-2">false</span><span class="hl-0">,</span><br/><span class="hl-0"> limit: </span><span class="hl-2">5</span><span class="hl-0">,</span><br/><span class="hl-0"> name: </span><span class="hl-1">&quot;MySenseApp&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> page: </span><span class="hl-1">&quot;NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> personal: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> spaceId: </span><span class="hl-1">&quot;617979737a9f56e49dea2e6e&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
56
+ </code><button type="button">Copy</button></pre>
57
+
58
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
59
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataFilesConnectionsHttpError</p>
60
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatafilesquotas"><span>get<wbr/>Data<wbr/>Files<wbr/>Quotas</span><a href="#getdatafilesquotas" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataFilesQuotas</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.getDataFilesQuotas.html" class="tsd-signature-type tsd-kind-function">getDataFilesQuotas</a></div><div class="tsd-comment tsd-typography"><p>Get quota information for the calling user.</p>
61
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataFilesQuotasHttpError</p>
62
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="movedatafile"><span>move<wbr/>Data<wbr/>File</span><a href="#movedatafile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">moveDataFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.moveDataFile.html" class="tsd-signature-type tsd-kind-function">moveDataFile</a></div><div class="tsd-comment tsd-typography"><p>This is to allow for a separate admin type of operation that is more global in terms of access in cases
63
+ where admin users may not explicitly have been granted full access to a given space within the declared
64
+ space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing
65
+ in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not
66
+ in the root of a given space, this operation will not succeed, since the parent folder does not reside in
67
+ the target space. If the space of a folder in the root of the source space is changed, all subfolders and
68
+ files within those subfolders will also recursively be moved to the new space.</p>
69
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-4">Param: id<a href="#param-id-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the data file or folder whose
70
+ space will be updated.</p>
71
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
72
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>MoveDataFileHttpError</p>
73
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="movedatafiles"><span>move<wbr/>Data<wbr/>Files</span><a href="#movedatafiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">moveDataFiles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.moveDataFiles.html" class="tsd-signature-type tsd-kind-function">moveDataFiles</a></div><div class="tsd-comment tsd-typography"><p>This is to allow for a separate admin type of operation that is more global in terms of access in cases
74
+ where admin users may not explicitly have been granted full access to a given space within the declared
75
+ space-level permissions. If the space ID is set to null, then the data file or folder will end up residing
76
+ in the personal space of the user who is the owner of the item.</p>
77
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
78
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>MoveDataFilesHttpError</p>
79
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reuploaddatafile"><span>reupload<wbr/>Data<wbr/>File</span><a href="#reuploaddatafile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reuploadDataFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.reuploadDataFile.html" class="tsd-signature-type tsd-kind-function">reuploadDataFile</a></div><div class="tsd-comment tsd-typography"><p>Re-upload an existing data file or update an existing folder.</p>
80
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-5">Param: id<a href="#param-id-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the data file to update.</p>
81
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-4">Param: body<a href="#param-body-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
82
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ReuploadDataFileHttpError</p>
83
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uploaddatafile"><span>upload<wbr/>Data<wbr/>File</span><a href="#uploaddatafile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uploadDataFile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/data-files.uploadDataFile.html" class="tsd-signature-type tsd-kind-function">uploadDataFile</a></div><div class="tsd-comment tsd-typography"><p>Upload a new data file or create a new folder.</p>
84
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-5">Param: body<a href="#param-body-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
85
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UploadDataFileHttpError</p>
86
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#changedatafileowner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>change<wbr/>Data<wbr/>File<wbr/>Owner</span></a><a href="#clearcache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a><a href="#deletedatafile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>File</span></a><a href="#deletedatafiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Data<wbr/>Files</span></a><a href="#getdatafile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>File</span></a><a href="#getdatafileconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>File<wbr/>Connection</span></a><a href="#getdatafiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files</span></a><a href="#getdatafilesconnections"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files<wbr/>Connections</span></a><a href="#getdatafilesquotas"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Files<wbr/>Quotas</span></a><a href="#movedatafile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Data<wbr/>File</span></a><a href="#movedatafiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Data<wbr/>Files</span></a><a href="#reuploaddatafile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reupload<wbr/>Data<wbr/>File</span></a><a href="#uploaddatafile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upload<wbr/>Data<wbr/>File</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>