agent-generator 1.0.3 → 1.0.5

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 (770) hide show
  1. package/install-extension.js +1 -1
  2. package/package.json +2 -4
  3. package/Generator_Patterns/Conditional.md +0 -84
  4. package/Generator_Patterns/Dynamic.md +0 -129
  5. package/Generator_Patterns/PathConfig.properties +0 -4
  6. package/Generator_Patterns/README.md +0 -118
  7. package/Generator_Patterns/Reference.md +0 -98
  8. package/Generator_Patterns/Remote.md +0 -259
  9. package/Generator_Patterns/Static.md +0 -99
  10. package/source/api-data-generators/.idea/api-data-generators.iml +0 -9
  11. package/source/api-data-generators/.idea/misc.xml +0 -6
  12. package/source/api-data-generators/.idea/modules.xml +0 -8
  13. package/source/api-data-generators/.idea/vcs.xml +0 -6
  14. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +0 -318
  15. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +0 -32
  16. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +0 -21
  17. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +0 -18
  18. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +0 -39
  19. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +0 -157
  20. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +0 -46
  21. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +0 -16
  22. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +0 -33
  23. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +0 -13
  24. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +0 -91
  25. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +0 -18
  26. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +0 -42
  27. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +0 -92
  28. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +0 -51
  29. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +0 -11
  30. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +0 -41
  31. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +0 -18
  32. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +0 -76
  33. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +0 -51
  34. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +0 -25
  35. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +0 -26
  36. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +0 -18
  37. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +0 -17
  38. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +0 -17
  39. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +0 -21
  40. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +0 -32
  41. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +0 -43
  42. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +0 -631
  43. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +0 -70
  44. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +0 -294
  45. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +0 -58
  46. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +0 -74
  47. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +0 -11
  48. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +0 -24
  49. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +0 -259
  50. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +0 -6
  51. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +0 -14
  52. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +0 -19
  53. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +0 -265
  54. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +0 -48
  55. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +0 -47
  56. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +0 -14
  57. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +0 -52
  58. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +0 -33
  59. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +0 -45
  60. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +0 -38
  61. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +0 -50
  62. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +0 -22
  63. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +0 -217
  64. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +0 -30
  65. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +0 -31
  66. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +0 -36
  67. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +0 -32
  68. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +0 -49
  69. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +0 -66
  70. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +0 -294
  71. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +0 -150
  72. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +0 -238
  73. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +0 -147
  74. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +0 -56
  75. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +0 -397
  76. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +0 -1123
  77. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +0 -26
  78. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +0 -26
  79. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +0 -49
  80. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +0 -58
  81. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +0 -27
  82. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +0 -20
  83. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +0 -13
  84. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +0 -24
  85. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +0 -29
  86. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +0 -115
  87. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +0 -64
  88. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +0 -288
  89. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +0 -119
  90. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +0 -37
  91. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +0 -26
  92. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +0 -211
  93. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +0 -40
  94. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +0 -32
  95. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +0 -72
  96. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +0 -247
  97. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +0 -51
  98. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +0 -65
  99. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +0 -77
  100. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +0 -14
  101. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +0 -44
  102. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +0 -35
  103. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +0 -185
  104. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +0 -43
  105. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +0 -313
  106. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +0 -16
  107. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +0 -121
  108. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +0 -350
  109. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +0 -16
  110. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +0 -19
  111. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +0 -509
  112. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +0 -32
  113. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +0 -63
  114. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +0 -370
  115. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +0 -44
  116. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +0 -47
  117. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +0 -52
  118. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +0 -11
  119. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +0 -45
  120. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +0 -184
  121. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +0 -30
  122. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +0 -93
  123. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +0 -19
  124. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +0 -202
  125. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +0 -56
  126. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +0 -334
  127. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +0 -113
  128. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +0 -68
  129. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +0 -16
  130. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +0 -270
  131. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +0 -70
  132. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +0 -486
  133. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +0 -77
  134. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +0 -305
  135. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +0 -126
  136. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +0 -205
  137. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +0 -90
  138. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +0 -33
  139. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +0 -228
  140. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +0 -44
  141. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +0 -156
  142. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +0 -50
  143. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +0 -17
  144. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +0 -37
  145. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +0 -45
  146. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +0 -6
  147. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +0 -21
  148. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +0 -106
  149. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +0 -205
  150. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +0 -196
  151. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +0 -45
  152. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +0 -77
  153. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +0 -14
  154. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +0 -689
  155. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +0 -64
  156. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +0 -61
  157. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +0 -49
  158. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +0 -44
  159. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +0 -108
  160. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +0 -39
  161. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +0 -54
  162. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +0 -1031
  163. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +0 -564
  164. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +0 -36
  165. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +0 -180
  166. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +0 -60
  167. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +0 -26
  168. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +0 -240
  169. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +0 -16
  170. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +0 -216
  171. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +0 -168
  172. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +0 -29
  173. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +0 -98
  174. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +0 -11
  175. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +0 -93
  176. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +0 -34
  177. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +0 -18
  178. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +0 -25
  179. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +0 -65
  180. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +0 -155
  181. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +0 -92
  182. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +0 -22
  183. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +0 -19
  184. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +0 -143
  185. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +0 -39
  186. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +0 -312
  187. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +0 -35
  188. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +0 -16
  189. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +0 -32
  190. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +0 -297
  191. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +0 -38
  192. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +0 -56
  193. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +0 -149
  194. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +0 -77
  195. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +0 -52
  196. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +0 -229
  197. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +0 -16
  198. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +0 -90
  199. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +0 -25
  200. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +0 -66
  201. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +0 -49
  202. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +0 -23
  203. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +0 -131
  204. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +0 -214
  205. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +0 -30
  206. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +0 -173
  207. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +0 -21
  208. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +0 -93
  209. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +0 -103
  210. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +0 -503
  211. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +0 -19
  212. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +0 -334
  213. package/source/api-data-generators/support/License/test_data_generation_configurations.json +0 -60
  214. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +0 -72
  215. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +0 -34
  216. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +0 -184
  217. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +0 -32
  218. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +0 -38
  219. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +0 -38
  220. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +0 -50
  221. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +0 -16
  222. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +0 -96
  223. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +0 -26
  224. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +0 -19
  225. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +0 -20
  226. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +0 -27
  227. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +0 -19
  228. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +0 -29
  229. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +0 -79
  230. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +0 -109
  231. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +0 -66
  232. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +0 -113
  233. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +0 -28
  234. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +0 -17
  235. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +0 -54
  236. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +0 -54
  237. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +0 -77
  238. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +0 -14
  239. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +0 -32
  240. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +0 -66
  241. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +0 -64
  242. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +0 -32
  243. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +0 -196
  244. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +0 -48
  245. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +0 -59
  246. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +0 -37
  247. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +0 -239
  248. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +0 -52
  249. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +0 -52
  250. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +0 -538
  251. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +0 -28
  252. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +0 -100
  253. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +0 -29
  254. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +0 -84
  255. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +0 -58
  256. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +0 -50
  257. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +0 -29
  258. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +0 -22
  259. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +0 -42
  260. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +0 -92
  261. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +0 -46
  262. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +0 -50
  263. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +0 -22
  264. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +0 -203
  265. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +0 -172
  266. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +0 -182
  267. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +0 -636
  268. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +0 -32
  269. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +0 -32
  270. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +0 -62
  271. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +0 -24
  272. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +0 -164
  273. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +0 -21
  274. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +0 -60
  275. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +0 -51
  276. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +0 -40
  277. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +0 -47
  278. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +0 -22
  279. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +0 -223
  280. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +0 -22
  281. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +0 -76
  282. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +0 -104
  283. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +0 -43
  284. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +0 -65
  285. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +0 -29
  286. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +0 -97
  287. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +0 -219
  288. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +0 -42
  289. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +0 -45
  290. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +0 -87
  291. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +0 -27
  292. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +0 -115
  293. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +0 -72
  294. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +0 -383
  295. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +0 -694
  296. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +0 -66
  297. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +0 -58
  298. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +0 -82
  299. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +0 -43
  300. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +0 -65
  301. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +0 -16
  302. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +0 -99
  303. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +0 -475
  304. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +0 -110
  305. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +0 -48
  306. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +0 -91
  307. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +0 -46
  308. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +0 -68
  309. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +0 -54
  310. package/source/api-data-generators/support/User/test_data_generation_configurations.json +0 -100
  311. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +0 -49
  312. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +0 -19
  313. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +0 -19
  314. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +0 -321
  315. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +0 -501
  316. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +0 -166
  317. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +0 -26
  318. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +0 -38
  319. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +0 -22
  320. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +0 -19
  321. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +0 -22
  322. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +0 -33
  323. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +0 -71
  324. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +0 -859
  325. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +0 -26
  326. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +0 -652
  327. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +0 -21
  328. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +0 -50
  329. package/source/openapi-specifications/v1.0/common/Common.json +0 -587
  330. package/source/openapi-specifications/v1.0/portal/Account.json +0 -183
  331. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +0 -1103
  332. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +0 -133
  333. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +0 -712
  334. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +0 -91
  335. package/source/openapi-specifications/v1.0/portal/Attachment.json +0 -122
  336. package/source/openapi-specifications/v1.0/portal/Captcha.json +0 -334
  337. package/source/openapi-specifications/v1.0/portal/Category.json +0 -1061
  338. package/source/openapi-specifications/v1.0/portal/Comment.json +0 -1546
  339. package/source/openapi-specifications/v1.0/portal/Community.json +0 -235
  340. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +0 -296
  341. package/source/openapi-specifications/v1.0/portal/Contact.json +0 -536
  342. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +0 -163
  343. package/source/openapi-specifications/v1.0/portal/Department.json +0 -246
  344. package/source/openapi-specifications/v1.0/portal/Extension.json +0 -1122
  345. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +0 -96
  346. package/source/openapi-specifications/v1.0/portal/Field.json +0 -1239
  347. package/source/openapi-specifications/v1.0/portal/FileExport.json +0 -313
  348. package/source/openapi-specifications/v1.0/portal/Followers.json +0 -802
  349. package/source/openapi-specifications/v1.0/portal/Gamification.json +0 -819
  350. package/source/openapi-specifications/v1.0/portal/HashTags.json +0 -61
  351. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +0 -605
  352. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +0 -148
  353. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +0 -920
  354. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +0 -118
  355. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +0 -184
  356. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +0 -70
  357. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +0 -1310
  358. package/source/openapi-specifications/v1.0/portal/KbCategory.json +0 -1525
  359. package/source/openapi-specifications/v1.0/portal/KbSection.json +0 -515
  360. package/source/openapi-specifications/v1.0/portal/Label.json +0 -172
  361. package/source/openapi-specifications/v1.0/portal/Layout.json +0 -303
  362. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +0 -375
  363. package/source/openapi-specifications/v1.0/portal/Mentions.json +0 -580
  364. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +0 -699
  365. package/source/openapi-specifications/v1.0/portal/Permalink.json +0 -265
  366. package/source/openapi-specifications/v1.0/portal/Placeholders.json +0 -57
  367. package/source/openapi-specifications/v1.0/portal/Product.json +0 -401
  368. package/source/openapi-specifications/v1.0/portal/Solution.json +0 -3766
  369. package/source/openapi-specifications/v1.0/portal/Thread.json +0 -821
  370. package/source/openapi-specifications/v1.0/portal/Ticket.json +0 -2636
  371. package/source/openapi-specifications/v1.0/portal/TicketComment.json +0 -822
  372. package/source/openapi-specifications/v1.0/portal/TicketCount.json +0 -336
  373. package/source/openapi-specifications/v1.0/portal/TicketExport.json +0 -609
  374. package/source/openapi-specifications/v1.0/portal/TicketField.json +0 -358
  375. package/source/openapi-specifications/v1.0/portal/TicketForm.json +0 -517
  376. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +0 -155
  377. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +0 -409
  378. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +0 -175
  379. package/source/openapi-specifications/v1.0/portal/Topic.json +0 -4079
  380. package/source/openapi-specifications/v1.0/portal/Translation.json +0 -174
  381. package/source/openapi-specifications/v1.0/portal/Upload.json +0 -156
  382. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +0 -309
  383. package/source/openapi-specifications/v1.0/portal/View.json +0 -353
  384. package/source/openapi-specifications/v1.0/portal/Widget.json +0 -218
  385. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +0 -354
  386. package/source/openapi-specifications/v1.0/support/Account.json +0 -3206
  387. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +0 -484
  388. package/source/openapi-specifications/v1.0/support/AccountComments.json +0 -794
  389. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +0 -227
  390. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +0 -578
  391. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +0 -350
  392. package/source/openapi-specifications/v1.0/support/AccountSla.json +0 -341
  393. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +0 -1152
  394. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +0 -573
  395. package/source/openapi-specifications/v1.0/support/Activity.json +0 -1400
  396. package/source/openapi-specifications/v1.0/support/Actor.json +0 -88
  397. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +0 -304
  398. package/source/openapi-specifications/v1.0/support/AdminTool.json +0 -489
  399. package/source/openapi-specifications/v1.0/support/Agent.json +0 -6685
  400. package/source/openapi-specifications/v1.0/support/AgentPresence.json +0 -567
  401. package/source/openapi-specifications/v1.0/support/AgentRoom.json +0 -1997
  402. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +0 -359
  403. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +0 -1402
  404. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +0 -510
  405. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +0 -1189
  406. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +0 -543
  407. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +0 -155
  408. package/source/openapi-specifications/v1.0/support/ArchivedView.json +0 -469
  409. package/source/openapi-specifications/v1.0/support/Article.json +0 -5060
  410. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +0 -544
  411. package/source/openapi-specifications/v1.0/support/ArticleComment.json +0 -1929
  412. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +0 -56
  413. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +0 -1314
  414. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +0 -513
  415. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +0 -2510
  416. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +0 -3053
  417. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +0 -7530
  418. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +0 -184
  419. package/source/openapi-specifications/v1.0/support/ArticleViews.json +0 -564
  420. package/source/openapi-specifications/v1.0/support/Asap.json +0 -1525
  421. package/source/openapi-specifications/v1.0/support/AsapModule.json +0 -246
  422. package/source/openapi-specifications/v1.0/support/AsapStatus.json +0 -199
  423. package/source/openapi-specifications/v1.0/support/AssistInteg.json +0 -613
  424. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +0 -786
  425. package/source/openapi-specifications/v1.0/support/AuditLog.json +0 -1122
  426. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +0 -702
  427. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +0 -868
  428. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +0 -1181
  429. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +0 -207
  430. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +0 -809
  431. package/source/openapi-specifications/v1.0/support/AutomationTask.json +0 -1054
  432. package/source/openapi-specifications/v1.0/support/Backup.json +0 -2845
  433. package/source/openapi-specifications/v1.0/support/Badge.json +0 -544
  434. package/source/openapi-specifications/v1.0/support/Bot.json +0 -2103
  435. package/source/openapi-specifications/v1.0/support/BotInference.json +0 -1071
  436. package/source/openapi-specifications/v1.0/support/BotResources.json +0 -175
  437. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +0 -541
  438. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +0 -63
  439. package/source/openapi-specifications/v1.0/support/Bots.json +0 -58
  440. package/source/openapi-specifications/v1.0/support/BugInteg.json +0 -481
  441. package/source/openapi-specifications/v1.0/support/BulkAction.json +0 -150
  442. package/source/openapi-specifications/v1.0/support/BulkImport.json +0 -2845
  443. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +0 -743
  444. package/source/openapi-specifications/v1.0/support/BulkWrite.json +0 -678
  445. package/source/openapi-specifications/v1.0/support/BusinessHour.json +0 -1344
  446. package/source/openapi-specifications/v1.0/support/Call.json +0 -3839
  447. package/source/openapi-specifications/v1.0/support/CallComments.json +0 -721
  448. package/source/openapi-specifications/v1.0/support/CallHistory.json +0 -936
  449. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +0 -1745
  450. package/source/openapi-specifications/v1.0/support/CallTimer.json +0 -285
  451. package/source/openapi-specifications/v1.0/support/Channel.json +0 -730
  452. package/source/openapi-specifications/v1.0/support/Chart.json +0 -422
  453. package/source/openapi-specifications/v1.0/support/ChatTicket.json +0 -553
  454. package/source/openapi-specifications/v1.0/support/ClientAction.json +0 -1834
  455. package/source/openapi-specifications/v1.0/support/ClientEvent.json +0 -780
  456. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +0 -1123
  457. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +0 -528
  458. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +0 -44
  459. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +0 -94
  460. package/source/openapi-specifications/v1.0/support/Community.json +0 -2545
  461. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +0 -249
  462. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +0 -1896
  463. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +0 -145
  464. package/source/openapi-specifications/v1.0/support/CommunityComment.json +0 -2492
  465. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +0 -129
  466. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +0 -343
  467. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +0 -78
  468. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +0 -6005
  469. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +0 -310
  470. package/source/openapi-specifications/v1.0/support/CommunityUser.json +0 -822
  471. package/source/openapi-specifications/v1.0/support/Composite.json +0 -414
  472. package/source/openapi-specifications/v1.0/support/Contact.json +0 -4691
  473. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +0 -484
  474. package/source/openapi-specifications/v1.0/support/ContactComments.json +0 -769
  475. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +0 -683
  476. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +0 -350
  477. package/source/openapi-specifications/v1.0/support/ContactProfile.json +0 -195
  478. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +0 -1157
  479. package/source/openapi-specifications/v1.0/support/Contract.json +0 -2877
  480. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +0 -307
  481. package/source/openapi-specifications/v1.0/support/Conversation.json +0 -570
  482. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +0 -5279
  483. package/source/openapi-specifications/v1.0/support/CreditCycle.json +0 -124
  484. package/source/openapi-specifications/v1.0/support/Criteria.json +0 -1014
  485. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +0 -50
  486. package/source/openapi-specifications/v1.0/support/CrmInteg.json +0 -5938
  487. package/source/openapi-specifications/v1.0/support/CustomAction.json +0 -2106
  488. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +0 -1327
  489. package/source/openapi-specifications/v1.0/support/CustomButton.json +0 -1898
  490. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +0 -883
  491. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +0 -329
  492. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +0 -317
  493. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +0 -379
  494. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +0 -3457
  495. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +0 -81
  496. package/source/openapi-specifications/v1.0/support/CustomTheme.json +0 -7391
  497. package/source/openapi-specifications/v1.0/support/CustomView.json +0 -3478
  498. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +0 -464
  499. package/source/openapi-specifications/v1.0/support/DBThrottle.json +0 -334
  500. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +0 -1163
  501. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +0 -1258
  502. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +0 -2310
  503. package/source/openapi-specifications/v1.0/support/Dashboards.json +0 -1219
  504. package/source/openapi-specifications/v1.0/support/DataChips.json +0 -477
  505. package/source/openapi-specifications/v1.0/support/DataImport.json +0 -1099
  506. package/source/openapi-specifications/v1.0/support/DataSync.json +0 -1246
  507. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +0 -153
  508. package/source/openapi-specifications/v1.0/support/Department.json +0 -1971
  509. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +0 -656
  510. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +0 -232
  511. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +0 -722
  512. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +0 -91
  513. package/source/openapi-specifications/v1.0/support/DomainMapping.json +0 -1143
  514. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +0 -306
  515. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +0 -1491
  516. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +0 -572
  517. package/source/openapi-specifications/v1.0/support/Event.json +0 -3607
  518. package/source/openapi-specifications/v1.0/support/EventComments.json +0 -737
  519. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +0 -1520
  520. package/source/openapi-specifications/v1.0/support/EventTimer.json +0 -285
  521. package/source/openapi-specifications/v1.0/support/Expression.json +0 -43
  522. package/source/openapi-specifications/v1.0/support/Extension.json +0 -7152
  523. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +0 -129
  524. package/source/openapi-specifications/v1.0/support/FAQ.json +0 -142
  525. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +0 -178
  526. package/source/openapi-specifications/v1.0/support/FbManager.json +0 -1147
  527. package/source/openapi-specifications/v1.0/support/Feature.json +0 -691
  528. package/source/openapi-specifications/v1.0/support/FeatureFile.json +0 -435
  529. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +0 -576
  530. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +0 -492
  531. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +0 -318
  532. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +0 -198
  533. package/source/openapi-specifications/v1.0/support/Field.json +0 -7493
  534. package/source/openapi-specifications/v1.0/support/FieldDetails.json +0 -139
  535. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +0 -113
  536. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +0 -3831
  537. package/source/openapi-specifications/v1.0/support/FileExport.json +0 -324
  538. package/source/openapi-specifications/v1.0/support/Finance.json +0 -4290
  539. package/source/openapi-specifications/v1.0/support/Followers.json +0 -875
  540. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +0 -47
  541. package/source/openapi-specifications/v1.0/support/GC_Bots.json +0 -138
  542. package/source/openapi-specifications/v1.0/support/GC_Guide.json +0 -1536
  543. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +0 -58
  544. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +0 -79
  545. package/source/openapi-specifications/v1.0/support/GC_Guides.json +0 -89
  546. package/source/openapi-specifications/v1.0/support/GC_Info.json +0 -208
  547. package/source/openapi-specifications/v1.0/support/GC_Status.json +0 -69
  548. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +0 -79
  549. package/source/openapi-specifications/v1.0/support/GenericAction.json +0 -1888
  550. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +0 -1050
  551. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +0 -1715
  552. package/source/openapi-specifications/v1.0/support/GoogleChat.json +0 -650
  553. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +0 -44
  554. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +0 -900
  555. package/source/openapi-specifications/v1.0/support/Helpcenter.json +0 -1212
  556. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +0 -331
  557. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +0 -1496
  558. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +0 -504
  559. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +0 -208
  560. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +0 -64
  561. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +0 -211
  562. package/source/openapi-specifications/v1.0/support/HolidayList.json +0 -731
  563. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +0 -1091
  564. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +0 -1357
  565. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +0 -169
  566. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +0 -624
  567. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +0 -597
  568. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +0 -841
  569. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +0 -64
  570. package/source/openapi-specifications/v1.0/support/IM_Bot.json +0 -1007
  571. package/source/openapi-specifications/v1.0/support/IM_BotService.json +0 -357
  572. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +0 -323
  573. package/source/openapi-specifications/v1.0/support/IM_Channel.json +0 -2849
  574. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +0 -502
  575. package/source/openapi-specifications/v1.0/support/IM_Contact.json +0 -165
  576. package/source/openapi-specifications/v1.0/support/IM_Efc.json +0 -188
  577. package/source/openapi-specifications/v1.0/support/IM_Integration.json +0 -1269
  578. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +0 -454
  579. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +0 -625
  580. package/source/openapi-specifications/v1.0/support/IM_License.json +0 -225
  581. package/source/openapi-specifications/v1.0/support/IM_Message.json +0 -1371
  582. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +0 -462
  583. package/source/openapi-specifications/v1.0/support/IM_Search.json +0 -547
  584. package/source/openapi-specifications/v1.0/support/IM_Session.json +0 -1397
  585. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +0 -142
  586. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +0 -83
  587. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +0 -86
  588. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +0 -73
  589. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +0 -435
  590. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +0 -202
  591. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +0 -193
  592. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +0 -489
  593. package/source/openapi-specifications/v1.0/support/Import.json +0 -1844
  594. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +0 -395
  595. package/source/openapi-specifications/v1.0/support/Inference.json +0 -307
  596. package/source/openapi-specifications/v1.0/support/InlineImage.json +0 -97
  597. package/source/openapi-specifications/v1.0/support/IntegModule.json +0 -938
  598. package/source/openapi-specifications/v1.0/support/Integrations.json +0 -1264
  599. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +0 -539
  600. package/source/openapi-specifications/v1.0/support/JWT.json +0 -535
  601. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +0 -208
  602. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +0 -241
  603. package/source/openapi-specifications/v1.0/support/KBPreference.json +0 -323
  604. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +0 -2316
  605. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +0 -2839
  606. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +0 -570
  607. package/source/openapi-specifications/v1.0/support/KBSection.json +0 -1941
  608. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +0 -169
  609. package/source/openapi-specifications/v1.0/support/KPIWidget.json +0 -206
  610. package/source/openapi-specifications/v1.0/support/KbBot.json +0 -511
  611. package/source/openapi-specifications/v1.0/support/KbCategory.json +0 -1618
  612. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +0 -124
  613. package/source/openapi-specifications/v1.0/support/Label.json +0 -1251
  614. package/source/openapi-specifications/v1.0/support/Layout.json +0 -8042
  615. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +0 -491
  616. package/source/openapi-specifications/v1.0/support/LayoutRules.json +0 -1422
  617. package/source/openapi-specifications/v1.0/support/LensInteg.json +0 -86
  618. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +0 -548
  619. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +0 -1231
  620. package/source/openapi-specifications/v1.0/support/LicenseTool.json +0 -165
  621. package/source/openapi-specifications/v1.0/support/Livecall.json +0 -954
  622. package/source/openapi-specifications/v1.0/support/LookupRecord.json +0 -174
  623. package/source/openapi-specifications/v1.0/support/Macros.json +0 -1960
  624. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +0 -1263
  625. package/source/openapi-specifications/v1.0/support/MassAction.json +0 -1151
  626. package/source/openapi-specifications/v1.0/support/MassActionError.json +0 -55
  627. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +0 -89
  628. package/source/openapi-specifications/v1.0/support/Mentions.json +0 -491
  629. package/source/openapi-specifications/v1.0/support/Message.json +0 -685
  630. package/source/openapi-specifications/v1.0/support/Microsoft.json +0 -887
  631. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +0 -574
  632. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +0 -903
  633. package/source/openapi-specifications/v1.0/support/Misc.json +0 -214
  634. package/source/openapi-specifications/v1.0/support/Module.json +0 -1625
  635. package/source/openapi-specifications/v1.0/support/NewCriteria.json +0 -1863
  636. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +0 -204
  637. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +0 -150
  638. package/source/openapi-specifications/v1.0/support/NotificationRules.json +0 -441
  639. package/source/openapi-specifications/v1.0/support/OEmbedData.json +0 -233
  640. package/source/openapi-specifications/v1.0/support/Onboarding.json +0 -282
  641. package/source/openapi-specifications/v1.0/support/Organization.json +0 -1391
  642. package/source/openapi-specifications/v1.0/support/PBGroup.json +0 -634
  643. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +0 -433
  644. package/source/openapi-specifications/v1.0/support/PBPlatform.json +0 -1447
  645. package/source/openapi-specifications/v1.0/support/PBX.json +0 -550
  646. package/source/openapi-specifications/v1.0/support/PBXConfig.json +0 -219
  647. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +0 -443
  648. package/source/openapi-specifications/v1.0/support/PBXPreference.json +0 -314
  649. package/source/openapi-specifications/v1.0/support/PageSense.json +0 -1505
  650. package/source/openapi-specifications/v1.0/support/PendingApproval.json +0 -279
  651. package/source/openapi-specifications/v1.0/support/Permalink.json +0 -393
  652. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +0 -1014
  653. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +0 -118
  654. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +0 -1115
  655. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +0 -232
  656. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +0 -499
  657. package/source/openapi-specifications/v1.0/support/Product.json +0 -1861
  658. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +0 -485
  659. package/source/openapi-specifications/v1.0/support/Profile.json +0 -4236
  660. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +0 -989
  661. package/source/openapi-specifications/v1.0/support/QueryStore.json +0 -238
  662. package/source/openapi-specifications/v1.0/support/QueueView.json +0 -335
  663. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +0 -1204
  664. package/source/openapi-specifications/v1.0/support/Records.json +0 -1509
  665. package/source/openapi-specifications/v1.0/support/Recyclebin.json +0 -669
  666. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +0 -401
  667. package/source/openapi-specifications/v1.0/support/Report.json +0 -6491
  668. package/source/openapi-specifications/v1.0/support/ReportChart.json +0 -254
  669. package/source/openapi-specifications/v1.0/support/ReportFolder.json +0 -1076
  670. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +0 -202
  671. package/source/openapi-specifications/v1.0/support/RequestFlags.json +0 -358
  672. package/source/openapi-specifications/v1.0/support/Resources.json +0 -335
  673. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +0 -128
  674. package/source/openapi-specifications/v1.0/support/Role.json +0 -996
  675. package/source/openapi-specifications/v1.0/support/RoundRobin.json +0 -796
  676. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +0 -381
  677. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +0 -615
  678. package/source/openapi-specifications/v1.0/support/RuleGroup.json +0 -1630
  679. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +0 -227
  680. package/source/openapi-specifications/v1.0/support/Saml.json +0 -565
  681. package/source/openapi-specifications/v1.0/support/Sandbox.json +0 -1075
  682. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +0 -501
  683. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +0 -428
  684. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +0 -295
  685. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +0 -268
  686. package/source/openapi-specifications/v1.0/support/SavedFilters.json +0 -652
  687. package/source/openapi-specifications/v1.0/support/Schedule.json +0 -2077
  688. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +0 -2271
  689. package/source/openapi-specifications/v1.0/support/Search.json +0 -12600
  690. package/source/openapi-specifications/v1.0/support/SearchInteg.json +0 -2254
  691. package/source/openapi-specifications/v1.0/support/Setup.json +0 -1766
  692. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +0 -1110
  693. package/source/openapi-specifications/v1.0/support/SharingRule.json +0 -287
  694. package/source/openapi-specifications/v1.0/support/Signature.json +0 -354
  695. package/source/openapi-specifications/v1.0/support/Skill.json +0 -2164
  696. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +0 -269
  697. package/source/openapi-specifications/v1.0/support/SkillType.json +0 -807
  698. package/source/openapi-specifications/v1.0/support/Slack.json +0 -957
  699. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +0 -514
  700. package/source/openapi-specifications/v1.0/support/Snippets.json +0 -918
  701. package/source/openapi-specifications/v1.0/support/SocialBrands.json +0 -427
  702. package/source/openapi-specifications/v1.0/support/SocialInteg.json +0 -336
  703. package/source/openapi-specifications/v1.0/support/SocialPosts.json +0 -2460
  704. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +0 -337
  705. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +0 -690
  706. package/source/openapi-specifications/v1.0/support/Statistics.json +0 -125
  707. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +0 -2419
  708. package/source/openapi-specifications/v1.0/support/Supervise.json +0 -774
  709. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +0 -188
  710. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +0 -293
  711. package/source/openapi-specifications/v1.0/support/SupportPlan.json +0 -1109
  712. package/source/openapi-specifications/v1.0/support/Tab.json +0 -606
  713. package/source/openapi-specifications/v1.0/support/Target.json +0 -1311
  714. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +0 -130
  715. package/source/openapi-specifications/v1.0/support/Task.json +0 -4006
  716. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +0 -443
  717. package/source/openapi-specifications/v1.0/support/TaskComments.json +0 -706
  718. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +0 -1756
  719. package/source/openapi-specifications/v1.0/support/TaskTimer.json +0 -441
  720. package/source/openapi-specifications/v1.0/support/Team.json +0 -1383
  721. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +0 -1069
  722. package/source/openapi-specifications/v1.0/support/Theme.json +0 -152
  723. package/source/openapi-specifications/v1.0/support/Thread.json +0 -3545
  724. package/source/openapi-specifications/v1.0/support/Ticket.json +0 -9495
  725. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +0 -855
  726. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +0 -562
  727. package/source/openapi-specifications/v1.0/support/TicketComment.json +0 -1444
  728. package/source/openapi-specifications/v1.0/support/TicketCount.json +0 -690
  729. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +0 -454
  730. package/source/openapi-specifications/v1.0/support/TicketHistory.json +0 -414
  731. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +0 -369
  732. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +0 -178
  733. package/source/openapi-specifications/v1.0/support/TicketTag.json +0 -1513
  734. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +0 -907
  735. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +0 -1681
  736. package/source/openapi-specifications/v1.0/support/TicketTimer.json +0 -1205
  737. package/source/openapi-specifications/v1.0/support/TimeTracking.json +0 -1212
  738. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +0 -614
  739. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +0 -163
  740. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +0 -2772
  741. package/source/openapi-specifications/v1.0/support/Upload.json +0 -620
  742. package/source/openapi-specifications/v1.0/support/User.json +0 -1409
  743. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +0 -617
  744. package/source/openapi-specifications/v1.0/support/UserPresence.json +0 -763
  745. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +0 -107
  746. package/source/openapi-specifications/v1.0/support/ValidationRules.json +0 -1173
  747. package/source/openapi-specifications/v1.0/support/Webhook.json +0 -1330
  748. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +0 -132
  749. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +0 -143
  750. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +0 -132
  751. package/source/openapi-specifications/v1.0/support/Widget.json +0 -3023
  752. package/source/openapi-specifications/v1.0/support/WmsDomain.json +0 -104
  753. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +0 -756
  754. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +0 -989
  755. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +0 -135
  756. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +0 -376
  757. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +0 -159
  758. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +0 -3229
  759. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +0 -453
  760. package/source/openapi-specifications/v1.0/support/Zwitch.json +0 -1543
  761. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +0 -201
  762. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +0 -75
  763. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +0 -255
  764. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +0 -1677
  765. package/source/openapi-specifications/v1.0/support/blueprintStates.json +0 -284
  766. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +0 -91
  767. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +0 -1546
  768. package/source/openapi-specifications/v1.0/support/blueprints.json +0 -2992
  769. package/source/openapi-specifications/v1.0/support/errors.json +0 -80
  770. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +0 -416
@@ -1,2839 +0,0 @@
1
- {
2
- "openapi" : "3.1.0",
3
- "info" : {
4
- "title" : "KBRootCategory",
5
- "version" : "1.0.0",
6
- "x-clan-group" : "helpCenter",
7
- "x-module-group" : "kb"
8
- },
9
- "paths" : {
10
- "/api/v1/kbRootCategories/{rootCategoryId}/reviewOwners/remove" : {
11
- "post" : {
12
- "tags" : [ "KBRootCategory" ],
13
- "summary" : "Remove review owner",
14
- "description" : "This API removes review owners of a root category in your helpdesk",
15
- "operationId" : "deleteKBCategoryReviewOwners",
16
- "parameters" : [ {
17
- "$ref" : "#/components/parameters/rootCategoryId"
18
- }, {
19
- "$ref" : "../common/Common.json#/components/parameters/orgId"
20
- } ],
21
- "requestBody" : {
22
- "$ref" : "#/components/requestBodies/addReviewOwnerJson"
23
- },
24
- "responses" : {
25
- "422" : {
26
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
27
- },
28
- "200" : {
29
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
30
- }
31
- },
32
- "security" : [ {
33
- "org-oauth" : [ "accessAll.ALL" ]
34
- }, {
35
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
36
- } ],
37
- "x-audience" : [ "external-public" ],
38
- "x-custom-url-attribute" : {
39
- "security" : {
40
- "throttle" : {
41
- "inline" : [ {
42
- "scope" : "APPSERVER",
43
- "rules" : [ {
44
- "duration" : 60000,
45
- "lock-period" : 600000,
46
- "threshold" : 25,
47
- "hip" : false
48
- }, {
49
- "duration" : 3600000,
50
- "lock-period" : 1800000,
51
- "threshold" : 200,
52
- "hip" : false
53
- } ],
54
- "window" : "ROLLING",
55
- "key" : "url.path+user.zuid"
56
- } ]
57
- },
58
- "extraparams" : {
59
- "disable" : true,
60
- "ignore" : false
61
- },
62
- "authentication" : { }
63
- },
64
- "clan-group" : "helpCenter",
65
- "apihash" : "f1e4888c86484b06f35e4243acfca87f",
66
- "module-group" : "kb",
67
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.removeReviewOwners"
68
- }
69
- }
70
- },
71
- "/api/v1/kbRootCategories/{rootCategoryId}/translations/{locale}/permalinks" : {
72
- "get" : {
73
- "tags" : [ "KBRootCategory" ],
74
- "summary" : "Get permalinks of a root category translation",
75
- "description" : "This API fetches permalinks of a root category translation",
76
- "operationId" : "getSecondaryPermalinks",
77
- "parameters" : [ {
78
- "$ref" : "#/components/parameters/locale"
79
- }, {
80
- "$ref" : "#/components/parameters/rootCategoryId"
81
- }, {
82
- "$ref" : "../common/Common.json#/components/parameters/orgId"
83
- } ],
84
- "responses" : {
85
- "422" : {
86
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
87
- },
88
- "200" : {
89
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArrayWithOldResponse"
90
- }
91
- },
92
- "security" : [ {
93
- "org-oauth" : [ "accessAll.ALL" ]
94
- }, {
95
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
96
- } ],
97
- "x-audience" : [ "company-internal" ],
98
- "x-custom-url-attribute" : {
99
- "security" : {
100
- "throttle" : {
101
- "inline" : [ {
102
- "scope" : "APPSERVER",
103
- "rules" : [ {
104
- "duration" : 60000,
105
- "lock-period" : 600000,
106
- "threshold" : 25,
107
- "hip" : false
108
- }, {
109
- "duration" : 3600000,
110
- "lock-period" : 1800000,
111
- "threshold" : 200,
112
- "hip" : false
113
- } ],
114
- "window" : "ROLLING",
115
- "key" : "url.path+user.zuid"
116
- } ]
117
- },
118
- "extraparams" : {
119
- "disable" : true,
120
- "ignore" : false
121
- },
122
- "authentication" : { }
123
- },
124
- "clan-group" : "helpCenter",
125
- "apihash" : "330ca6fb151ef7696a18fe20c2be9498",
126
- "module-group" : "kb",
127
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getPermalinksOfATranslationOfARootCategory"
128
- }
129
- },
130
- "post" : {
131
- "tags" : [ "KBRootCategory" ],
132
- "summary" : "Update permalinks of a root category",
133
- "description" : "API updates primary and secondary permalinks of a KB root category",
134
- "operationId" : "updateRootCategoryPermalinks",
135
- "parameters" : [ {
136
- "$ref" : "#/components/parameters/locale"
137
- }, {
138
- "$ref" : "#/components/parameters/rootCategoryId"
139
- }, {
140
- "$ref" : "../common/Common.json#/components/parameters/orgId"
141
- } ],
142
- "requestBody" : {
143
- "$ref" : "#/components/requestBodies/permalinkUpdateJson"
144
- },
145
- "responses" : {
146
- "422" : {
147
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
148
- },
149
- "200" : {
150
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArray"
151
- }
152
- },
153
- "security" : [ {
154
- "org-oauth" : [ "accessAll.ALL" ]
155
- }, {
156
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
157
- } ],
158
- "x-audience" : [ "company-internal" ],
159
- "x-custom-url-attribute" : {
160
- "security" : {
161
- "throttle" : {
162
- "inline" : [ {
163
- "scope" : "APPSERVER",
164
- "rules" : [ {
165
- "duration" : 60000,
166
- "lock-period" : 300000,
167
- "threshold" : 10,
168
- "hip" : false
169
- }, {
170
- "duration" : 3600000,
171
- "lock-period" : 1200000,
172
- "threshold" : 50,
173
- "hip" : false
174
- } ],
175
- "window" : "ROLLING",
176
- "key" : "url.path+user.zuid"
177
- } ]
178
- },
179
- "extraparams" : {
180
- "disable" : true,
181
- "ignore" : false
182
- },
183
- "authentication" : { }
184
- },
185
- "clan-group" : "helpCenter",
186
- "apihash" : "e5b3eede5060abfb915fd1e761e86f3b",
187
- "module-group" : "kb",
188
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.updateKBRootCategoryPermalinks"
189
- }
190
- }
191
- },
192
- "/api/v1/kbRootCategories/{rootCategoryId}" : {
193
- "get" : {
194
- "tags" : [ "KBRootCategory" ],
195
- "summary" : "Get root category",
196
- "description" : "This API fetches the details of a root category.",
197
- "operationId" : "getKBRootCategory",
198
- "parameters" : [ {
199
- "$ref" : "#/components/parameters/rootCategoryId"
200
- }, {
201
- "$ref" : "../common/Common.json#/components/parameters/orgId"
202
- },{
203
- "name" : "include",
204
- "in" : "query",
205
- "required" : false,
206
- "style" : "simple",
207
- "explode" : true,
208
- "schema" : {
209
- "type" : [ "null", "array" ],
210
- "items" : {
211
- "type" : [ "string", "null" ],
212
- "enum" : [ "publicArticlesCount", "allArticlesCount", "followersCount", "canCurrentUserReview", "portalUrl" ],
213
- "maxLength" : 100,
214
- "minLength" : 0,
215
- "x-custom-parameters-attributes" : [ ]
216
- },
217
- "uniqueItems" : true
218
- }
219
- } ],
220
- "responses" : {
221
- "200" : {
222
- "$ref" : "#/components/responses/rootCategoryResponse"
223
- }
224
- },
225
- "security" : [ {
226
- "org-oauth" : [ "accessAll.ALL" ]
227
- }, {
228
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
229
- } ],
230
- "x-audience" : [ "external-public" ],
231
- "x-custom-url-attribute" : {
232
- "security" : {
233
- "throttle" : {
234
- "policy" : "ReadAPI_Lenient_UserPolicy"
235
- },
236
- "extraparams" : {
237
- "disable" : true,
238
- "ignore" : false
239
- },
240
- "authentication" : { }
241
- },
242
- "clan-group" : "helpCenter",
243
- "apihash" : "ae47dfb4c436f84d380c17850fefd368",
244
- "module-group" : "kb",
245
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getARootCategory"
246
- }
247
- },
248
- "patch" : {
249
- "tags" : [ "KBRootCategory" ],
250
- "summary" : "Update root category",
251
- "description" : "This API updates the settings of a root category.",
252
- "operationId" : "updateRootCategory",
253
- "parameters" : [ {
254
- "$ref" : "#/components/parameters/rootCategoryId"
255
- }, {
256
- "$ref" : "../common/Common.json#/components/parameters/orgId"
257
- } ],
258
- "requestBody" : {
259
- "$ref" : "#/components/requestBodies/updateRootCategory_createCategoryJson"
260
- },
261
- "responses" : {
262
- "200" : {
263
- "$ref" : "#/components/responses/rootCategoryResponse"
264
- },
265
- "422" : {
266
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
267
- }
268
- },
269
- "security" : [ {
270
- "org-oauth" : [ "accessAll.ALL" ]
271
- }, {
272
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
273
- } ],
274
- "x-audience" : [ "company-internal" ],
275
- "x-custom-url-attribute" : {
276
- "security" : {
277
- "throttle" : {
278
- "policy" : "WriteAPI_Standard_UserPolicy"
279
- },
280
- "extraparams" : {
281
- "disable" : true,
282
- "ignore" : false
283
- },
284
- "authentication" : { }
285
- },
286
- "clan-group" : "helpCenter",
287
- "apihash" : "790d179e685cdf1963b4e8d9b02a31d1",
288
- "module-group" : "kb",
289
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.updateARootCategory"
290
- }
291
- }
292
- },
293
- "/api/v1/kbRootCategories" : {
294
- "get" : {
295
- "tags" : [ "KBRootCategory" ],
296
- "summary" : "List root categories",
297
- "description" : "This API lists a particular number of root categories, based on the limit defined.",
298
- "operationId" : "getAllKBRootCategories",
299
- "parameters" : [ {
300
- "name" : "include",
301
- "in" : "query",
302
- "description" : "Additional information related to the category. Values allowed are: publicArticlesCount, allArticlesCount, publishedArticleCount, allArticleTemplateCount and sectionsCount.",
303
- "required" : false,
304
- "style" : "simple",
305
- "explode" : true,
306
- "schema" : {
307
- "type" : [ "null", "array" ],
308
- "description" : "Additional information related to the category. Values allowed are: publicArticlesCount, allArticlesCount, publishedArticleCount, allArticleTemplateCount and sectionsCount.",
309
- "items" : {
310
- "type" : [ "string", "null" ],
311
- "enum" : [ "publicArticlesCount", "sectionsCount", "allArticlesCount", "publishedArticleCount", "followersCount", "canCurrentUserReview", "allArticleTemplateCount" ],
312
- "maxLength" : 100,
313
- "minLength" : 0,
314
- "x-custom-parameters-attributes" : [ ]
315
- },
316
- "uniqueItems" : true
317
- }
318
- }, {
319
- "name" : "isReviewEnabled",
320
- "in" : "query",
321
- "description" : "Key that specifies whether the category must be reviewed or not",
322
- "required" : false,
323
- "style" : "form",
324
- "explode" : true,
325
- "schema" : {
326
- "type" : [ "boolean", "null" ],
327
- "description" : "Key that specifies whether the category must be reviewed or not"
328
- }
329
- }, {
330
- "name" : "departmentId",
331
- "in" : "query",
332
- "description" : "ID of the department associated with the category",
333
- "required" : false,
334
- "style" : "form",
335
- "explode" : true,
336
- "schema" : {
337
- "type" : [ "string", "null", "integer" ],
338
- "format" : "int64",
339
- "description" : "ID of the department associated with the category",
340
- "pattern" : "([0-9]+)",
341
- "x-custom-parameters-attributes" : {
342
- "split" : ","
343
- }
344
- }
345
- }, {
346
- "name" : "sortBy",
347
- "in" : "query",
348
- "description" : "Key that sorts the categories, based on a specific attribute: name or order",
349
- "required" : false,
350
- "style" : "form",
351
- "explode" : true,
352
- "schema" : {
353
- "type" : [ "string", "null" ],
354
- "description" : "Key that sorts the categories, based on a specific attribute: name or order",
355
- "enum" : [ "name", "order" ],
356
- "maxLength" : 100,
357
- "minLength" : 0
358
- }
359
- }, {
360
- "$ref" : "../common/Common.json#/components/parameters/orgId"
361
- } ],
362
- "responses" : {
363
- "200" : {
364
- "$ref" : "#/components/responses/listAllCategoryResponse"
365
- }
366
- },
367
- "security" : [ {
368
- "org-oauth" : [ "accessAll.ALL" ]
369
- }, {
370
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
371
- } ],
372
- "x-audience" : [ "external-public" ],
373
- "x-custom-url-attribute" : {
374
- "security" : {
375
- "throttle" : {
376
- "policy" : "ReadAPI_Stringent_UserPolicy"
377
- },
378
- "extraparams" : {
379
- "disable" : true,
380
- "ignore" : false
381
- },
382
- "authentication" : { }
383
- },
384
- "clan-group" : "helpCenter",
385
- "apihash" : "7f6107546089529525eec097b05cc5c6",
386
- "module-group" : "kb",
387
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getRootCategories"
388
- }
389
- },
390
- "post" : {
391
- "tags" : [ "KBRootCategory" ],
392
- "summary" : "Create root category",
393
- "description" : "This API creates a root category (i.e., parent category) in your knowledge base.",
394
- "operationId" : "addKBRootCategory",
395
- "parameters" : [ {
396
- "$ref" : "../common/Common.json#/components/parameters/orgId"
397
- } ],
398
- "requestBody" : {
399
- "$ref" : "#/components/requestBodies/createCategoryJson"
400
- },
401
- "responses" : {
402
- "422" : {
403
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
404
- },
405
- "200" : {
406
- "$ref" : "#/components/responses/rootCategoryResponse"
407
- }
408
- },
409
- "security" : [ {
410
- "org-oauth" : [ "accessAll.ALL" ]
411
- }, {
412
- "iam-oauth2-schema" : [ "Desk.articles.CREATE" ]
413
- } ],
414
- "x-audience" : [ "external-public" ],
415
- "x-custom-url-attribute" : {
416
- "security" : {
417
- "throttle" : {
418
- "policy" : "WriteAPI_Standard_UserPolicy"
419
- },
420
- "extraparams" : {
421
- "disable" : true,
422
- "ignore" : false
423
- },
424
- "authentication" : { }
425
- },
426
- "clan-group" : "helpCenter",
427
- "apihash" : "bd863d7ef0dec48325dfdfbbff61107d",
428
- "module-group" : "kb",
429
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addARootCategory"
430
- }
431
- }
432
- },
433
- "/api/v1/kbRootCategories/{rootCategoryId}/moveArticlesAndTrash" : {
434
- "post" : {
435
- "tags" : [ "KBRootCategory" ],
436
- "summary" : "Move articles and trash a root category",
437
- "description" : "This API moves all articles to another section and trashes this section in your helpdesk",
438
- "operationId" : "moveArticlesAndMoveRootCategoryToTrash",
439
- "parameters" : [ {
440
- "$ref" : "#/components/parameters/rootCategoryId"
441
- }, {
442
- "$ref" : "../common/Common.json#/components/parameters/orgId"
443
- } ],
444
- "requestBody" : {
445
- "$ref" : "#/components/requestBodies/moveArticlesAndTrashCategoryJson"
446
- },
447
- "responses" : {
448
- "422" : {
449
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
450
- },
451
- "200" : {
452
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
453
- }
454
- },
455
- "security" : [ {
456
- "org-oauth" : [ "accessAll.ALL" ]
457
- }, {
458
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
459
- } ],
460
- "x-audience" : [ "company-internal" ],
461
- "x-custom-url-attribute" : {
462
- "security" : {
463
- "throttle" : {
464
- "inline" : [ {
465
- "scope" : "APPSERVER",
466
- "rules" : [ {
467
- "duration" : 60000,
468
- "lock-period" : 600000,
469
- "threshold" : 25,
470
- "hip" : false
471
- }, {
472
- "duration" : 3600000,
473
- "lock-period" : 1800000,
474
- "threshold" : 200,
475
- "hip" : false
476
- } ],
477
- "window" : "ROLLING",
478
- "key" : "url.path+user.zuid"
479
- } ]
480
- },
481
- "extraparams" : {
482
- "disable" : true,
483
- "ignore" : false
484
- },
485
- "authentication" : { }
486
- },
487
- "clan-group" : "helpCenter",
488
- "apihash" : "563e081b2acb169a926f4a1ed17cc53b",
489
- "module-group" : "kb",
490
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.moveArticlesAndMoveRootCategoryToTrash"
491
- }
492
- }
493
- },
494
- "/api/v1/kbRootCategories/{rootCategoryId}/moderators/add" : {
495
- "post" : {
496
- "tags" : [ "KBRootCategory" ],
497
- "summary" : "Add moderators",
498
- "description" : "This API adds moderators to a root category in your helpdesk.<br/><br/>_Note_:<br/>Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam.",
499
- "operationId" : "addKBRootCategoryModerators",
500
- "parameters" : [ {
501
- "$ref" : "#/components/parameters/rootCategoryId"
502
- }, {
503
- "$ref" : "../common/Common.json#/components/parameters/orgId"
504
- } ],
505
- "requestBody" : {
506
- "$ref" : "#/components/requestBodies/addModeratorJson"
507
- },
508
- "responses" : {
509
- "422" : {
510
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
511
- },
512
- "200" : {
513
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
514
- }
515
- },
516
- "security" : [ {
517
- "org-oauth" : [ "accessAll.ALL" ]
518
- }, {
519
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
520
- } ],
521
- "x-audience" : [ "external-public" ],
522
- "x-custom-url-attribute" : {
523
- "security" : {
524
- "throttle" : {
525
- "policy" : "WriteAPI_Standard_UserPolicy"
526
- },
527
- "extraparams" : {
528
- "disable" : true,
529
- "ignore" : false
530
- },
531
- "authentication" : { }
532
- },
533
- "clan-group" : "helpCenter",
534
- "apihash" : "0e598027388a54cc2f0a368e8cc75478",
535
- "module-group" : "kb",
536
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addModerators"
537
- }
538
- }
539
- },
540
- "/api/v1/kbRootCategories/{rootCategoryId}/reviewOwners" : {
541
- "get" : {
542
- "tags" : [ "KBRootCategory" ],
543
- "summary" : "Get review owners",
544
- "description" : "This API fetches review owners of a root category in your helpdesk",
545
- "operationId" : "getKBRootCategoryReviewOwners",
546
- "parameters" : [ {
547
- "$ref" : "#/components/parameters/rootCategoryId"
548
- }, {
549
- "$ref" : "../common/Common.json#/components/parameters/orgId"
550
- } ],
551
- "responses" : {
552
- "422" : {
553
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
554
- },
555
- "200" : {
556
- "$ref" : "#/components/responses/reviewOwnersDataJson"
557
- }
558
- },
559
- "security" : [ {
560
- "org-oauth" : [ "accessAll.ALL" ]
561
- }, {
562
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
563
- } ],
564
- "x-audience" : [ "external-public" ],
565
- "x-custom-url-attribute" : {
566
- "security" : {
567
- "throttle" : {
568
- "inline" : [ {
569
- "scope" : "APPSERVER",
570
- "rules" : [ {
571
- "duration" : 60000,
572
- "lock-period" : 600000,
573
- "threshold" : 25,
574
- "hip" : false
575
- }, {
576
- "duration" : 3600000,
577
- "lock-period" : 1800000,
578
- "threshold" : 200,
579
- "hip" : false
580
- } ],
581
- "window" : "ROLLING",
582
- "key" : "url.path+user.zuid"
583
- } ]
584
- },
585
- "extraparams" : {
586
- "disable" : true,
587
- "ignore" : false
588
- },
589
- "authentication" : { }
590
- },
591
- "clan-group" : "helpCenter",
592
- "apihash" : "d10162f14ec3d28e7c2abbf2a1ac21a9",
593
- "module-group" : "kb",
594
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getReviewOwnersList"
595
- }
596
- }
597
- },
598
- "/api/v1/kbRootCategories/{rootCategoryId}/reviewOwners/add" : {
599
- "post" : {
600
- "tags" : [ "KBRootCategory" ],
601
- "summary" : "Add review owner",
602
- "description" : "This API adds review owners of a root category in your helpdesk",
603
- "operationId" : "addKBRootCategoryReviewOwners",
604
- "parameters" : [ {
605
- "$ref" : "#/components/parameters/rootCategoryId"
606
- }, {
607
- "$ref" : "../common/Common.json#/components/parameters/orgId"
608
- } ],
609
- "requestBody" : {
610
- "$ref" : "#/components/requestBodies/addReviewOwners_addReviewOwnerJson"
611
- },
612
- "responses" : {
613
- "422" : {
614
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
615
- },
616
- "200" : {
617
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
618
- }
619
- },
620
- "security" : [ {
621
- "org-oauth" : [ "accessAll.ALL" ]
622
- }, {
623
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
624
- } ],
625
- "x-audience" : [ "external-public" ],
626
- "x-custom-url-attribute" : {
627
- "security" : {
628
- "throttle" : {
629
- "inline" : [ {
630
- "scope" : "APPSERVER",
631
- "rules" : [ {
632
- "duration" : 60000,
633
- "lock-period" : 600000,
634
- "threshold" : 25,
635
- "hip" : false
636
- }, {
637
- "duration" : 3600000,
638
- "lock-period" : 1800000,
639
- "threshold" : 200,
640
- "hip" : false
641
- } ],
642
- "window" : "ROLLING",
643
- "key" : "url.path+user.zuid"
644
- } ]
645
- },
646
- "extraparams" : {
647
- "disable" : true,
648
- "ignore" : false
649
- },
650
- "authentication" : { }
651
- },
652
- "clan-group" : "helpCenter",
653
- "apihash" : "2be059945ce453b14f7834ad92ec2a13",
654
- "module-group" : "kb",
655
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addReviewOwners"
656
- }
657
- }
658
- },
659
- "/api/v1/kbRootCategories/{rootCategoryId}/translations/{locale}/permalinks/remove" : {
660
- "post" : {
661
- "tags" : [ "KBRootCategory" ],
662
- "summary" : "Remove a permalink of a root category",
663
- "description" : "This API removes a permalink of a root category translation",
664
- "operationId" : "deleteKBRootCategoryPermalink",
665
- "parameters" : [ {
666
- "$ref" : "#/components/parameters/locale"
667
- }, {
668
- "$ref" : "#/components/parameters/rootCategoryId"
669
- }, {
670
- "$ref" : "../common/Common.json#/components/parameters/orgId"
671
- } ],
672
- "requestBody" : {
673
- "$ref" : "#/components/requestBodies/removePermalink_removePermalinkJson"
674
- },
675
- "responses" : {
676
- "422" : {
677
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
678
- },
679
- "204" : {
680
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
681
- }
682
- },
683
- "security" : [ {
684
- "org-oauth" : [ "accessAll.ALL" ]
685
- }, {
686
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
687
- } ],
688
- "x-audience" : [ "external-public" ],
689
- "x-custom-url-attribute" : {
690
- "security" : {
691
- "throttle" : {
692
- "inline" : [ {
693
- "scope" : "APPSERVER",
694
- "rules" : [ {
695
- "duration" : 60000,
696
- "lock-period" : 600000,
697
- "threshold" : 25,
698
- "hip" : false
699
- }, {
700
- "duration" : 3600000,
701
- "lock-period" : 1800000,
702
- "threshold" : 200,
703
- "hip" : false
704
- } ],
705
- "window" : "ROLLING",
706
- "key" : "url.path+user.zuid"
707
- } ]
708
- },
709
- "extraparams" : {
710
- "disable" : true,
711
- "ignore" : false
712
- },
713
- "authentication" : { }
714
- },
715
- "clan-group" : "helpCenter",
716
- "apihash" : "b43177fa32639ab98d30e8b4af5d6390",
717
- "module-group" : "kb",
718
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.removePermalinksOfATranslationOfARootCategory"
719
- }
720
- }
721
- },
722
- "/api/v1/kbRootCategories/{rootCategoryId}/translations/{locale}/permalinks/add" : {
723
- "post" : {
724
- "tags" : [ "KBRootCategory" ],
725
- "summary" : "Add a permalink to a root catgeory",
726
- "description" : "This API adds a permalink to a root category translation",
727
- "operationId" : "addKBRootCategoryPermalink",
728
- "parameters" : [ {
729
- "$ref" : "#/components/parameters/locale"
730
- }, {
731
- "$ref" : "#/components/parameters/rootCategoryId"
732
- }, {
733
- "$ref" : "../common/Common.json#/components/parameters/orgId"
734
- } ],
735
- "requestBody" : {
736
- "$ref" : "#/components/requestBodies/addPermalink_addPermalinkJson"
737
- },
738
- "responses" : {
739
- "422" : {
740
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
741
- },
742
- "200" : {
743
- "$ref" : "./KBCategoryPermalink.json#/components/responses/permalinkJsonDataArrayWithOldResponse"
744
- }
745
- },
746
- "security" : [ {
747
- "org-oauth" : [ "accessAll.ALL" ]
748
- }, {
749
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
750
- } ],
751
- "x-audience" : [ "external-public" ],
752
- "x-custom-url-attribute" : {
753
- "security" : {
754
- "throttle" : {
755
- "inline" : [ {
756
- "scope" : "APPSERVER",
757
- "rules" : [ {
758
- "duration" : 60000,
759
- "lock-period" : 600000,
760
- "threshold" : 25,
761
- "hip" : false
762
- }, {
763
- "duration" : 3600000,
764
- "lock-period" : 1800000,
765
- "threshold" : 200,
766
- "hip" : false
767
- } ],
768
- "window" : "ROLLING",
769
- "key" : "url.path+user.zuid"
770
- } ]
771
- },
772
- "extraparams" : {
773
- "disable" : true,
774
- "ignore" : false
775
- },
776
- "authentication" : { }
777
- },
778
- "clan-group" : "helpCenter",
779
- "apihash" : "04136a7590387dd86b3562635ea16d97",
780
- "module-group" : "kb",
781
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.addPermalinksOfATranslationOfARootCategory"
782
- }
783
- }
784
- },
785
- "/api/v1/kbRootCategories/{rootCategoryId}/categoryTree" : {
786
- "get" : {
787
- "tags" : [ "KBRootCategory" ],
788
- "summary" : "Get a category tree",
789
- "description" : "This API fetches the full tree of a root category in your helpdesk",
790
- "operationId" : "getKBRootCategoryTree",
791
- "parameters" : [ {
792
- "name" : "include",
793
- "in" : "query",
794
- "description" : "Include params are publicArticlesCount, allArticlesCount, publishedArticleCount, publishedArticleTemplateCount and portalUrl",
795
- "required" : false,
796
- "style" : "simple",
797
- "explode" : true,
798
- "schema" : {
799
- "type" : [ "null", "array" ],
800
- "description" : "Include params are publicArticlesCount, allArticlesCount, publishedArticleCount, publishedArticleTemplateCount and portalUrl",
801
- "items" : {
802
- "type" : [ "string", "null" ],
803
- "enum" : [ "publishedArticleTemplateCount", "followersCount","publishedArticleCount", "portalUrl", "allArticlesCount", "publicArticlesCount" ],
804
- "maxLength" : 100,
805
- "minLength" : 0,
806
- "x-custom-parameters-attributes" : [ ]
807
- },
808
- "uniqueItems" : true
809
- }
810
- }, {
811
- "$ref" : "#/components/parameters/rootCategoryId"
812
- }, {
813
- "$ref" : "../common/Common.json#/components/parameters/orgId"
814
- } ],
815
- "responses" : {
816
- "422" : {
817
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
818
- },
819
- "200" : {
820
- "$ref" : "#/components/responses/rootCategoryTreeResponse"
821
- }
822
- },
823
- "security" : [ {
824
- "org-oauth" : [ "accessAll.ALL" ]
825
- }, {
826
- "iam-oauth2-schema" : [ "Desk.articles.READ" ]
827
- } ],
828
- "x-audience" : [ "external-public" ],
829
- "x-custom-url-attribute" : {
830
- "security" : {
831
- "throttle" : {
832
- "policy" : "ReadAPI_Standard_UserPolicy"
833
- },
834
- "extraparams" : {
835
- "disable" : true,
836
- "ignore" : false
837
- },
838
- "authentication" : { }
839
- },
840
- "clan-group" : "helpCenter",
841
- "apihash" : "80e649dd1a5f82d0caccf30f763ef95f",
842
- "module-group" : "kb",
843
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.getATree"
844
- }
845
- }
846
- },
847
- "/api/v1/kbRootCategories/{rootCategoryId}/moderators/remove" : {
848
- "post" : {
849
- "tags" : [ "KBRootCategory" ],
850
- "summary" : "Remove moderators",
851
- "description" : "This API removes moderators from a root category in your helpdesk.<br/><br/>_Note_:<br/>Moderators act as designated agents within the primary department with access to the Moderation Panel. They are responsible for reviewing and managing comments awaiting approval or flagged as spam.",
852
- "operationId" : "deleteKBRootCategoryModerators",
853
- "parameters" : [ {
854
- "$ref" : "#/components/parameters/rootCategoryId"
855
- }, {
856
- "$ref" : "../common/Common.json#/components/parameters/orgId"
857
- } ],
858
- "requestBody" : {
859
- "$ref" : "#/components/requestBodies/removeModerators_addModeratorJson"
860
- },
861
- "responses" : {
862
- "422" : {
863
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
864
- },
865
- "200" : {
866
- "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
867
- }
868
- },
869
- "security" : [ {
870
- "org-oauth" : [ "accessAll.ALL" ]
871
- }, {
872
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
873
- } ],
874
- "x-audience" : [ "external-public" ],
875
- "x-custom-url-attribute" : {
876
- "security" : {
877
- "throttle" : {
878
- "policy" : "WriteAPI_Standard_UserPolicy"
879
- },
880
- "extraparams" : {
881
- "disable" : true,
882
- "ignore" : false
883
- },
884
- "authentication" : { }
885
- },
886
- "clan-group" : "helpCenter",
887
- "apihash" : "ee2e2312a216a8c4cdce4496cb52fc27",
888
- "module-group" : "kb",
889
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.removeModerators"
890
- }
891
- }
892
- },
893
- "/api/v1/kbRootCategories/reorder" : {
894
- "post" : {
895
- "tags" : [ "KBRootCategory" ],
896
- "summary" : "Reorder root categories",
897
- "description" : "This API reorders root categories",
898
- "operationId" : "reorderRootCategories",
899
- "parameters" : [ {
900
- "$ref" : "../common/Common.json#/components/parameters/orgId"
901
- } ],
902
- "requestBody" : {
903
- "$ref" : "#/components/requestBodies/reorderRootCategories_reorderRootCategoryJson"
904
- },
905
- "responses" : {
906
- "422" : {
907
- "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
908
- },
909
- "204" : {
910
- "$ref" : "../common/Common.json#/components/responses/emptyResponse"
911
- }
912
- },
913
- "security" : [ {
914
- "org-oauth" : [ "accessAll.ALL" ]
915
- }, {
916
- "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ]
917
- } ],
918
- "x-audience" : [ "company-internal" ],
919
- "x-custom-url-attribute" : {
920
- "security" : {
921
- "throttle" : {
922
- "inline" : [ {
923
- "scope" : "APPSERVER",
924
- "rules" : [ {
925
- "duration" : 60000,
926
- "lock-period" : 600000,
927
- "threshold" : 25,
928
- "hip" : false
929
- }, {
930
- "duration" : 3600000,
931
- "lock-period" : 1800000,
932
- "threshold" : 200,
933
- "hip" : false
934
- } ],
935
- "window" : "ROLLING",
936
- "key" : "url.path+user.zuid"
937
- } ]
938
- },
939
- "extraparams" : {
940
- "disable" : true,
941
- "ignore" : false
942
- },
943
- "authentication" : { }
944
- },
945
- "clan-group" : "helpCenter",
946
- "apihash" : "c47f05415bc8f0e03fc25d7b9f9f5b87",
947
- "module-group" : "kb",
948
- "apimethod" : "com.zoho.desk.helpcenter.kbcategory.rest.KbCategoryService.reorderRootCategories"
949
- }
950
- }
951
- }
952
- },
953
- "components" : {
954
- "schemas" : {
955
- "countData": {
956
- "type": [
957
- "string",
958
- "null",
959
- "integer"
960
- ],
961
- "format": "int32",
962
- "pattern": "([0-9]+)"
963
- },
964
- "urlData" : {
965
- "type" : [ "string", "null" ],
966
- "maxLength" : 255,
967
- "minLength" : 0,
968
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
969
- },
970
- "categoryUsers" : {
971
- "type" : [ "null", "object" ],
972
- "additionalProperties" : false,
973
- "properties" : {
974
- "photoURL" : {
975
- "type" : [ "string", "null" ],
976
- "maxLength" : 200,
977
- "minLength" : 0,
978
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
979
- },
980
- "isReviewOwner" : {
981
- "type" : [ "boolean", "null" ],
982
- "x-custom-parameters-attributes" : {
983
- "removeExif" : false,
984
- "filterMatchedContent" : false,
985
- "antivirus" : false,
986
- "replacementString" : "",
987
- "allowInvalid" : false,
988
- "descrption" : "Checks whether the user is a review owner. If the value is: <br> <ul><li> \"<b>true</b>\" - it returns a list of users who are reviewers. </li> <li> \"<b>false</b>\" - it returns a list of users who are non-reviewers. </li></ul> <br> <p><b>Note:</b> If this param is not provided, all users associated with a specific root category will be listed.</p>",
989
- "secret" : false,
990
- "preserveCharsLimit" : 10,
991
- "trim" : false,
992
- "internalParam" : false,
993
- "preserveChars" : "0,5",
994
- "importUrl" : false,
995
- "decrypt" : false
996
- }
997
- },
998
- "name" : {
999
- "type" : [ "string", "null" ],
1000
- "maxLength" : 100,
1001
- "minLength" : 0
1002
- },
1003
- "emailId" : {
1004
- "type" : [ "string", "null" ],
1005
- "maxLength" : 100,
1006
- "minLength" : 0,
1007
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1008
- },
1009
- "id" : {
1010
- "type" : [ "string", "null", "integer" ],
1011
- "format" : "int64",
1012
- "pattern" : "([0-9]+)"
1013
- },
1014
- "status" : {
1015
- "type" : [ "string", "null" ],
1016
- "maxLength" : 200,
1017
- "minLength" : 0,
1018
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1019
- "x-custom-parameters-attributes" : {
1020
- "removeExif" : false,
1021
- "filterMatchedContent" : false,
1022
- "antivirus" : false,
1023
- "replacementString" : "",
1024
- "allowInvalid" : false,
1025
- "descrption" : "Key that filters agents based on their activation status: @ACTIVE@ or @DISABLED@",
1026
- "secret" : false,
1027
- "preserveCharsLimit" : 10,
1028
- "trim" : false,
1029
- "internalParam" : false,
1030
- "preserveChars" : "0,5",
1031
- "importUrl" : false,
1032
- "decrypt" : false
1033
- }
1034
- }
1035
- },
1036
- "required" : [ "emailId", "id", "isReviewOwner", "name", "photoURL", "status" ]
1037
- },
1038
- "categoryUsersWithModerator" : {
1039
- "additionalProperties" : false,
1040
- "allOf" : [ {
1041
- "$ref" : "#/components/schemas/categoryUsers"
1042
- }, {
1043
- "type" : [ "null", "object" ],
1044
- "properties" : {
1045
- "isModerator" : {
1046
- "type" : [ "boolean", "null" ],
1047
- "x-custom-parameters-attributes" : {
1048
- "removeExif" : false,
1049
- "filterMatchedContent" : false,
1050
- "antivirus" : false,
1051
- "replacementString" : "",
1052
- "allowInvalid" : false,
1053
- "descrption" : "Checks whether the user is a moderator. If the value is: <br> <ul><li> \"<b>true</b>\" - it returns a list of users who are moderators. </li> <li> \"<b>false</b>\" - it returns a list of users who are non-moderators. </li></ul> <br> <p><b>Note:</b> If this param is not provided, all users associated with a specific root category will be listed.</p>",
1054
- "secret" : false,
1055
- "preserveCharsLimit" : 10,
1056
- "trim" : false,
1057
- "internalParam" : false,
1058
- "preserveChars" : "0,5",
1059
- "importUrl" : false,
1060
- "decrypt" : false
1061
- }
1062
- }
1063
- },
1064
- "required" : [ "isModerator" ]
1065
- } ]
1066
- },
1067
- "categoryUsersArray" : {
1068
- "type" : [ "null", "array" ],
1069
- "items" : {
1070
- "$ref" : "#/components/schemas/categoryUsersWithModerator"
1071
- }
1072
- },
1073
- "rootTranslationResponseJsonArr" : {
1074
- "type" : [ "null", "array" ],
1075
- "items" : {
1076
- "$ref" : "./KBRootCategoryTranslation.json#/components/schemas/rootTranslationResponse"
1077
- }
1078
- },
1079
- "addReviewOwnerArray" : {
1080
- "type" : [ "null", "array" ],
1081
- "items" : {
1082
- "type" : [ "string", "null", "integer" ],
1083
- "format" : "int64",
1084
- "pattern" : "([0-9]+)"
1085
- }
1086
- },
1087
- "assigneeObj" : {
1088
- "type" : [ "null", "object" ],
1089
- "additionalProperties" : false,
1090
- "properties" : {
1091
- "photoURL" : {
1092
- "type" : [ "string", "null" ],
1093
- "maxLength" : 100,
1094
- "minLength" : 0,
1095
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1096
- },
1097
- "name" : {
1098
- "type" : [ "string", "null" ],
1099
- "maxLength" : 50,
1100
- "minLength" : 0
1101
- },
1102
- "id" : {
1103
- "type" : [ "string", "null", "integer" ],
1104
- "format" : "int64",
1105
- "pattern" : "([0-9]+)"
1106
- },
1107
- "status" : {
1108
- "type" : [ "string", "null" ],
1109
- "enum" : [ "ACTIVE", "DISABLED", "LICENSE_DOWNGRADED", "DELETED", "ANONYMIZED", "CLOSED" ],
1110
- "maxLength" : 100,
1111
- "minLength" : 0
1112
- },
1113
- "zuid" : {
1114
- "type" : [ "string", "null", "integer" ],
1115
- "format" : "int32",
1116
- "pattern" : "([0-9]+)"
1117
- }
1118
- },
1119
- "required" : [ "id", "name", "photoURL", "status", "zuid" ]
1120
- },
1121
- "feedbackPreferenceResponseObj" : {
1122
- "type" : [ "null", "object" ],
1123
- "additionalProperties" : false,
1124
- "properties" : {
1125
- "departmentId" : {
1126
- "type" : [ "string", "null", "integer" ],
1127
- "format" : "int64",
1128
- "pattern" : "([0-9]+)"
1129
- },
1130
- "assignee" : {
1131
- "$ref" : "#/components/schemas/assigneeObj"
1132
- },
1133
- "status" : {
1134
- "type" : [ "string", "null" ],
1135
- "enum" : [ "ENABLED", "DISABLED" ],
1136
- "maxLength" : 100,
1137
- "minLength" : 0
1138
- }
1139
- },
1140
- "required" : [ "assignee", "departmentId", "status" ]
1141
- },
1142
- "commonCategoryResponse" : {
1143
- "type" : [ "null", "object" ],
1144
- "additionalProperties" : false,
1145
- "properties" : {
1146
- "modifiedTime" : {
1147
- "type" : [ "string", "null" ],
1148
- "maxLength" : 100,
1149
- "minLength" : 0,
1150
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1151
- },
1152
- "description" : {
1153
- "type" : [ "string", "null" ],
1154
- "maxLength" : 100,
1155
- "minLength" : 0,
1156
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1157
- },
1158
- "helpcenterId" : {
1159
- "type" : [ "string", "null", "integer" ],
1160
- "format" : "int64",
1161
- "pattern" : "([0-9]+)"
1162
- },
1163
- "isReviewEnabled" : {
1164
- "type" : [ "boolean", "null" ]
1165
- },
1166
- "isTrashed" : {
1167
- "type" : [ "boolean", "null" ]
1168
- },
1169
- "translations" : {
1170
- "$ref" : "#/components/schemas/rootTranslationResponseJsonArr"
1171
- },
1172
- "moderationType" : {
1173
- "type" : [ "string", "null" ],
1174
- "enum" : [ "FIRST_ACTION", "ALL_ACTION", "NONE" ],
1175
- "maxLength" : 100,
1176
- "minLength" : 0
1177
- },
1178
- "createdTime" : {
1179
- "type" : [ "string", "null" ],
1180
- "maxLength" : 100,
1181
- "minLength" : 0,
1182
- "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
1183
- },
1184
- "modifiedBy" : {
1185
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1186
- },
1187
- "id" : {
1188
- "type" : [ "string", "null", "integer" ],
1189
- "format" : "int64",
1190
- "pattern" : "([0-9]+)"
1191
- },
1192
- "primaryDepartmentId" : {
1193
- "type" : [ "string", "null", "integer" ],
1194
- "format" : "int64",
1195
- "pattern" : "([0-9]+)"
1196
- },
1197
- "order" : {
1198
- "type" : [ "string", "null", "integer" ],
1199
- "format" : "int32",
1200
- "pattern" : "([0-9]+)"
1201
- },
1202
- "workspaceId" : {
1203
- "type" : [ "string", "null" ],
1204
- "maxLength" : 100,
1205
- "minLength" : 0,
1206
- "pattern" : "^([a-zA-Z0-9]{37}|-1)$"
1207
- },
1208
- "isFollowing" : {
1209
- "type" : [ "boolean", "null" ]
1210
- },
1211
- "articleViewType" : {
1212
- "type" : [ "string", "null" ],
1213
- "enum" : [ "LISTVIEW", "OVERVIEW" ],
1214
- "maxLength" : 100,
1215
- "minLength" : 0
1216
- },
1217
- "visibility" : {
1218
- "type" : [ "string", "null" ],
1219
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1220
- "maxLength" : 100,
1221
- "minLength" : 0
1222
- },
1223
- "canCurrentUserModerate" : {
1224
- "type" : [ "boolean", "null" ]
1225
- },
1226
- "groups" : {
1227
- "$ref" : "./KbCategory.json#/components/schemas/groupJsonArr"
1228
- },
1229
- "logoUrl" : {
1230
- "type" : [ "string", "null" ],
1231
- "maxLength" : 255,
1232
- "minLength" : 0,
1233
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1234
- },
1235
- "feedbackTicketConversionPreference" : {
1236
- "$ref" : "#/components/schemas/feedbackPreferenceResponseObj"
1237
- },
1238
- "associatedDepartmentIds" : {
1239
- "type" : [ "null", "array" ],
1240
- "items" : {
1241
- "type" : [ "string", "null", "integer" ],
1242
- "format" : "int64",
1243
- "pattern" : "([0-9]+)"
1244
- },
1245
- "uniqueItems" : true
1246
- },
1247
- "encryptedWorkspaceId" : {
1248
- "type" : [ "string", "null" ],
1249
- "maxLength" : 255,
1250
- "minLength" : 0
1251
- },
1252
- "createdBy" : {
1253
- "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy"
1254
- },
1255
- "name" : {
1256
- "type" : [ "string", "null" ],
1257
- "maxLength" : 100,
1258
- "minLength" : 0
1259
- },
1260
- "status" : {
1261
- "type" : [ "string", "null" ],
1262
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER", "DISABLED", "ENABLED" ],
1263
- "maxLength" : 100,
1264
- "minLength" : 0
1265
- },
1266
- "publicArticlesCount" : {
1267
- "type" : [ "string", "null", "integer" ],
1268
- "format" : "int32",
1269
- "pattern" : "([0-9]+)"
1270
- },
1271
- "allArticlesCount" : {
1272
- "type" : [ "string", "null", "integer" ],
1273
- "format" : "int32",
1274
- "pattern" : "([0-9]+)"
1275
- },
1276
- "allArticleTemplateCount" : {
1277
- "type" : [ "string", "null", "integer" ],
1278
- "format" : "int32",
1279
- "pattern" : "([0-9]+)"
1280
- },
1281
- "followersCount": {
1282
- "$ref" : "#/components/schemas/countData"
1283
- },
1284
- "portalUrl": {
1285
- "$ref": "#/components/schemas/urlData"
1286
- },
1287
- "canCurrentUserReview": {
1288
- "type": [
1289
- "boolean",
1290
- "null"
1291
- ]
1292
- },
1293
- "sectionsCount" : {
1294
- "type" : [ "string", "null", "integer" ],
1295
- "format" : "int32",
1296
- "pattern" : "([0-9]+)"
1297
- },
1298
- "publishedArticleCount" : {
1299
- "type" : [ "string", "null", "integer" ],
1300
- "format" : "int32",
1301
- "pattern" : "([0-9]+)"
1302
- }
1303
- },
1304
- "required" : [ "articleViewType", "associatedDepartmentIds", "canCurrentUserModerate", "createdBy", "createdTime", "description", "encryptedWorkspaceId", "feedbackTicketConversionPreference", "groups", "helpcenterId", "id", "isFollowing", "isReviewEnabled", "isTrashed", "logoUrl", "moderationType", "modifiedBy", "modifiedTime", "name", "order", "primaryDepartmentId", "status", "translations", "visibility", "workspaceId" ]
1305
- },
1306
- "addRootTranslationJsonArray" : {
1307
- "type" : [ "null", "array" ],
1308
- "items" : {
1309
- "$ref" : "./KBRootCategoryTranslation.json#/components/schemas/addRootTranslationJson"
1310
- }
1311
- },
1312
- "feedbackPreferenceObj" : {
1313
- "type" : [ "null", "object" ],
1314
- "additionalProperties" : false,
1315
- "properties" : {
1316
- "departmentId" : {
1317
- "type" : [ "string", "null", "integer" ],
1318
- "format" : "int64",
1319
- "description" : "ID of the department in which the tickets must be created",
1320
- "pattern" : "([0-9]+)"
1321
- },
1322
- "assigneeId" : {
1323
- "type" : [ "string", "null", "integer" ],
1324
- "format" : "int64",
1325
- "description" : "ID of the user to whom the tickets must be assigned. If you do not pass a value for this key, the ticket remains unassigned.",
1326
- "pattern" : "([0-9]+)"
1327
- },
1328
- "status" : {
1329
- "type" : [ "string", "null" ],
1330
- "description" : "Activation status of auto-conversion for the category. Values allowed are: ENABLED and DISABLED",
1331
- "enum" : [ "ENABLED", "DISABLED" ],
1332
- "maxLength" : 100,
1333
- "minLength" : 0
1334
- }
1335
- },
1336
- "required" : [ "assigneeId", "departmentId", "status" ]
1337
- },
1338
- "data" : {
1339
- "type" : [ "null", "array" ],
1340
- "items" : {
1341
- "$ref" : "#/components/schemas/commonCategoryResponse"
1342
- }
1343
- },
1344
- "reviewOwners" : {
1345
- "type" : [ "null", "object" ],
1346
- "additionalProperties" : false,
1347
- "properties" : {
1348
- "photoURL" : {
1349
- "type" : [ "string", "null" ],
1350
- "maxLength" : 200,
1351
- "minLength" : 0,
1352
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1353
- },
1354
- "name" : {
1355
- "type" : [ "string", "null" ],
1356
- "maxLength" : 100,
1357
- "minLength" : 0
1358
- },
1359
- "emailId" : {
1360
- "type" : [ "string", "null" ],
1361
- "maxLength" : 100,
1362
- "minLength" : 0,
1363
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1364
- },
1365
- "id" : {
1366
- "type" : [ "string", "null", "integer" ],
1367
- "format" : "int64",
1368
- "pattern" : "([0-9]+)"
1369
- }
1370
- },
1371
- "required" : [ "emailId", "id", "name", "photoURL" ]
1372
- },
1373
- "reviewOwnersArray" : {
1374
- "type" : [ "null", "array" ],
1375
- "items" : {
1376
- "$ref" : "#/components/schemas/reviewOwners"
1377
- }
1378
- },
1379
- "rootTreeTranslationResponse" : {
1380
- "type" : [ "null", "object" ],
1381
- "additionalProperties" : false,
1382
- "properties" : {
1383
- "name" : {
1384
- "type" : [ "string", "null" ],
1385
- "maxLength" : 100,
1386
- "minLength" : 0
1387
- },
1388
- "description" : {
1389
- "type" : [ "string", "null" ],
1390
- "maxLength" : 100,
1391
- "minLength" : 0,
1392
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1393
- },
1394
- "id" : {
1395
- "type" : [ "string", "null", "integer" ],
1396
- "format" : "int64",
1397
- "pattern" : "([0-9]+)"
1398
- },
1399
- "permalink" : {
1400
- "type" : [ "string", "null" ],
1401
- "maxLength" : 100,
1402
- "minLength" : 0,
1403
- "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1404
- },
1405
- "locale" : {
1406
- "type" : [ "string", "null" ],
1407
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1408
- "maxLength" : 100,
1409
- "minLength" : 0,
1410
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1411
- "x-custom-parameters-attributes" : {
1412
- "removeExif" : false,
1413
- "filterMatchedContent" : false,
1414
- "antivirus" : false,
1415
- "replacementString" : "",
1416
- "allowInvalid" : false,
1417
- "descrption" : "Locale of the translated name",
1418
- "secret" : false,
1419
- "preserveCharsLimit" : 10,
1420
- "trim" : false,
1421
- "internalParam" : false,
1422
- "preserveChars" : "0,5",
1423
- "importUrl" : false,
1424
- "decrypt" : false
1425
- }
1426
- },
1427
- "portalUrl": {
1428
- "$ref": "#/components/schemas/urlData"
1429
- }
1430
- },
1431
- "required" : [ "description", "id", "locale", "name", "permalink" ]
1432
- },
1433
- "rootTreeTranslationResponseJsonArr" : {
1434
- "type" : [ "null", "array" ],
1435
- "items" : {
1436
- "$ref" : "#/components/schemas/rootTreeTranslationResponse"
1437
- }
1438
- },
1439
- "childTranslationResponse" : {
1440
- "additionalProperties" : false,
1441
- "allOf" : [ {
1442
- "$ref" : "#/components/schemas/rootTreeTranslationResponse"
1443
- }, {
1444
- "type" : [ "null", "object" ],
1445
- "properties" : {
1446
- "description" : {
1447
- "type" : [ "string", "null" ],
1448
- "maxLength" : 100,
1449
- "minLength" : 0,
1450
- "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*"
1451
- }
1452
- },
1453
- "required" : [ "description" ]
1454
- } ]
1455
- },
1456
- "childTranslationResponseJsonArr" : {
1457
- "type" : [ "null", "array" ],
1458
- "items" : {
1459
- "$ref" : "#/components/schemas/childTranslationResponse"
1460
- }
1461
- },
1462
- "childTreeResponse" : {
1463
- "type" : [ "null", "object" ],
1464
- "additionalProperties" : false,
1465
- "properties" : {
1466
- "publishedArticleTemplateCount" : {
1467
- "type" : [ "string", "null", "integer" ],
1468
- "format" : "int32",
1469
- "pattern" : "([0-9]+)"
1470
- },
1471
- "followersCount" : {
1472
- "$ref" : "#/components/schemas/countData"
1473
- },
1474
- "publishedArticleCount": {
1475
- "$ref" : "#/components/schemas/countData"
1476
- },
1477
- "publicArticlesCount": {
1478
- "$ref" : "#/components/schemas/countData"
1479
- },
1480
- "portalUrl": {
1481
- "$ref": "#/components/schemas/urlData"
1482
- },
1483
- "allArticlesCount": {
1484
- "$ref" : "#/components/schemas/countData"
1485
- },
1486
- "isFollowing" : {
1487
- "type" : [ "boolean", "null" ]
1488
- },
1489
- "visibility" : {
1490
- "type" : [ "string", "null" ],
1491
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1492
- "maxLength" : 100,
1493
- "minLength" : 0
1494
- },
1495
- "level" : {
1496
- "type" : [ "string", "null", "integer" ],
1497
- "format" : "int32",
1498
- "pattern" : "([0-9]+)"
1499
- },
1500
- "description" : {
1501
- "type" : [ "string", "null" ],
1502
- "maxLength" : 100,
1503
- "minLength" : 0,
1504
- "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]*"
1505
- },
1506
- "locale" : {
1507
- "type" : [ "string", "null" ],
1508
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1509
- "maxLength" : 100,
1510
- "minLength" : 0,
1511
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1512
- "x-custom-parameters-attributes" : {
1513
- "removeExif" : false,
1514
- "filterMatchedContent" : false,
1515
- "antivirus" : false,
1516
- "replacementString" : "",
1517
- "allowInvalid" : false,
1518
- "descrption" : "Locale of the translated name",
1519
- "secret" : false,
1520
- "preserveCharsLimit" : 10,
1521
- "trim" : false,
1522
- "internalParam" : false,
1523
- "preserveChars" : "0,5",
1524
- "importUrl" : false,
1525
- "decrypt" : false
1526
- }
1527
- },
1528
- "logoUrl" : {
1529
- "type" : [ "string", "null" ],
1530
- "maxLength" : 255,
1531
- "minLength" : 0,
1532
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1533
- },
1534
- "rootCategoryId" : {
1535
- "type" : [ "string", "null", "integer" ],
1536
- "format" : "int64",
1537
- "pattern" : "([0-9]+)"
1538
- },
1539
- "isTrashed" : {
1540
- "type" : [ "boolean", "null" ]
1541
- },
1542
- "children" : {
1543
- "$recursiveRef" : "#"
1544
- },
1545
- "translations" : {
1546
- "$ref" : "#/components/schemas/childTranslationResponseJsonArr"
1547
- },
1548
- "name" : {
1549
- "type" : [ "string", "null" ],
1550
- "maxLength" : 100,
1551
- "minLength" : 0
1552
- },
1553
- "parentCategoryId" : {
1554
- "type" : [ "string", "null", "integer" ],
1555
- "format" : "int64",
1556
- "pattern" : "([0-9]+)"
1557
- },
1558
- "id" : {
1559
- "type" : [ "string", "null", "integer" ],
1560
- "format" : "int64",
1561
- "pattern" : "([0-9]+)"
1562
- },
1563
- "status" : {
1564
- "type" : [ "string", "null" ],
1565
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
1566
- "maxLength" : 100,
1567
- "minLength" : 0
1568
- },
1569
- "order" : {
1570
- "type" : [ "string", "null", "integer" ],
1571
- "format" : "int32",
1572
- "pattern" : "([0-9]+)"
1573
- }
1574
- },
1575
- "required" : [ "children", "description", "id", "isFollowing", "isTrashed", "level", "locale", "logoUrl", "name", "order", "parentCategoryId", "rootCategoryId", "status", "translations", "visibility" ]
1576
- },
1577
- "childArrayOfTree" : {
1578
- "type" : [ "null", "array" ],
1579
- "items" : {
1580
- "$ref" : "#/components/schemas/childTreeResponse"
1581
- }
1582
- }
1583
- },
1584
- "responses" : {
1585
- "categoryUsersDataJson" : {
1586
- "description" : "categoryUsersDataJson template definitions",
1587
- "content" : {
1588
- "application/json" : {
1589
- "schema" : {
1590
- "type" : [ "null", "object" ],
1591
- "additionalProperties" : false,
1592
- "properties" : {
1593
- "data" : {
1594
- "$ref" : "#/components/schemas/categoryUsersArray"
1595
- }
1596
- },
1597
- "required" : [ "data" ]
1598
- },
1599
- "examples" : {
1600
- "Valid responses Definitions" : {
1601
- "value" : {
1602
- "data" : [ {
1603
- "photoURL" : null,
1604
- "isReviewOwner" : true,
1605
- "isModerator" : false,
1606
- "name" : "Zylker",
1607
- "emailId" : "carol@zylker.com",
1608
- "id" : "5000000015867",
1609
- "status" : "ACTIVE"
1610
- } ]
1611
- }
1612
- }
1613
- }
1614
- }
1615
- },
1616
- "x-custom-response-attributes" : {
1617
- "disable-safe-headers" : "[]"
1618
- }
1619
- },
1620
- "categoryUsers" : {
1621
- "description" : "categoryUsers template definitions",
1622
- "content" : {
1623
- "application/json" : {
1624
- "schema" : {
1625
- "type" : [ "null", "object" ],
1626
- "additionalProperties" : false,
1627
- "properties" : {
1628
- "photoURL" : {
1629
- "type" : [ "string", "null" ],
1630
- "maxLength" : 200,
1631
- "minLength" : 0,
1632
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1633
- },
1634
- "isReviewOwner" : {
1635
- "type" : [ "boolean", "null" ]
1636
- },
1637
- "name" : {
1638
- "type" : [ "string", "null" ],
1639
- "maxLength" : 100,
1640
- "minLength" : 0
1641
- },
1642
- "emailId" : {
1643
- "type" : [ "string", "null" ],
1644
- "maxLength" : 100,
1645
- "minLength" : 0,
1646
- "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1647
- },
1648
- "id" : {
1649
- "type" : [ "string", "null", "integer" ],
1650
- "format" : "int64",
1651
- "pattern" : "([0-9]+)"
1652
- },
1653
- "status" : {
1654
- "type" : [ "string", "null" ],
1655
- "maxLength" : 200,
1656
- "minLength" : 0,
1657
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1658
- }
1659
- },
1660
- "required" : [ "emailId", "id", "isReviewOwner", "name", "photoURL", "status" ]
1661
- },
1662
- "examples" : {
1663
- "Valid responses Definitions" : {
1664
- "value" : null
1665
- }
1666
- }
1667
- }
1668
- },
1669
- "x-custom-response-attributes" : {
1670
- "disable-safe-headers" : "[]"
1671
- }
1672
- },
1673
- "rootCategoryResponse" : {
1674
- "description" : "rootCategoryResponse template definitions",
1675
- "content" : {
1676
- "application/json" : {
1677
- "schema" : {
1678
- "additionalProperties" : false,
1679
- "allOf" : [ {
1680
- "$ref" : "#/components/schemas/commonCategoryResponse"
1681
- }, {
1682
- "type" : [ "null", "object" ],
1683
- "properties" : {
1684
- "ipAddresses" : {
1685
- "type" : [ "null", "array" ],
1686
- "items" : {
1687
- "type" : [ "string", "null" ],
1688
- "maxLength" : 100,
1689
- "minLength" : 0,
1690
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(/(?:[012]?[0-9]|3[012]))?)|\\*)$",
1691
- "x-custom-parameters-attributes" : [ ]
1692
- },
1693
- "uniqueItems" : false
1694
- }
1695
- },
1696
- "required" : [ "ipAddresses" ]
1697
- } ]
1698
- },
1699
- "examples" : {
1700
- "Valid responses Definitions" : {
1701
- "value" : {
1702
- "modifiedTime" : 1577978811000,
1703
- "helpcenterId" : "5000000015871",
1704
- "isReviewEnabled" : true,
1705
- "isTrashed" : false,
1706
- "translations" : [ {
1707
- "modifiedTime" : 1577978682000,
1708
- "createdBy" : {
1709
- "photoURL" : null,
1710
- "name" : "Zylker",
1711
- "id" : "5000000015867",
1712
- "status" : "ACTIVE",
1713
- "zuid" : "343224"
1714
- },
1715
- "name" : "Root category name",
1716
- "description" : "description of root",
1717
- "createdTime" : 1577978682000,
1718
- "modifiedBy" : {
1719
- "photoURL" : null,
1720
- "name" : "Zylker",
1721
- "id" : "5000000015867",
1722
- "status" : "ACTIVE",
1723
- "zuid" : "343224"
1724
- },
1725
- "id" : "5000000336004",
1726
- "permalink" : "root-category-name",
1727
- "locale" : "en",
1728
- "categoryId" : "5000000319037"
1729
- } ],
1730
- "moderationType" : "ALL_ACTION",
1731
- "createdTime" : 1577707830000,
1732
- "modifiedBy" : {
1733
- "photoURL" : null,
1734
- "name" : "Zylker",
1735
- "id" : "5000000015867",
1736
- "status" : "ACTIVE",
1737
- "zuid" : "343224"
1738
- },
1739
- "primaryDepartmentId" : "5000000063894",
1740
- "id" : "5000000319037",
1741
- "order" : "3",
1742
- "workspaceId" : "asadasda",
1743
- "isFollowing" : true,
1744
- "visibility" : "ALL_USERS",
1745
- "articleViewType" : "LISTVIEW",
1746
- "canCurrentUserModerate" : true,
1747
- "groups" : [ ],
1748
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
1749
- "feedbackTicketConversionPreference" : {
1750
- "departmentId" : "5000000063895",
1751
- "assignee" : {
1752
- "photoURL" : "https://desk.zoho.com/api/v1/agents/5000000000059/photo?orgId=15114553",
1753
- "name" : "Charlie Marlie",
1754
- "id" : "5000000000059",
1755
- "status" : "ACTIVE",
1756
- "zuid" : "15224545"
1757
- },
1758
- "status" : "ENABLED"
1759
- },
1760
- "associatedDepartmentIds" : [ "5000000063895" ],
1761
- "encryptedWorkspaceId" : "uhahsdhada",
1762
- "createdBy" : {
1763
- "photoURL" : null,
1764
- "name" : "Zylker",
1765
- "id" : "5000000015867",
1766
- "status" : "ACTIVE",
1767
- "zuid" : "343224"
1768
- },
1769
- "name" : "Root category name",
1770
- "ipAddresses" : [ ],
1771
- "status" : "SHOW_IN_HELPCENTER"
1772
- }
1773
- }
1774
- }
1775
- }
1776
- },
1777
- "x-custom-response-attributes" : {
1778
- "disable-safe-headers" : "[]"
1779
- }
1780
- },
1781
- "listAllCategoryResponse" : {
1782
- "description" : "listAllCategoryResponse template definitions",
1783
- "content" : {
1784
- "application/json" : {
1785
- "schema" : {
1786
- "type" : [ "null", "object" ],
1787
- "additionalProperties" : false,
1788
- "properties" : {
1789
- "data" : {
1790
- "$ref" : "#/components/schemas/data"
1791
- }
1792
- },
1793
- "required" : [ "data" ]
1794
- },
1795
- "examples" : {
1796
- "Valid responses Definitions" : {
1797
- "value" : {
1798
- "data" : [ {
1799
- "modifiedTime" : 1578230287000,
1800
- "allArticlesCount" : "11",
1801
- "helpcenterId" : "5000000015871",
1802
- "isReviewEnabled" : false,
1803
- "isTrashed" : false,
1804
- "translations" : [ {
1805
- "modifiedTime" : 1570688319000,
1806
- "createdBy" : {
1807
- "photoURL" : null,
1808
- "name" : "Zylker",
1809
- "id" : "5000000015867",
1810
- "status" : "ACTIVE",
1811
- "zuid" : "343224"
1812
- },
1813
- "name" : "Zoho Desk",
1814
- "description" : "A helpdesk software",
1815
- "createdTime" : 1561359819000,
1816
- "modifiedBy" : {
1817
- "photoURL" : null,
1818
- "name" : "Zylker",
1819
- "id" : "5000000015867",
1820
- "status" : "ACTIVE",
1821
- "zuid" : "343224"
1822
- },
1823
- "id" : "5000000265103",
1824
- "permalink" : "zoho-desk",
1825
- "locale" : "en",
1826
- "categoryId" : "5000000066427"
1827
- } ],
1828
- "moderationType" : "ALL_ACTION",
1829
- "createdTime" : 1561359819000,
1830
- "modifiedBy" : {
1831
- "photoURL" : null,
1832
- "name" : "Zylker",
1833
- "id" : "5000000015867",
1834
- "status" : "ACTIVE",
1835
- "zuid" : "343224"
1836
- },
1837
- "primaryDepartmentId" : "5000000063894",
1838
- "id" : "5000000066427",
1839
- "order" : "1",
1840
- "workspaceId" : "ponaz00368c36c9274809bf96849b392f8d67",
1841
- "visibility" : "ALL_USERS",
1842
- "articleViewType" : "LISTVIEW",
1843
- "canCurrentUserModerate" : true,
1844
- "groups" : [ ],
1845
- "sectionsCount" : "7",
1846
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
1847
- "feedbackTicketConversionPreference" : {
1848
- "departmentId" : "5000000063895",
1849
- "assignee" : {
1850
- "photoURL" : "https://desk.zoho.com/api/v1/agents/5000000000059/photo?orgId=15114553",
1851
- "name" : "Charlie Marlie",
1852
- "id" : "5000000000059",
1853
- "status" : "ACTIVE",
1854
- "zuid" : "15224545"
1855
- },
1856
- "status" : "ENABLED"
1857
- },
1858
- "associatedDepartmentIds" : [ "5000000063895" ],
1859
- "publicArticlesCount" : "3",
1860
- "allArticleTemplateCount" : "4",
1861
- "encryptedWorkspaceId" : "04bd200bc14c4cac0c0026a0342c1f21263012407fa56109a37788e786a96ec0383c1eeb08849f9be78a6f7b8b8f31033dde60d41ad95443c6570636db1a9b20",
1862
- "createdBy" : {
1863
- "photoURL" : null,
1864
- "name" : "Zylker",
1865
- "id" : "5000000015867",
1866
- "status" : "ACTIVE",
1867
- "zuid" : "343224"
1868
- },
1869
- "name" : "Zoho Desk",
1870
- "status" : "SHOW_IN_HELPCENTER"
1871
- } ]
1872
- }
1873
- }
1874
- }
1875
- }
1876
- },
1877
- "x-custom-response-attributes" : {
1878
- "disable-safe-headers" : "[]"
1879
- }
1880
- },
1881
- "reviewOwnersDataJson" : {
1882
- "description" : "reviewOwnersDataJson template definitions",
1883
- "content" : {
1884
- "application/json" : {
1885
- "schema" : {
1886
- "type" : [ "null", "object" ],
1887
- "additionalProperties" : false,
1888
- "properties" : {
1889
- "data" : {
1890
- "$ref" : "#/components/schemas/reviewOwnersArray"
1891
- }
1892
- },
1893
- "required" : [ "data" ]
1894
- },
1895
- "examples" : {
1896
- "Valid responses Definitions" : {
1897
- "value" : {
1898
- "data" : [ {
1899
- "photoURL" : null,
1900
- "name" : "Zylker",
1901
- "id" : "5000000015867"
1902
- } ]
1903
- }
1904
- }
1905
- }
1906
- }
1907
- },
1908
- "x-custom-response-attributes" : {
1909
- "disable-safe-headers" : "[]"
1910
- }
1911
- },
1912
- "rootCategoryTreeResponse" : {
1913
- "description" : "rootCategoryTreeResponse template definitions",
1914
- "content" : {
1915
- "application/json" : {
1916
- "schema" : {
1917
- "type" : [ "null", "object" ],
1918
- "additionalProperties" : false,
1919
- "properties" : {
1920
- "isFollowing" : {
1921
- "type" : [ "boolean", "null" ]
1922
- },
1923
- "visibility" : {
1924
- "type" : [ "string", "null" ],
1925
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
1926
- "maxLength" : 100,
1927
- "minLength" : 0
1928
- },
1929
- "canCurrentUserModerate" : {
1930
- "type" : [ "boolean", "null" ]
1931
- },
1932
- "level" : {
1933
- "type" : [ "string", "null", "integer" ],
1934
- "format" : "int32",
1935
- "pattern" : "([0-9]+)"
1936
- },
1937
- "description" : {
1938
- "type" : [ "string", "null" ],
1939
- "maxLength" : 100,
1940
- "minLength" : 0,
1941
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1942
- },
1943
- "locale" : {
1944
- "type" : [ "string", "null" ],
1945
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1946
- "maxLength" : 100,
1947
- "minLength" : 0,
1948
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1949
- "x-custom-parameters-attributes" : {
1950
- "removeExif" : false,
1951
- "filterMatchedContent" : false,
1952
- "antivirus" : false,
1953
- "replacementString" : "",
1954
- "allowInvalid" : false,
1955
- "descrption" : "Locale of the translated name",
1956
- "secret" : false,
1957
- "preserveCharsLimit" : 10,
1958
- "trim" : false,
1959
- "internalParam" : false,
1960
- "preserveChars" : "0,5",
1961
- "importUrl" : false,
1962
- "decrypt" : false
1963
- }
1964
- },
1965
- "logoUrl" : {
1966
- "type" : [ "string", "null" ],
1967
- "maxLength" : 255,
1968
- "minLength" : 0,
1969
- "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1970
- },
1971
- "rootCategoryId" : {
1972
- "type" : [ "string", "null", "integer" ],
1973
- "format" : "int64",
1974
- "pattern" : "([0-9]+)"
1975
- },
1976
- "isTrashed" : {
1977
- "type" : [ "boolean", "null" ]
1978
- },
1979
- "children" : {
1980
- "$ref" : "#/components/schemas/childArrayOfTree"
1981
- },
1982
- "translations" : {
1983
- "$ref" : "#/components/schemas/rootTreeTranslationResponseJsonArr"
1984
- },
1985
- "moderationType" : {
1986
- "type" : [ "string", "null" ],
1987
- "enum" : [ "FIRST_ACTION", "ALL_ACTION", "NONE" ],
1988
- "maxLength" : 100,
1989
- "minLength" : 0
1990
- },
1991
- "name" : {
1992
- "type" : [ "string", "null" ],
1993
- "maxLength" : 100,
1994
- "minLength" : 0
1995
- },
1996
- "parentCategoryId" : {
1997
- "type" : [ "string", "null", "integer" ],
1998
- "format" : "int64",
1999
- "pattern" : "([0-9]+)"
2000
- },
2001
- "id" : {
2002
- "type" : [ "string", "null", "integer" ],
2003
- "format" : "int64",
2004
- "pattern" : "([0-9]+)"
2005
- },
2006
- "status" : {
2007
- "type" : [ "string", "null" ],
2008
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
2009
- "maxLength" : 100,
2010
- "minLength" : 0
2011
- },
2012
- "order" : {
2013
- "type" : [ "string", "null", "integer" ],
2014
- "format" : "int32",
2015
- "pattern" : "([0-9]+)"
2016
- },
2017
- "publishedArticleTemplateCount" : {
2018
- "type" : [ "string", "null", "integer" ],
2019
- "format" : "int32",
2020
- "pattern" : "([0-9]+)"
2021
- },
2022
- "followersCount" : {
2023
- "$ref" : "#/components/schemas/countData"
2024
- },
2025
- "publishedArticleCount": {
2026
- "$ref" : "#/components/schemas/countData"
2027
- },
2028
- "publicArticlesCount": {
2029
- "$ref" : "#/components/schemas/countData"
2030
- },
2031
- "portalUrl": {
2032
- "$ref": "#/components/schemas/urlData"
2033
- },
2034
- "allArticlesCount": {
2035
- "$ref" : "#/components/schemas/countData"
2036
- }
2037
- },
2038
- "required" : [ "canCurrentUserModerate", "children", "description", "id", "isFollowing", "isTrashed", "level", "locale", "logoUrl", "moderationType", "name", "order", "parentCategoryId", "rootCategoryId", "status", "translations", "visibility" ]
2039
- },
2040
- "examples" : {
2041
- "Valid responses Definitions" : {
2042
- "value" : {
2043
- "isFollowing" : true,
2044
- "canCurrentUserModerate" : true,
2045
- "visibility" : "ALL_USERS",
2046
- "allArticlesCount" : "0",
2047
- "description" : "test",
2048
- "locale" : "en",
2049
- "publishedArticleCount" : "23",
2050
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
2051
- "publicArticlesCount" : "0",
2052
- "followersCount": "3",
2053
- "isTrashed" : false,
2054
- "children" : [ {
2055
- "isFollowing" : true,
2056
- "visibility" : "ALL_USERS",
2057
- "allArticlesCount" : "0",
2058
- "description" : "Desk",
2059
- "locale" : "en",
2060
- "publishedArticleCount" : "23",
2061
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
2062
- "rootCategoryId" : "5000000066427",
2063
- "publicArticlesCount" : "0",
2064
- "followersCount": "3",
2065
- "isTrashed" : false,
2066
- "children" : [ {
2067
- "isFollowing" : true,
2068
- "visibility" : "ALL_USERS",
2069
- "allArticlesCount" : "0",
2070
- "description" : "Section 2",
2071
- "locale" : "en",
2072
- "publishedArticleCount" : "23",
2073
- "logoUrl" : "https://desk.zoho.com/support/App/build/fonts/certificate.svg",
2074
- "rootCategoryId" : "5000000066427",
2075
- "publicArticlesCount" : "0",
2076
- "followersCount": "3",
2077
- "isTrashed" : false,
2078
- "children" : [ ],
2079
- "translations" : [ {
2080
- "name" : "section 2 en",
2081
- "description" : null,
2082
- "id" : "5000000341003",
2083
- "permalink" : "section-2-en",
2084
- "locale" : "en"
2085
- } ],
2086
- "name" : "Section 2",
2087
- "parentCategoryId" : "5000000340014",
2088
- "id" : "5000000341001",
2089
- "status" : "SHOW_IN_HELPCENTER",
2090
- "order" : "1"
2091
- } ],
2092
- "translations" : [ {
2093
- "name" : "For Agents",
2094
- "description" : null,
2095
- "id" : "5000000340016",
2096
- "permalink" : "for-agents",
2097
- "locale" : "en"
2098
- } ],
2099
- "name" : "Desk",
2100
- "parentCategoryId" : "5000000066427",
2101
- "id" : "5000000340014",
2102
- "status" : "SHOW_IN_HELPCENTER",
2103
- "order" : "5"
2104
- } ],
2105
- "moderationType" : "ALL_ACTION",
2106
- "translations" : [ {
2107
- "name" : "Desk",
2108
- "description" : "Helpdesk-software",
2109
- "id" : "5000000265103",
2110
- "permalink" : "desk",
2111
- "locale" : "en"
2112
- } ],
2113
- "name" : "test",
2114
- "id" : "5000000066427",
2115
- "status" : "SHOW_IN_HELPCENTER",
2116
- "order" : "1"
2117
- }
2118
- }
2119
- }
2120
- }
2121
- },
2122
- "x-custom-response-attributes" : {
2123
- "disable-safe-headers" : "[]"
2124
- }
2125
- }
2126
- },
2127
- "parameters" : {
2128
- "locale" : {
2129
- "name" : "locale",
2130
- "in" : "path",
2131
- "required" : true,
2132
- "style" : "simple",
2133
- "explode" : false,
2134
- "schema" : {
2135
- "type" : [ "string", "null" ],
2136
- "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2137
- "maxLength" : 100,
2138
- "minLength" : 0,
2139
- "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2140
- }
2141
- },
2142
- "rootCategoryId" : {
2143
- "name" : "rootCategoryId",
2144
- "in" : "path",
2145
- "required" : true,
2146
- "style" : "simple",
2147
- "explode" : false,
2148
- "schema" : {
2149
- "type" : [ "string", "null", "integer" ],
2150
- "format" : "int64",
2151
- "pattern" : "([0-9]+)"
2152
- }
2153
- }
2154
- },
2155
- "requestBodies" : {
2156
- "reorderRootCategoryJson" : {
2157
- "content" : {
2158
- "application/json" : {
2159
- "schema" : {
2160
- "type" : [ "null", "object" ],
2161
- "additionalProperties" : false,
2162
- "properties" : {
2163
- "orderedCategoryIds" : {
2164
- "type" : [ "null", "array" ],
2165
- "items" : {
2166
- "type" : [ "string", "null", "integer" ],
2167
- "format" : "int64",
2168
- "pattern" : "([0-9]+)",
2169
- "x-custom-parameters-attributes" : [ { } ]
2170
- },
2171
- "uniqueItems" : true
2172
- }
2173
- },
2174
- "required" : [ "orderedCategoryIds" ]
2175
- },
2176
- "examples" : {
2177
- "Valid requestBody Definitions" : {
2178
- "value" : {
2179
- "parentCategoryId" : "6000000048313",
2180
- "categoryPositions" : [ {
2181
- "position" : "1",
2182
- "categoryId" : "6000000067084"
2183
- } ]
2184
- }
2185
- }
2186
- }
2187
- }
2188
- },
2189
- "x-custom-request-body-attributes" : {
2190
- "non-empty" : false,
2191
- "allow-invalid" : false
2192
- }
2193
- },
2194
- "removePermalinkJson" : {
2195
- "content" : {
2196
- "application/json" : {
2197
- "schema" : {
2198
- "type" : [ "null", "object" ],
2199
- "additionalProperties" : false,
2200
- "properties" : {
2201
- "permalink" : {
2202
- "type" : [ "string", "null" ],
2203
- "description" : "The permalink of Solution",
2204
- "maxLength" : 100,
2205
- "minLength" : 0,
2206
- "pattern" : "[a-zA-Z0-9%\\-_\\P{InBasicLatin}]+"
2207
- }
2208
- },
2209
- "required" : [ "permalink" ]
2210
- },
2211
- "examples" : {
2212
- "Valid requestBody Definitions" : {
2213
- "value" : {
2214
- "permalink" : "permalink-2"
2215
- }
2216
- }
2217
- }
2218
- }
2219
- },
2220
- "x-custom-request-body-attributes" : {
2221
- "non-empty" : false,
2222
- "allow-invalid" : false
2223
- }
2224
- },
2225
- "addPermalinkJson" : {
2226
- "content" : {
2227
- "application/json" : {
2228
- "schema" : {
2229
- "type" : [ "null", "object" ],
2230
- "additionalProperties" : false,
2231
- "properties" : {
2232
- "isOldPermalinkNeeded" : {
2233
- "type" : [ "boolean", "null" ],
2234
- "description" : "The variable that defines if permalink needs to be added to redirect list. By default, it is true"
2235
- },
2236
- "permalink" : {
2237
- "type" : [ "string", "null" ],
2238
- "description" : "The permalink of Solution",
2239
- "maxLength" : 100,
2240
- "minLength" : 0,
2241
- "pattern" : "[A-Za-z0-9%\\-+\\/=\\P{InBasicLatin}]+"
2242
- }
2243
- },
2244
- "required" : [ "isOldPermalinkNeeded", "permalink" ]
2245
- },
2246
- "examples" : {
2247
- "Valid requestBody Definitions" : {
2248
- "value" : {
2249
- "isOldPermalinkNeeded" : true,
2250
- "permalink" : "new-permalink"
2251
- }
2252
- }
2253
- }
2254
- }
2255
- },
2256
- "x-custom-request-body-attributes" : {
2257
- "non-empty" : false,
2258
- "allow-invalid" : false
2259
- }
2260
- },
2261
- "addReviewOwnerJson" : {
2262
- "content" : {
2263
- "application/json" : {
2264
- "schema" : {
2265
- "type" : [ "null", "object" ],
2266
- "additionalProperties" : false,
2267
- "properties" : {
2268
- "reviewOwnerIds" : {
2269
- "$ref" : "#/components/schemas/addReviewOwnerArray"
2270
- }
2271
- },
2272
- "required" : [ "reviewOwnerIds" ]
2273
- },
2274
- "examples" : {
2275
- "Valid requestBody Definitions" : {
2276
- "value" : {
2277
- "reviewOwnerIds" : [ "5000000015867" ]
2278
- }
2279
- }
2280
- }
2281
- }
2282
- },
2283
- "x-custom-request-body-attributes" : {
2284
- "non-empty" : false,
2285
- "allow-invalid" : false
2286
- }
2287
- },
2288
- "createCategoryJson" : {
2289
- "content" : {
2290
- "application/json" : {
2291
- "schema" : {
2292
- "type" : [ "null", "object" ],
2293
- "additionalProperties" : false,
2294
- "properties" : {
2295
- "articleViewType" : {
2296
- "type" : [ "string", "null" ],
2297
- "description" : "View to apply while listing help articles. Values allowed are: LISTVIEW and OVERVIEW.",
2298
- "enum" : [ "LISTVIEW", "OVERVIEW" ],
2299
- "maxLength" : 100,
2300
- "minLength" : 0
2301
- },
2302
- "visibility" : {
2303
- "type" : [ "string", "null" ],
2304
- "description" : "Visibility setting of the category. Values allowed are: AGENTS, GROUP_USERS, ALL_USERS, NONE, and PRIVATE_IP.",
2305
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
2306
- "maxLength" : 100,
2307
- "minLength" : 0
2308
- },
2309
- "description" : {
2310
- "type" : [ "string", "null" ],
2311
- "description" : "A brief description of the category",
2312
- "maxLength" : 100,
2313
- "minLength" : 0,
2314
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2315
- },
2316
- "feedbackTicketConversionPreference" : {
2317
- "$ref" : "#/components/schemas/feedbackPreferenceObj"
2318
- },
2319
- "associatedDepartmentIds" : {
2320
- "type" : [ "null", "array" ],
2321
- "items" : {
2322
- "type" : [ "string", "null", "integer" ],
2323
- "format" : "int64",
2324
- "pattern" : "([0-9]+)",
2325
- "x-custom-parameters-attributes" : [ { } ]
2326
- },
2327
- "uniqueItems" : true
2328
- },
2329
- "isReviewEnabled" : {
2330
- "type" : [ "boolean", "null" ],
2331
- "description" : "Key that specifies whether the category must be reviewed or not"
2332
- },
2333
- "translations" : {
2334
- "$ref" : "#/components/schemas/addRootTranslationJsonArray"
2335
- },
2336
- "moderationType" : {
2337
- "type" : [ "string", "null" ],
2338
- "description" : "Type of moderation applied to the category. Values allowed are: @NONE@, @ALL_ACTION@, @FIRST_ACTION@",
2339
- "enum" : [ "FIRST_ACTION", "ALL_ACTION", "NONE" ],
2340
- "maxLength" : 100,
2341
- "minLength" : 0
2342
- },
2343
- "groupIds" : {
2344
- "type" : [ "null", "array" ],
2345
- "items" : {
2346
- "type" : [ "string", "null", "integer" ],
2347
- "format" : "int64",
2348
- "pattern" : "([0-9]+)",
2349
- "x-custom-parameters-attributes" : [ { } ]
2350
- },
2351
- "uniqueItems" : false
2352
- },
2353
- "name" : {
2354
- "type" : [ "string", "null" ],
2355
- "description" : "Name of the category",
2356
- "maxLength" : 100,
2357
- "minLength" : 0
2358
- },
2359
- "ipAddresses" : {
2360
- "type" : [ "null", "array" ],
2361
- "items" : {
2362
- "type" : [ "string", "null" ],
2363
- "maxLength" : 100,
2364
- "minLength" : 0,
2365
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(/(?:[012]?[0-9]|3[012]))?)|\\*)$",
2366
- "x-custom-parameters-attributes" : [ ]
2367
- },
2368
- "uniqueItems" : false
2369
- },
2370
- "primaryDepartmentId" : {
2371
- "type" : [ "string", "null", "integer" ],
2372
- "format" : "int64",
2373
- "description" : "ID of the department to which the category belongs",
2374
- "pattern" : "([0-9]+)"
2375
- },
2376
- "logoId" : {
2377
- "type" : [ "string", "null", "integer" ],
2378
- "format" : "int64",
2379
- "description" : "ID of the logo to set for the category",
2380
- "pattern" : "([0-9]+)"
2381
- },
2382
- "status" : {
2383
- "type" : [ "string", "null" ],
2384
- "description" : "Activation status of the category",
2385
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
2386
- "maxLength" : 100,
2387
- "minLength" : 0
2388
- }
2389
- },
2390
- "required" : [ "articleViewType", "description", "groupIds", "ipAddresses", "isReviewEnabled", "logoId", "name", "primaryDepartmentId", "status", "translations", "visibility" ]
2391
- },
2392
- "examples" : {
2393
- "Valid requestBody Definitions" : {
2394
- "value" : {
2395
- "isReviewEnabled" : false,
2396
- "articleViewType" : "LISTVIEW",
2397
- "visibility" : "ALL_USERS",
2398
- "moderationType" : "ALL_ACTION",
2399
- "translations" : [ {
2400
- "name" : "Zoho Desk",
2401
- "description" : "A helpdesk software",
2402
- "permalink" : "zoho-desk",
2403
- "locale" : "en"
2404
- } ],
2405
- "name" : "Zoho Desk",
2406
- "primaryDepartmentId" : "5000000063894",
2407
- "logoId" : "25",
2408
- "feedbackTicketConversionPreference" : {
2409
- "departmentId" : "5000000063895",
2410
- "assigneeId" : "5000000000059",
2411
- "status" : "ENABLED"
2412
- },
2413
- "status" : "SHOW_IN_HELPCENTER",
2414
- "associatedDepartmentIds" : [ "5000000063895" ]
2415
- }
2416
- }
2417
- }
2418
- }
2419
- },
2420
- "x-custom-request-body-attributes" : {
2421
- "non-empty" : false,
2422
- "allow-invalid" : false
2423
- }
2424
- },
2425
- "moveArticlesAndTrashCategoryJson" : {
2426
- "content" : {
2427
- "application/json" : {
2428
- "schema" : {
2429
- "type" : [ "null", "object" ],
2430
- "additionalProperties" : false,
2431
- "properties" : {
2432
- "articlePermission" : {
2433
- "type" : [ "string", "null" ],
2434
- "description" : "To update the article permission based on category visibility",
2435
- "enum" : [ "ALL_USERS", "REGISTERED_USERS", "AGENTS_ONLY", "ALL", "REGISTEREDUSERS", "AGENTS" ],
2436
- "maxLength" : 100,
2437
- "minLength" : 0
2438
- },
2439
- "targetCategoryId" : {
2440
- "type" : [ "string", "null", "integer" ],
2441
- "format" : "int64",
2442
- "description" : "Category Id to which articles need to be moved",
2443
- "pattern" : "([0-9]+)"
2444
- }
2445
- },
2446
- "required" : [ "targetCategoryId" ]
2447
- },
2448
- "examples" : {
2449
- "Valid requestBody Definitions" : {
2450
- "value" : {
2451
- "targetCategoryId" : "5000000326009"
2452
- }
2453
- }
2454
- }
2455
- }
2456
- },
2457
- "x-custom-request-body-attributes" : {
2458
- "non-empty" : false,
2459
- "allow-invalid" : false
2460
- }
2461
- },
2462
- "addModeratorJson" : {
2463
- "content" : {
2464
- "application/json" : {
2465
- "schema" : {
2466
- "type" : [ "null", "object" ],
2467
- "additionalProperties" : false,
2468
- "properties" : {
2469
- "moderatorIds" : {
2470
- "$ref" : "#/components/schemas/addReviewOwnerArray"
2471
- }
2472
- },
2473
- "required" : [ "moderatorIds" ]
2474
- },
2475
- "examples" : {
2476
- "Valid requestBody Definitions" : {
2477
- "value" : {
2478
- "moderatorIds" : [ "5000000015867" ]
2479
- }
2480
- }
2481
- }
2482
- }
2483
- },
2484
- "x-custom-request-body-attributes" : {
2485
- "non-empty" : false,
2486
- "allow-invalid" : false
2487
- }
2488
- },
2489
- "permalinkUpdateJson" : {
2490
- "content" : {
2491
- "application/json" : {
2492
- "schema" : {
2493
- "type" : [ "null", "object" ],
2494
- "additionalProperties" : false,
2495
- "properties" : {
2496
- "primaryPermalink" : {
2497
- "type" : [ "string", "null" ],
2498
- "description" : "Primary permalink of a translation",
2499
- "maxLength" : 100,
2500
- "minLength" : 0,
2501
- "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2502
- },
2503
- "secondaryPermalinks" : {
2504
- "type" : [ "null", "array" ],
2505
- "items" : {
2506
- "type" : [ "string", "null" ],
2507
- "maxLength" : 100,
2508
- "minLength" : 0,
2509
- "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+",
2510
- "x-custom-parameters-attributes" : [ ]
2511
- },
2512
- "uniqueItems" : false
2513
- }
2514
- },
2515
- "required" : [ "primaryPermalink", "secondaryPermalinks" ]
2516
- },
2517
- "examples" : {
2518
- "Valid requestBody Definitions" : {
2519
- "value" : {
2520
- "primaryPermalink" : "primary-analyser",
2521
- "secondaryPermalinks" : [ "quality-analyst", "modulizer" ]
2522
- }
2523
- }
2524
- }
2525
- }
2526
- },
2527
- "x-custom-request-body-attributes" : {
2528
- "non-empty" : false,
2529
- "allow-invalid" : false
2530
- }
2531
- },
2532
- "addReviewOwners_addReviewOwnerJson" : {
2533
- "content" : {
2534
- "application/json" : {
2535
- "schema" : {
2536
- "type" : [ "null", "object" ],
2537
- "additionalProperties" : false,
2538
- "properties" : {
2539
- "reviewOwnerIds" : {
2540
- "$ref" : "#/components/schemas/addReviewOwnerArray"
2541
- }
2542
- },
2543
- "required" : [ "reviewOwnerIds" ]
2544
- },
2545
- "examples" : {
2546
- "Valid requestBody Definitions" : {
2547
- "value" : {
2548
- "reviewOwnerIds" : [ "5000000015867" ]
2549
- }
2550
- }
2551
- }
2552
- }
2553
- },
2554
- "x-custom-request-body-attributes" : {
2555
- "non-empty" : false,
2556
- "allow-invalid" : false
2557
- }
2558
- },
2559
- "removePermalink_removePermalinkJson" : {
2560
- "content" : {
2561
- "application/json" : {
2562
- "schema" : {
2563
- "type" : [ "null", "object" ],
2564
- "additionalProperties" : false,
2565
- "properties" : {
2566
- "permalink" : {
2567
- "type" : [ "string", "null" ],
2568
- "description" : "The permalink of Solution",
2569
- "maxLength" : 100,
2570
- "minLength" : 0,
2571
- "pattern" : "[a-zA-Z0-9%\\-_\\P{InBasicLatin}]+"
2572
- }
2573
- },
2574
- "required" : [ "permalink" ]
2575
- },
2576
- "examples" : {
2577
- "Valid requestBody Definitions" : {
2578
- "value" : {
2579
- "permalink" : "permalink-2"
2580
- }
2581
- }
2582
- }
2583
- }
2584
- },
2585
- "x-custom-request-body-attributes" : {
2586
- "non-empty" : false,
2587
- "allow-invalid" : false
2588
- }
2589
- },
2590
- "addPermalink_addPermalinkJson" : {
2591
- "content" : {
2592
- "application/json" : {
2593
- "schema" : {
2594
- "type" : [ "null", "object" ],
2595
- "additionalProperties" : false,
2596
- "properties" : {
2597
- "isOldPermalinkNeeded" : {
2598
- "type" : [ "boolean", "null" ],
2599
- "description" : "The variable that defines if permalink needs to be added to redirect list. By default, it is true"
2600
- },
2601
- "permalink" : {
2602
- "type" : [ "string", "null" ],
2603
- "description" : "The permalink of Solution",
2604
- "maxLength" : 100,
2605
- "minLength" : 0,
2606
- "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2607
- }
2608
- },
2609
- "required" : ["permalink" ]
2610
- },
2611
- "examples" : {
2612
- "Valid requestBody Definitions" : {
2613
- "value" : {
2614
- "isOldPermalinkNeeded" : true,
2615
- "permalink" : "new-permalink"
2616
- }
2617
- }
2618
- }
2619
- }
2620
- },
2621
- "x-custom-request-body-attributes" : {
2622
- "non-empty" : false,
2623
- "allow-invalid" : false
2624
- }
2625
- },
2626
- "removeModerators_addModeratorJson" : {
2627
- "content" : {
2628
- "application/json" : {
2629
- "schema" : {
2630
- "type" : [ "null", "object" ],
2631
- "additionalProperties" : false,
2632
- "properties" : {
2633
- "moderatorIds" : {
2634
- "$ref" : "#/components/schemas/addReviewOwnerArray"
2635
- }
2636
- },
2637
- "required" : [ "moderatorIds" ]
2638
- },
2639
- "examples" : {
2640
- "Valid requestBody Definitions" : {
2641
- "value" : {
2642
- "moderatorIds" : [ "5000000015867" ]
2643
- }
2644
- }
2645
- }
2646
- }
2647
- },
2648
- "x-custom-request-body-attributes" : {
2649
- "non-empty" : false,
2650
- "allow-invalid" : false
2651
- }
2652
- },
2653
- "reorderRootCategories_reorderRootCategoryJson" : {
2654
- "content" : {
2655
- "application/json" : {
2656
- "schema" : {
2657
- "type" : [ "null", "object" ],
2658
- "additionalProperties" : false,
2659
- "properties" : {
2660
- "orderedCategoryIds" : {
2661
- "type" : [ "null", "array" ],
2662
- "items" : {
2663
- "type" : [ "string", "null", "integer" ],
2664
- "format" : "int64",
2665
- "pattern" : "([0-9]+)",
2666
- "x-custom-parameters-attributes" : [ { } ]
2667
- },
2668
- "uniqueItems" : true
2669
- }
2670
- },
2671
- "required" : [ "orderedCategoryIds" ]
2672
- },
2673
- "examples" : {
2674
- "Valid requestBody Definitions" : {
2675
- "value" : {
2676
- "categoryPositions" : [ {
2677
- "position" : "1",
2678
- "categoryId" : "6000000067084"
2679
- } ]
2680
- }
2681
- }
2682
- }
2683
- }
2684
- },
2685
- "x-custom-request-body-attributes" : {
2686
- "non-empty" : false,
2687
- "allow-invalid" : false
2688
- }
2689
- },
2690
- "updateRootCategory_createCategoryJson" : {
2691
- "content" : {
2692
- "application/json" : {
2693
- "schema" : {
2694
- "type" : [ "null", "object" ],
2695
- "additionalProperties" : false,
2696
- "properties" : {
2697
- "articleViewType" : {
2698
- "type" : [ "string", "null" ],
2699
- "description" : "View to apply while listing help articles. Values allowed are: LISTVIEW and OVERVIEW.",
2700
- "enum" : [ "LISTVIEW", "OVERVIEW" ],
2701
- "maxLength" : 100,
2702
- "minLength" : 0
2703
- },
2704
- "visibility" : {
2705
- "type" : [ "string", "null" ],
2706
- "description" : "Visibility setting of the category. Values allowed are: AGENTS, GROUP_USERS, ALL_USERS, NONE, and PRIVATE_IP.",
2707
- "enum" : [ "ALL_USERS", "AGENTS", "GROUP_USERS", "PRIVATE_IP", "NONE" ],
2708
- "maxLength" : 100,
2709
- "minLength" : 0
2710
- },
2711
- "description" : {
2712
- "type" : [ "string", "null" ],
2713
- "description" : "A brief description of the category",
2714
- "maxLength" : 100,
2715
- "minLength" : 0,
2716
- "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2717
- },
2718
- "feedbackTicketConversionPreference" : {
2719
- "$ref" : "#/components/schemas/feedbackPreferenceObj"
2720
- },
2721
- "associatedDepartmentIds" : {
2722
- "type" : [ "null", "array" ],
2723
- "items" : {
2724
- "type" : [ "string", "null", "integer" ],
2725
- "format" : "int64",
2726
- "pattern" : "([0-9]+)",
2727
- "x-custom-parameters-attributes" : [ { } ]
2728
- },
2729
- "uniqueItems" : true
2730
- },
2731
- "isReviewEnabled" : {
2732
- "type" : [ "boolean", "null" ],
2733
- "description" : "Key that specifies whether the category must be reviewed or not"
2734
- },
2735
- "translations" : {
2736
- "$ref" : "#/components/schemas/addRootTranslationJsonArray"
2737
- },
2738
- "moderationType" : {
2739
- "type" : [ "string", "null" ],
2740
- "description" : "Type of moderation applied to the category. Values allowed are: @NONE@, @ALL_ACTION@, @FIRST_ACTION@",
2741
- "enum" : [ "FIRST_ACTION", "ALL_ACTION", "NONE" ],
2742
- "maxLength" : 100,
2743
- "minLength" : 0
2744
- },
2745
- "groupIds" : {
2746
- "type" : [ "null", "array" ],
2747
- "items" : {
2748
- "type" : [ "string", "null", "integer" ],
2749
- "format" : "int64",
2750
- "pattern" : "([0-9]+)",
2751
- "x-custom-parameters-attributes" : [ { } ]
2752
- },
2753
- "uniqueItems" : false
2754
- },
2755
- "name" : {
2756
- "type" : [ "string", "null" ],
2757
- "description" : "Name of the category",
2758
- "maxLength" : 100,
2759
- "minLength" : 0
2760
- },
2761
- "ipAddresses" : {
2762
- "type" : [ "null", "array" ],
2763
- "items" : {
2764
- "type" : [ "string", "null" ],
2765
- "maxLength" : 100,
2766
- "minLength" : 0,
2767
- "pattern" : "^((?:(?:(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)\\.){3}(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|\\*)(/(?:[012]?[0-9]|3[012]))?)|\\*)$",
2768
- "x-custom-parameters-attributes" : [ ]
2769
- },
2770
- "uniqueItems" : false
2771
- },
2772
- "primaryDepartmentId" : {
2773
- "type" : [ "string", "null", "integer" ],
2774
- "format" : "int64",
2775
- "description" : "ID of the department to which the category belongs",
2776
- "pattern" : "([0-9]+)"
2777
- },
2778
- "logoId" : {
2779
- "type" : [ "string", "null", "integer" ],
2780
- "format" : "int64",
2781
- "description" : "ID of the logo to set for the category",
2782
- "pattern" : "([0-9]+)"
2783
- },
2784
- "status" : {
2785
- "type" : [ "string", "null" ],
2786
- "description" : "Activation status of the category",
2787
- "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER" ],
2788
- "maxLength" : 100,
2789
- "minLength" : 0
2790
- }
2791
- }
2792
- },
2793
- "examples" : {
2794
- "Valid requestBody Definitions" : {
2795
- "value" : {
2796
- "isReviewEnabled" : true,
2797
- "articleViewType" : "LISTVIEW",
2798
- "visibility" : "AGENTS",
2799
- "moderationType" : "ALL_ACTION",
2800
- "translations" : [ {
2801
- "name" : "Root name",
2802
- "description" : "Root description",
2803
- "permalink" : "root-name-1",
2804
- "locale" : "en"
2805
- } ],
2806
- "primaryDepartmentId" : "5000000063894",
2807
- "logoId" : "25",
2808
- "feedbackTicketConversionPreference" : {
2809
- "departmentId" : "5000000063895",
2810
- "assigneeId" : "5000000000059",
2811
- "status" : "ENABLED"
2812
- },
2813
- "status" : "SHOW_IN_HELPCENTER",
2814
- "associatedDepartmentIds" : [ "5000000063895" ]
2815
- }
2816
- }
2817
- }
2818
- }
2819
- },
2820
- "x-custom-request-body-attributes" : {
2821
- "non-empty" : false,
2822
- "allow-invalid" : false
2823
- }
2824
- }
2825
- },
2826
- "securitySchemes" : {
2827
- "cookie-auth" : {
2828
- "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
2829
- },
2830
- "org-oauth" : {
2831
- "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
2832
- },
2833
- "iam-oauth2-schema" : {
2834
- "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
2835
- }
2836
- }
2837
- },
2838
- "x-entity" : "KBRootCategory"
2839
- }