agent-generator-cli 1.0.0 → 1.0.2

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 (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,4079 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Topic",
5
+ "version" : "1.0.0"
6
+ },
7
+ "paths" : {
8
+ "/portal/api/communityTopics/{topicId}/participants" : {
9
+ "get" : {
10
+ "tags" : [ "Topic" ],
11
+ "summary" : "Topic Participants List",
12
+ "description" : "Get participants of a topic ",
13
+ "operationId" : "getParticipantsList",
14
+ "parameters" : [ {
15
+ "$ref" : "#/components/parameters/limit"
16
+ }, {
17
+ "$ref" : "#/components/parameters/from"
18
+ }, {
19
+ "$ref" : "#/components/parameters/topicId"
20
+ }, {
21
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
22
+ } ],
23
+ "responses" : {
24
+ "200" : {
25
+ "$ref" : "#/components/responses/getParticipantsList"
26
+ }
27
+ },
28
+ "security" : [ {
29
+ "jwt-oauth" : [ "jwt-oauth" ]
30
+ } ],
31
+ "x-audience" : [ "external-public" ],
32
+ "x-custom-url-attribute" : {
33
+ "security" : {
34
+ "throttle" : {
35
+ "inline" : [ {
36
+ "scope" : "APPSERVER",
37
+ "rules" : [ {
38
+ "duration" : 60000,
39
+ "lock-period" : 600000,
40
+ "threshold" : 50,
41
+ "hip" : false
42
+ } ],
43
+ "window" : "ROLLING",
44
+ "key" : "url.path+user.zuid"
45
+ } ]
46
+ },
47
+ "extraparams" : {
48
+ "disable" : true,
49
+ "ignore" : false
50
+ },
51
+ "authentication" : { }
52
+ },
53
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getTopicPartcipants"
54
+ }
55
+ }
56
+ },
57
+ "/portal/api/mostPopularCommunityTopics" : {
58
+ "get" : {
59
+ "tags" : [ "Topic" ],
60
+ "summary" : "Most Popular Topics",
61
+ "description" : "Get Most Popular Topics (type=IDEA|QUESTION|PROBLEM|ANNOUNCEMENT, categoryId = 3000006,from=1,limit=5)",
62
+ "operationId" : "mostPopularTopics",
63
+ "parameters" : [ {
64
+ "$ref" : "#/components/parameters/limit"
65
+ }, {
66
+ "$ref" : "#/components/parameters/from"
67
+ }, {
68
+ "name" : "includeCount",
69
+ "in" : "query",
70
+ "description" : "includes count on true",
71
+ "required" : false,
72
+ "style" : "form",
73
+ "explode" : true,
74
+ "schema" : {
75
+ "type" : [ "boolean", "null" ],
76
+ "description" : "includes count on true",
77
+ "x-audience" : [ "company-internal" ]
78
+ }
79
+ }, {
80
+ "$ref" : "#/components/parameters/type"
81
+ }, {
82
+ "$ref" : "#/components/parameters/categoryIdMultiple"
83
+ }, {
84
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
85
+ } ],
86
+ "responses" : {
87
+ "200" : {
88
+ "$ref" : "#/components/responses/listAllTopics"
89
+ }
90
+ },
91
+ "security" : [ {
92
+ "jwt-oauth" : [ "jwt-oauth" ]
93
+ } ],
94
+ "x-audience" : [ "external-public" ],
95
+ "x-custom-url-attribute" : {
96
+ "security" : {
97
+ "throttle" : {
98
+ "inline" : [ {
99
+ "scope" : "APPSERVER",
100
+ "rules" : [ {
101
+ "duration" : 60000,
102
+ "lock-period" : 600000,
103
+ "threshold" : 60,
104
+ "hip" : false
105
+ } ],
106
+ "window" : "ROLLING",
107
+ "key" : "url.path+user.zuid"
108
+ } ]
109
+ },
110
+ "extraparams" : {
111
+ "disable" : true,
112
+ "ignore" : false
113
+ },
114
+ "authentication" : { }
115
+ },
116
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getMostPopularTopics"
117
+ }
118
+ }
119
+ },
120
+ "/portal/api/communityPreferences" : {
121
+ "get" : {
122
+ "tags" : [ "Topic" ],
123
+ "summary" : "Community Preferences",
124
+ "description" : "Get Community Preferences",
125
+ "operationId" : "communityPreferences",
126
+ "parameters" : [ {
127
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
128
+ } ],
129
+ "responses" : {
130
+ "200" : {
131
+ "$ref" : "#/components/responses/communityPreferences"
132
+ }
133
+ },
134
+ "security" : [ {
135
+ "jwt-oauth" : [ "jwt-oauth" ]
136
+ } ],
137
+ "x-audience" : [ "external-public" ],
138
+ "x-custom-url-attribute" : {
139
+ "security" : {
140
+ "throttle" : {
141
+ "inline" : [ {
142
+ "scope" : "APPSERVER",
143
+ "rules" : [ {
144
+ "duration" : 60000,
145
+ "lock-period" : 600000,
146
+ "threshold" : 50,
147
+ "hip" : false
148
+ } ],
149
+ "window" : "ROLLING",
150
+ "key" : "url.path+user.zuid"
151
+ } ]
152
+ },
153
+ "extraparams" : {
154
+ "disable" : true,
155
+ "ignore" : false
156
+ },
157
+ "authentication" : { }
158
+ },
159
+ "apimethod" : "com.zoho.desk.helpcenter.community.topic.topictype.TopicTypeRestService.getTopicTypesForHelpCenter"
160
+ }
161
+ }
162
+ },
163
+ "/portal/api/me/followedCommunityTopics" : {
164
+ "get" : {
165
+ "tags" : [ "Topic" ],
166
+ "summary" : "My Followed topics",
167
+ "description" : "List all Followed Topics of the current User ",
168
+ "operationId" : "communityMyFollowedTopics",
169
+ "parameters" : [ {
170
+ "$ref" : "#/components/parameters/limit"
171
+ }, {
172
+ "$ref" : "#/components/parameters/from"
173
+ }, {
174
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
175
+ } ],
176
+ "responses" : {
177
+ "200" : {
178
+ "$ref" : "#/components/responses/communityMyFollowedTopics"
179
+ }
180
+ },
181
+ "security" : [ {
182
+ "jwt-oauth" : [ "jwt-oauth" ]
183
+ } ],
184
+ "x-audience" : [ "external-public" ],
185
+ "x-custom-url-attribute" : {
186
+ "security" : {
187
+ "throttle" : {
188
+ "inline" : [ {
189
+ "scope" : "APPSERVER",
190
+ "rules" : [ {
191
+ "duration" : 60000,
192
+ "lock-period" : 300000,
193
+ "threshold" : 40,
194
+ "hip" : false
195
+ } ],
196
+ "window" : "ROLLING",
197
+ "key" : "url.path+user.zuid"
198
+ } ]
199
+ },
200
+ "extraparams" : {
201
+ "disable" : true,
202
+ "ignore" : false
203
+ },
204
+ "authentication" : { }
205
+ },
206
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getMyFollowedTopics"
207
+ }
208
+ }
209
+ },
210
+ "/portal/api/communityTopics" : {
211
+ "get" : {
212
+ "tags" : [ "Topic" ],
213
+ "summary" : "List all topics",
214
+ "description" : "API to get all Topics",
215
+ "operationId" : "listAllTopics",
216
+ "parameters" : [ {
217
+ "$ref" : "#/components/parameters/isDescending"
218
+ }, {
219
+ "$ref" : "#/components/parameters/limit"
220
+ }, {
221
+ "$ref" : "#/components/parameters/from"
222
+ }, {
223
+ "name" : "includeCount",
224
+ "in" : "query",
225
+ "description" : "includes count on true",
226
+ "required" : false,
227
+ "style" : "form",
228
+ "explode" : true,
229
+ "schema" : {
230
+ "type" : [ "boolean", "null" ],
231
+ "description" : "includes count on true",
232
+ "x-audience" : [ "company-internal" ]
233
+ }
234
+ }, {
235
+ "name" : "sortBy",
236
+ "in" : "query",
237
+ "description" : "Key that sorts topics by a particular attribute: createdTime, modifiedTime, or latestCommentTime",
238
+ "required" : false,
239
+ "style" : "form",
240
+ "explode" : true,
241
+ "schema" : {
242
+ "type" : [ "string", "null" ],
243
+ "description" : "Key that sorts topics by a particular attribute: createdTime, modifiedTime, or latestCommentTime",
244
+ "enum" : [ "createdTime", "modifiedTime", "latestCommentTime" ],
245
+ "maxLength" : 100,
246
+ "minLength" : 0
247
+ }
248
+ }, {
249
+ "name" : "label",
250
+ "in" : "query",
251
+ "description" : "Topic Label",
252
+ "required" : false,
253
+ "style" : "form",
254
+ "explode" : true,
255
+ "schema" : {
256
+ "type" : [ "string", "null" ],
257
+ "description" : "Topic Label",
258
+ "enum" : [ "nostatus", "needmoreinfo", "workingonit", "answered", "unanswered", "maybelater", "underreview", "implemented", "willnotimplement", "notaproblem", "temporaryfix", "analyzing", "solved", "unsolved", "mostvoted", "inprogress" ],
259
+ "maxLength" : 100,
260
+ "minLength" : 0
261
+ }
262
+ }, {
263
+ "$ref" : "#/components/parameters/type"
264
+ }, {
265
+ "name" : "tagName",
266
+ "in" : "query",
267
+ "description" : "Name of the Tag",
268
+ "required" : false,
269
+ "style" : "form",
270
+ "explode" : true,
271
+ "schema" : {
272
+ "type" : [ "string", "null" ],
273
+ "description" : "Name of the Tag",
274
+ "maxLength" : 100,
275
+ "minLength" : 0,
276
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+"
277
+ }
278
+ }, {
279
+ "$ref" : "#/components/parameters/isSticky"
280
+ }, {
281
+ "$ref" : "#/components/parameters/categoryIdMultiple"
282
+ }, {
283
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
284
+ } ],
285
+ "responses" : {
286
+ "200" : {
287
+ "$ref" : "#/components/responses/listAllTopicsWithViewCount"
288
+ }
289
+ },
290
+ "security" : [ {
291
+ "jwt-oauth" : [ "jwt-oauth" ]
292
+ } ],
293
+ "x-audience" : [ "external-public" ],
294
+ "x-custom-url-attribute" : {
295
+ "security" : {
296
+ "throttle" : {
297
+ "inline" : [ {
298
+ "scope" : "APPSERVER",
299
+ "rules" : [ {
300
+ "duration" : 60000,
301
+ "lock-period" : 600000,
302
+ "threshold" : 60,
303
+ "hip" : false
304
+ } ],
305
+ "window" : "ROLLING",
306
+ "key" : "url.path+user.zuid"
307
+ } ]
308
+ },
309
+ "extraparams" : {
310
+ "disable" : true,
311
+ "ignore" : false
312
+ },
313
+ "authentication" : { }
314
+ },
315
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getPublishedTopics"
316
+ }
317
+ },
318
+ "post" : {
319
+ "tags" : [ "Topic" ],
320
+ "summary" : "Add Topic",
321
+ "description" : "Add a Topic (include=attachments)",
322
+ "operationId" : "addTopic",
323
+ "parameters" : [ {
324
+ "name" : "include",
325
+ "in" : "query",
326
+ "required" : false,
327
+ "style" : "simple",
328
+ "explode" : true,
329
+ "schema" : {
330
+ "type" : [ "null", "array" ],
331
+ "items" : {
332
+ "type" : [ "string", "null" ],
333
+ "enum" : [ "attachments" ],
334
+ "maxLength" : 100,
335
+ "minLength" : 0
336
+ },
337
+ "uniqueItems" : true
338
+ }
339
+ }, {
340
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
341
+ } ],
342
+ "requestBody" : {
343
+ "$ref" : "#/components/requestBodies/communityAddTopicJson"
344
+ },
345
+ "responses" : {
346
+ "200" : {
347
+ "$ref" : "#/components/responses/addOrUpdateTopic"
348
+ },
349
+ "422" : {
350
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
351
+ }
352
+ },
353
+ "security" : [ {
354
+ "jwt-oauth" : [ "jwt-oauth" ]
355
+ } ],
356
+ "x-audience" : [ "external-public" ],
357
+ "x-custom-url-attribute" : {
358
+ "security" : {
359
+ "throttle" : {
360
+ "policy" : "Authenticated_MainEntity_Creation_Policy"
361
+ },
362
+ "extraparams" : {
363
+ "disable" : true,
364
+ "ignore" : false
365
+ },
366
+ "authentication" : { }
367
+ },
368
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.addTopic"
369
+ }
370
+ }
371
+ },
372
+ "/portal/api/unrepliedCommunityTopics" : {
373
+ "get" : {
374
+ "tags" : [ "Topic" ],
375
+ "summary" : "Unreplied Topics",
376
+ "description" : "Get Unreplied Topics (type=IDEA|QUESTION|PROBLEM, categoryId = 3000006,from=1,limit=5)",
377
+ "operationId" : "unrepliedTopics",
378
+ "parameters" : [ {
379
+ "$ref" : "#/components/parameters/limit"
380
+ }, {
381
+ "$ref" : "#/components/parameters/from"
382
+ }, {
383
+ "$ref" : "#/components/parameters/includeCount"
384
+ }, {
385
+ "$ref" : "#/components/parameters/type"
386
+ }, {
387
+ "$ref" : "#/components/parameters/isSticky"
388
+ }, {
389
+ "$ref" : "#/components/parameters/categoryIdMultiple"
390
+ }, {
391
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
392
+ } ],
393
+ "responses" : {
394
+ "200" : {
395
+ "$ref" : "#/components/responses/listAllTopicsWithViewCount"
396
+ }
397
+ },
398
+ "security" : [ {
399
+ "jwt-oauth" : [ "jwt-oauth" ]
400
+ } ],
401
+ "x-audience" : [ "external-public" ],
402
+ "x-custom-url-attribute" : {
403
+ "security" : {
404
+ "throttle" : {
405
+ "inline" : [ {
406
+ "scope" : "APPSERVER",
407
+ "rules" : [ {
408
+ "duration" : 60000,
409
+ "lock-period" : 600000,
410
+ "threshold" : 60,
411
+ "hip" : false
412
+ } ],
413
+ "window" : "ROLLING",
414
+ "key" : "url.path+user.zuid"
415
+ } ]
416
+ },
417
+ "extraparams" : {
418
+ "disable" : true,
419
+ "ignore" : false
420
+ },
421
+ "authentication" : { }
422
+ },
423
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getUnrepliedTopics"
424
+ }
425
+ }
426
+ },
427
+ "/portal/api/communityTopicPreview" : {
428
+ "post" : {
429
+ "tags" : [ "Topic" ],
430
+ "summary" : "Preview topic",
431
+ "description" : "Preview Topic ",
432
+ "operationId" : "previewTopic",
433
+ "parameters" : [ {
434
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
435
+ } ],
436
+ "requestBody" : {
437
+ "$ref" : "#/components/requestBodies/communityPreViewTopicJson"
438
+ },
439
+ "responses" : {
440
+ "200" : {
441
+ "$ref" : "#/components/responses/communityPreViewTopicJson"
442
+ },
443
+ "422" : {
444
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
445
+ }
446
+ },
447
+ "security" : [ {
448
+ "jwt-oauth" : [ "jwt-oauth" ]
449
+ } ],
450
+ "x-audience" : [ "external-public" ],
451
+ "x-custom-url-attribute" : {
452
+ "security" : {
453
+ "throttle" : {
454
+ "inline" : [ {
455
+ "scope" : "APPSERVER",
456
+ "rules" : [ {
457
+ "duration" : 60000,
458
+ "lock-period" : 600000,
459
+ "threshold" : 50,
460
+ "hip" : false
461
+ } ],
462
+ "window" : "ROLLING",
463
+ "key" : "url.path+user.zuid"
464
+ } ]
465
+ },
466
+ "extraparams" : {
467
+ "disable" : true,
468
+ "ignore" : false
469
+ },
470
+ "authentication" : { }
471
+ },
472
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.preViewTopic"
473
+ }
474
+ }
475
+ },
476
+ "/portal/api/communityTopics/{topicId}" : {
477
+ "get" : {
478
+ "tags" : [ "Topic" ],
479
+ "summary" : "Get Single Topic",
480
+ "description" : "Get Single Topic (include=attachements)",
481
+ "operationId" : "getATopic",
482
+ "parameters" : [ {
483
+ "name" : "include",
484
+ "in" : "query",
485
+ "description" : "Additional information related to the topics. Values allowed are: @seo@, @featuredImage@ and @attachments@",
486
+ "required" : false,
487
+ "style" : "simple",
488
+ "explode" : true,
489
+ "schema" : {
490
+ "type" : [ "null", "array" ],
491
+ "description" : "Additional information related to the topics. Values allowed are: @seo@, @featuredImage@ and @attachments@",
492
+ "items" : {
493
+ "type" : [ "string", "null" ],
494
+ "enum" : [ "attachments" ],
495
+ "maxLength" : 100,
496
+ "minLength" : 0,
497
+ "x-custom-parameters-attributes" : [ ]
498
+ },
499
+ "uniqueItems" : true
500
+ }
501
+ }, {
502
+ "$ref" : "#/components/parameters/topicId"
503
+ }, {
504
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
505
+ } ],
506
+ "responses" : {
507
+ "200" : {
508
+ "$ref" : "#/components/responses/getTopicResponse"
509
+ }
510
+ },
511
+ "security" : [ {
512
+ "jwt-oauth" : [ "jwt-oauth" ]
513
+ } ],
514
+ "x-audience" : [ "external-public" ],
515
+ "x-custom-url-attribute" : {
516
+ "security" : {
517
+ "throttle" : {
518
+ "inline" : [ {
519
+ "scope" : "APPSERVER",
520
+ "rules" : [ {
521
+ "duration" : 60000,
522
+ "lock-period" : 600000,
523
+ "threshold" : 60,
524
+ "hip" : false
525
+ } ],
526
+ "window" : "ROLLING",
527
+ "key" : "url.path+user.remoteip"
528
+ } ]
529
+ },
530
+ "extraparams" : {
531
+ "disable" : true,
532
+ "ignore" : false
533
+ },
534
+ "authentication" : { }
535
+ },
536
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getTopic"
537
+ }
538
+ },
539
+ "put" : {
540
+ "tags" : [ "Topic" ],
541
+ "summary" : "Update a topic",
542
+ "description" : "Update a Topic (include=attachments)",
543
+ "operationId" : "updateATopic",
544
+ "parameters" : [ {
545
+ "name" : "include",
546
+ "in" : "query",
547
+ "required" : false,
548
+ "style" : "simple",
549
+ "explode" : true,
550
+ "schema" : {
551
+ "type" : [ "null", "array" ],
552
+ "items" : {
553
+ "type" : [ "string", "null" ],
554
+ "enum" : [ "attachments" ],
555
+ "maxLength" : 100,
556
+ "minLength" : 0
557
+ },
558
+ "uniqueItems" : true
559
+ }
560
+ }, {
561
+ "$ref" : "#/components/parameters/topicId"
562
+ }, {
563
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
564
+ } ],
565
+ "requestBody" : {
566
+ "$ref" : "#/components/requestBodies/communityUpdateTopicJson"
567
+ },
568
+ "responses" : {
569
+ "200" : {
570
+ "$ref" : "#/components/responses/addOrUpdateTopic"
571
+ },
572
+ "422" : {
573
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
574
+ }
575
+ },
576
+ "security" : [ {
577
+ "jwt-oauth" : [ "jwt-oauth" ]
578
+ } ],
579
+ "x-audience" : [ "external-public" ],
580
+ "x-custom-url-attribute" : {
581
+ "security" : {
582
+ "throttle" : {
583
+ "policy" : "EntityUpdateAndDelete_Policy"
584
+ },
585
+ "extraparams" : {
586
+ "disable" : true,
587
+ "ignore" : false
588
+ },
589
+ "authentication" : { }
590
+ },
591
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.updateTopic"
592
+ }
593
+ }
594
+ },
595
+ "/portal/api/mostDiscussedCommunityTopics" : {
596
+ "get" : {
597
+ "tags" : [ "Topic" ],
598
+ "summary" : "Most Discussed Topics",
599
+ "description" : "Get Most Discussed Topics (type=IDEA|QUESTION|PROBLEM|ANNOUNCEMENT, categoryId = 3000006,from=1,limit=5)",
600
+ "operationId" : "mostDiscussedTopics",
601
+ "parameters" : [ {
602
+ "$ref" : "#/components/parameters/limit"
603
+ }, {
604
+ "$ref" : "#/components/parameters/from"
605
+ }, {
606
+ "name" : "includeCount",
607
+ "in" : "query",
608
+ "description" : "includes count on true",
609
+ "required" : false,
610
+ "style" : "form",
611
+ "explode" : true,
612
+ "schema" : {
613
+ "type" : [ "boolean", "null" ],
614
+ "description" : "includes count on true",
615
+ "x-audience" : [ "company-internal" ]
616
+ }
617
+ }, {
618
+ "$ref" : "#/components/parameters/type"
619
+ }, {
620
+ "$ref" : "#/components/parameters/categoryIdMultiple"
621
+ }, {
622
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
623
+ } ],
624
+ "responses" : {
625
+ "200" : {
626
+ "$ref" : "#/components/responses/listAllTopics"
627
+ }
628
+ },
629
+ "security" : [ {
630
+ "jwt-oauth" : [ "jwt-oauth" ]
631
+ } ],
632
+ "x-audience" : [ "external-public" ],
633
+ "x-custom-url-attribute" : {
634
+ "security" : {
635
+ "throttle" : {
636
+ "inline" : [ {
637
+ "scope" : "APPSERVER",
638
+ "rules" : [ {
639
+ "duration" : 60000,
640
+ "lock-period" : 600000,
641
+ "threshold" : 60,
642
+ "hip" : false
643
+ } ],
644
+ "window" : "ROLLING",
645
+ "key" : "url.path+user.zuid"
646
+ } ]
647
+ },
648
+ "extraparams" : {
649
+ "disable" : true,
650
+ "ignore" : false
651
+ },
652
+ "authentication" : { }
653
+ },
654
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getMostDiscussedTopics"
655
+ }
656
+ }
657
+ },
658
+ "/portal/api/communityUsers/{userId}/topics" : {
659
+ "get" : {
660
+ "tags" : [ "Topic" ],
661
+ "summary" : "Get User Topics",
662
+ "description" : "to get all the community topics published by a user",
663
+ "operationId" : "getUserTopics",
664
+ "parameters" : [ {
665
+ "$ref" : "#/components/parameters/limit"
666
+ }, {
667
+ "$ref" : "#/components/parameters/from"
668
+ }, {
669
+ "name" : "startTime",
670
+ "in" : "query",
671
+ "description" : "Start time of user Topics. Start time should be in GMT time zone",
672
+ "required" : false,
673
+ "style" : "form",
674
+ "explode" : true,
675
+ "schema" : {
676
+ "type" : [ "string", "null" ],
677
+ "description" : "Start time of user Topics. Start time should be in GMT time zone",
678
+ "maxLength" : 100,
679
+ "minLength" : 0,
680
+ "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))"
681
+ }
682
+ }, {
683
+ "name" : "endTime",
684
+ "in" : "query",
685
+ "description" : "end time of user Topics. End time should be in GMT time zone",
686
+ "required" : false,
687
+ "style" : "form",
688
+ "explode" : true,
689
+ "schema" : {
690
+ "type" : [ "string", "null" ],
691
+ "description" : "end time of user Topics. End time should be in GMT time zone",
692
+ "maxLength" : 100,
693
+ "minLength" : 0,
694
+ "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))"
695
+ }
696
+ }, {
697
+ "$ref" : "#/components/parameters/type"
698
+ }, {
699
+ "$ref" : "#/components/parameters/categoryIdMultiple"
700
+ }, {
701
+ "name" : "userId",
702
+ "in" : "path",
703
+ "required" : true,
704
+ "style" : "simple",
705
+ "explode" : false,
706
+ "schema" : {
707
+ "type" : [ "string", "null", "integer" ],
708
+ "format" : "int64",
709
+ "pattern" : "([0-9]+)"
710
+ }
711
+ }, {
712
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
713
+ } ],
714
+ "responses" : {
715
+ "200" : {
716
+ "$ref" : "#/components/responses/getUserTopics"
717
+ }
718
+ },
719
+ "security" : [ {
720
+ "jwt-oauth" : [ "jwt-oauth" ]
721
+ } ],
722
+ "x-audience" : [ "external-public" ],
723
+ "x-custom-url-attribute" : {
724
+ "security" : {
725
+ "throttle" : {
726
+ "inline" : [ {
727
+ "scope" : "APPSERVER",
728
+ "rules" : [ {
729
+ "duration" : 60000,
730
+ "lock-period" : 600000,
731
+ "threshold" : 50,
732
+ "hip" : false
733
+ } ],
734
+ "window" : "ROLLING",
735
+ "key" : "url.path+user.zuid"
736
+ } ]
737
+ },
738
+ "extraparams" : {
739
+ "disable" : true,
740
+ "ignore" : false
741
+ },
742
+ "authentication" : { }
743
+ },
744
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getUserTopics"
745
+ }
746
+ }
747
+ },
748
+ "/portal/api/communityTopics/{topicId}/followers" : {
749
+ "get" : {
750
+ "tags" : [ "Topic" ],
751
+ "summary" : "List all community Topic Followers",
752
+ "description" : "Get All Topic Followers",
753
+ "operationId" : "listAllCommunityTopicFollowers",
754
+ "parameters" : [ {
755
+ "$ref" : "#/components/parameters/limit"
756
+ }, {
757
+ "$ref" : "#/components/parameters/from"
758
+ }, {
759
+ "$ref" : "#/components/parameters/topicId"
760
+ }, {
761
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
762
+ } ],
763
+ "responses" : {
764
+ "200" : {
765
+ "$ref" : "#/components/responses/listAllCommunityTopicFollowers"
766
+ }
767
+ },
768
+ "security" : [ {
769
+ "jwt-oauth" : [ "jwt-oauth" ]
770
+ } ],
771
+ "x-audience" : [ "external-public" ],
772
+ "x-custom-url-attribute" : {
773
+ "security" : {
774
+ "throttle" : {
775
+ "inline" : [ {
776
+ "scope" : "APPSERVER",
777
+ "rules" : [ {
778
+ "duration" : 60000,
779
+ "lock-period" : 600000,
780
+ "threshold" : 50,
781
+ "hip" : false
782
+ } ],
783
+ "window" : "ROLLING",
784
+ "key" : "url.path+user.zuid"
785
+ } ]
786
+ },
787
+ "extraparams" : {
788
+ "disable" : true,
789
+ "ignore" : false
790
+ },
791
+ "authentication" : { }
792
+ },
793
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getTopicFollowers"
794
+ }
795
+ }
796
+ },
797
+ "/portal/api/communityTopics/relatedTopicSearch" : {
798
+ "get" : {
799
+ "tags" : [ "Topic" ],
800
+ "summary" : "Related Topic search",
801
+ "description" : "Search related community topics by topic id",
802
+ "operationId" : "relatedTopicSearch",
803
+ "parameters" : [ {
804
+ "$ref" : "#/components/parameters/limit"
805
+ }, {
806
+ "name" : "communityId",
807
+ "in" : "query",
808
+ "description" : "To retrieve the related topics",
809
+ "required" : true,
810
+ "style" : "form",
811
+ "explode" : true,
812
+ "schema" : {
813
+ "type" : [ "string", "null", "integer" ],
814
+ "format" : "int64",
815
+ "description" : "To retrieve the related topics",
816
+ "pattern" : "([0-9]+)"
817
+ }
818
+ }, {
819
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
820
+ } ],
821
+ "responses" : {
822
+ "422" : {
823
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
824
+ },
825
+ "204" : {
826
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
827
+ },
828
+ "200" : {
829
+ "$ref" : "#/components/responses/relatedTopicSearchResponse"
830
+ }
831
+ },
832
+ "security" : [ {
833
+ "jwt-oauth" : [ "jwt-oauth" ]
834
+ } ],
835
+ "x-audience" : [ "external-public" ],
836
+ "x-custom-url-attribute" : {
837
+ "security" : {
838
+ "throttle" : {
839
+ "inline" : [ {
840
+ "scope" : "APPSERVER",
841
+ "rules" : [ {
842
+ "duration" : 60000,
843
+ "lock-period" : 600000,
844
+ "threshold" : 100,
845
+ "hip" : false
846
+ } ],
847
+ "window" : "ROLLING",
848
+ "key" : "url.path+user.zuid"
849
+ } ]
850
+ },
851
+ "extraparams" : {
852
+ "disable" : true,
853
+ "ignore" : false
854
+ },
855
+ "authentication" : { }
856
+ },
857
+ "apimethod" : "com.zoho.desk.helpcenter.community.search.SearchService.getRelatedTopics"
858
+ }
859
+ }
860
+ },
861
+ "/portal/api/communityTopicByPermalink" : {
862
+ "get" : {
863
+ "tags" : [ "Topic" ],
864
+ "summary" : "Get Topic by permalink",
865
+ "description" : "Get Topic by Permalink ",
866
+ "operationId" : "getTopicByPermalink",
867
+ "parameters" : [ {
868
+ "name" : "permalink",
869
+ "in" : "query",
870
+ "description" : "permalink",
871
+ "required" : true,
872
+ "style" : "form",
873
+ "explode" : true,
874
+ "schema" : {
875
+ "type" : [ "string", "null" ],
876
+ "description" : "permalink",
877
+ "maxLength" : 1000,
878
+ "minLength" : 0,
879
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
880
+ }
881
+ }, {
882
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
883
+ } ],
884
+ "responses" : {
885
+ "200" : {
886
+ "$ref" : "#/components/responses/getTopicByPermalink"
887
+ },
888
+ "422" : {
889
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
890
+ }
891
+ },
892
+ "security" : [ {
893
+ "jwt-oauth" : [ "jwt-oauth" ]
894
+ } ],
895
+ "x-audience" : [ "external-public" ],
896
+ "x-custom-url-attribute" : {
897
+ "security" : {
898
+ "throttle" : {
899
+ "inline" : [ {
900
+ "scope" : "APPSERVER",
901
+ "rules" : [ {
902
+ "duration" : 60000,
903
+ "lock-period" : 600000,
904
+ "threshold" : 50,
905
+ "hip" : false
906
+ } ],
907
+ "window" : "ROLLING",
908
+ "key" : "url.path+user.zuid"
909
+ } ]
910
+ },
911
+ "extraparams" : {
912
+ "disable" : true,
913
+ "ignore" : false
914
+ },
915
+ "authentication" : { }
916
+ },
917
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getTopicByPermalink"
918
+ }
919
+ }
920
+ },
921
+ "/portal/api/communityTopics/{topicId}/voters" : {
922
+ "get" : {
923
+ "tags" : [ "Topic" ],
924
+ "summary" : "Topic Voters List",
925
+ "description" : "Get voters of a topic ",
926
+ "operationId" : "getVotersList",
927
+ "parameters" : [ {
928
+ "$ref" : "#/components/parameters/limit"
929
+ }, {
930
+ "$ref" : "#/components/parameters/from"
931
+ }, {
932
+ "$ref" : "#/components/parameters/topicId"
933
+ }, {
934
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
935
+ } ],
936
+ "responses" : {
937
+ "404" : {
938
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
939
+ },
940
+ "422" : {
941
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
942
+ },
943
+ "200" : {
944
+ "$ref" : "#/components/responses/getParticipantsList"
945
+ }
946
+ },
947
+ "security" : [ {
948
+ "jwt-oauth" : [ "jwt-oauth" ]
949
+ } ],
950
+ "x-audience" : [ "external-public" ],
951
+ "x-custom-url-attribute" : {
952
+ "security" : {
953
+ "throttle" : {
954
+ "inline" : [ {
955
+ "scope" : "APPSERVER",
956
+ "rules" : [ {
957
+ "duration" : 60000,
958
+ "lock-period" : 600000,
959
+ "threshold" : 50,
960
+ "hip" : false
961
+ } ],
962
+ "window" : "ROLLING",
963
+ "key" : "url.path+user.zuid"
964
+ } ]
965
+ },
966
+ "extraparams" : {
967
+ "disable" : true,
968
+ "ignore" : false
969
+ },
970
+ "authentication" : { }
971
+ },
972
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getTopicVoters"
973
+ }
974
+ }
975
+ },
976
+ "/portal/api/communityTopics/{topicId}/like" : {
977
+ "post" : {
978
+ "tags" : [ "Topic" ],
979
+ "summary" : " Like a Topic",
980
+ "description" : "Like a Topic",
981
+ "operationId" : "likeATopic",
982
+ "parameters" : [ {
983
+ "$ref" : "#/components/parameters/topicId"
984
+ }, {
985
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
986
+ } ],
987
+ "responses" : {
988
+ "200" : {
989
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
990
+ }
991
+ },
992
+ "security" : [ {
993
+ "jwt-oauth" : [ "jwt-oauth" ]
994
+ } ],
995
+ "x-audience" : [ "external-public" ],
996
+ "x-custom-url-attribute" : {
997
+ "security" : {
998
+ "throttle" : {
999
+ "policy" : "UserReaction_Policy"
1000
+ },
1001
+ "extraparams" : {
1002
+ "disable" : true,
1003
+ "ignore" : false
1004
+ },
1005
+ "authentication" : { }
1006
+ },
1007
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.likeTopic"
1008
+ }
1009
+ }
1010
+ },
1011
+ "/portal/api/communityTopics/search" : {
1012
+ "get" : {
1013
+ "tags" : [ "Topic" ],
1014
+ "summary" : "Topic search",
1015
+ "description" : "API to search community topics",
1016
+ "operationId" : "topicSearch",
1017
+ "parameters" : [ {
1018
+ "$ref" : "#/components/parameters/isDescending"
1019
+ }, {
1020
+ "name" : "searchStr",
1021
+ "in" : "query",
1022
+ "description" : "The String to be searched",
1023
+ "required" : true,
1024
+ "style" : "form",
1025
+ "explode" : true,
1026
+ "schema" : {
1027
+ "type" : [ "string", "null" ],
1028
+ "description" : "The String to be searched",
1029
+ "maxLength" : 100,
1030
+ "minLength" : 0,
1031
+ "pattern" : "^[A-Za-z0-9_\\-]+$"
1032
+ }
1033
+ }, {
1034
+ "$ref" : "#/components/parameters/limit"
1035
+ }, {
1036
+ "$ref" : "#/components/parameters/from"
1037
+ }, {
1038
+ "name" : "includeCount",
1039
+ "in" : "query",
1040
+ "description" : "includes count on true",
1041
+ "required" : false,
1042
+ "style" : "form",
1043
+ "explode" : true,
1044
+ "schema" : {
1045
+ "type" : [ "boolean", "null" ],
1046
+ "description" : "includes count on true",
1047
+ "x-audience" : [ "company-internal" ]
1048
+ }
1049
+ }, {
1050
+ "name" : "sortBy",
1051
+ "in" : "query",
1052
+ "description" : "SortBy can be: @relevance@, @createdTime@",
1053
+ "required" : false,
1054
+ "style" : "form",
1055
+ "explode" : true,
1056
+ "schema" : {
1057
+ "type" : [ "string", "null" ],
1058
+ "description" : "SortBy can be: @relevance@, @createdTime@",
1059
+ "enum" : [ "relevance", "createdTime" ],
1060
+ "maxLength" : 100,
1061
+ "minLength" : 0
1062
+ }
1063
+ }, {
1064
+ "$ref" : "#/components/parameters/type"
1065
+ }, {
1066
+ "$ref" : "#/components/parameters/categoryIdMultiple"
1067
+ }, {
1068
+ "$ref" : "#/components/parameters/searchKeyWordMatch"
1069
+ }, {
1070
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1071
+ } ],
1072
+ "responses" : {
1073
+ "422" : {
1074
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1075
+ },
1076
+ "204" : {
1077
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1078
+ },
1079
+ "200" : {
1080
+ "$ref" : "#/components/responses/topicSearchResponse"
1081
+ }
1082
+ },
1083
+ "security" : [ {
1084
+ "jwt-oauth" : [ "jwt-oauth" ]
1085
+ } ],
1086
+ "x-audience" : [ "external-public" ],
1087
+ "x-custom-url-attribute" : {
1088
+ "security" : {
1089
+ "throttle" : {
1090
+ "inline" : [ {
1091
+ "scope" : "APPSERVER",
1092
+ "rules" : [ {
1093
+ "duration" : 60000,
1094
+ "lock-period" : 600000,
1095
+ "threshold" : 100,
1096
+ "hip" : false
1097
+ } ],
1098
+ "window" : "ROLLING",
1099
+ "key" : "url.path+user.zuid"
1100
+ } ]
1101
+ },
1102
+ "extraparams" : {
1103
+ "disable" : true,
1104
+ "ignore" : false
1105
+ },
1106
+ "authentication" : { }
1107
+ },
1108
+ "apimethod" : "com.zoho.desk.helpcenter.community.search.SearchService.searchCommunity"
1109
+ }
1110
+ }
1111
+ },
1112
+ "/portal/api/communityMyDraftedTopics" : {
1113
+ "get" : {
1114
+ "tags" : [ "Topic" ],
1115
+ "summary" : "MyDraftedTopics",
1116
+ "description" : "List all Drafted Topics of the current User (from=1,limit=5)",
1117
+ "operationId" : "myDraftedTopics",
1118
+ "parameters" : [ {
1119
+ "$ref" : "#/components/parameters/limit"
1120
+ }, {
1121
+ "$ref" : "#/components/parameters/from"
1122
+ }, {
1123
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1124
+ } ],
1125
+ "responses" : {
1126
+ "200" : {
1127
+ "$ref" : "#/components/responses/myDraftedTopicsResponse"
1128
+ }
1129
+ },
1130
+ "security" : [ {
1131
+ "jwt-oauth" : [ "jwt-oauth" ]
1132
+ } ],
1133
+ "x-audience" : [ "external-public" ],
1134
+ "x-custom-url-attribute" : {
1135
+ "security" : {
1136
+ "throttle" : {
1137
+ "inline" : [ {
1138
+ "scope" : "APPSERVER",
1139
+ "rules" : [ {
1140
+ "duration" : 60000,
1141
+ "lock-period" : 600000,
1142
+ "threshold" : 50,
1143
+ "hip" : false
1144
+ } ],
1145
+ "window" : "ROLLING",
1146
+ "key" : "url.path+user.zuid"
1147
+ } ]
1148
+ },
1149
+ "extraparams" : {
1150
+ "disable" : true,
1151
+ "ignore" : false
1152
+ },
1153
+ "authentication" : { }
1154
+ },
1155
+ "apimethod" : "com.zoho.desk.helpcenter.community.posts.TopicPortalRestService.getMyDraftedTopics"
1156
+ }
1157
+ }
1158
+ },
1159
+ "/portal/api/communityTopContributors" : {
1160
+ "get" : {
1161
+ "tags" : [ "Topic" ],
1162
+ "summary" : "List all Top Contributors",
1163
+ "description" : "Get Top Contributors of Community",
1164
+ "operationId" : "listAllTopContributors",
1165
+ "parameters" : [ {
1166
+ "$ref" : "#/components/parameters/limit"
1167
+ }, {
1168
+ "$ref" : "#/components/parameters/categoryIdMultiple"
1169
+ }, {
1170
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1171
+ } ],
1172
+ "responses" : {
1173
+ "200" : {
1174
+ "$ref" : "#/components/responses/getParticipantsList"
1175
+ }
1176
+ },
1177
+ "security" : [ {
1178
+ "jwt-oauth" : [ "jwt-oauth" ]
1179
+ } ],
1180
+ "x-audience" : [ "external-public" ],
1181
+ "x-custom-url-attribute" : {
1182
+ "security" : {
1183
+ "throttle" : {
1184
+ "inline" : [ {
1185
+ "scope" : "APPSERVER",
1186
+ "rules" : [ {
1187
+ "duration" : 60000,
1188
+ "lock-period" : 600000,
1189
+ "threshold" : 50,
1190
+ "hip" : false
1191
+ } ],
1192
+ "window" : "ROLLING",
1193
+ "key" : "url.path+user.zuid"
1194
+ } ]
1195
+ },
1196
+ "extraparams" : {
1197
+ "disable" : true,
1198
+ "ignore" : false
1199
+ },
1200
+ "authentication" : { }
1201
+ },
1202
+ "apimethod" : "com.zoho.desk.helpcenter.community.reports.CommunityPortalReportService.getTopicTopContributors"
1203
+ }
1204
+ }
1205
+ }
1206
+ },
1207
+ "components" : {
1208
+ "schemas" : {
1209
+ "creator" : {
1210
+ "type" : [ "object", "null" ],
1211
+ "additionalProperties" : false,
1212
+ "properties" : {
1213
+ "photoUrl" : {
1214
+ "type" : [ "string", "null" ],
1215
+ "maxLength" : 100,
1216
+ "minLength" : 0,
1217
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1218
+ },
1219
+ "name" : {
1220
+ "type" : [ "string", "null" ],
1221
+ "maxLength" : 200,
1222
+ "minLength" : 0,
1223
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1224
+ },
1225
+ "id" : {
1226
+ "type" : [ "string", "null", "integer" ],
1227
+ "format" : "int64",
1228
+ "pattern" : "([0-9]+)"
1229
+ },
1230
+ "label" : {
1231
+ "$ref" : "./Label.json#/components/schemas/labelMetaResponse"
1232
+ },
1233
+ "type" : {
1234
+ "type" : [ "string", "null" ],
1235
+ "enum" : [ "ENDUSER", "SUPPORTREP" ],
1236
+ "maxLength" : 100,
1237
+ "minLength" : 0
1238
+ }
1239
+ },
1240
+ "required" : [ "id", "label", "name", "photoUrl", "type" ]
1241
+ },
1242
+ "creatorWithContactId" : {
1243
+ "additionalProperties" : false,
1244
+ "allOf" : [ {
1245
+ "$ref" : "./Topic.json#/components/schemas/creator"
1246
+ }, {
1247
+ "type" : [ "object", "null" ],
1248
+ "properties" : {
1249
+ "contactId" : {
1250
+ "type" : [ "string", "null", "integer" ],
1251
+ "format" : "int64",
1252
+ "pattern" : "([0-9]+)"
1253
+ }
1254
+ },
1255
+ "required" : [ "contactId" ]
1256
+ } ]
1257
+ },
1258
+ "participantsListData" : {
1259
+ "type" : [ "array", "null" ],
1260
+ "items" : {
1261
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
1262
+ }
1263
+ },
1264
+ "latestCommenter" : {
1265
+ "type" : [ "object", "null" ],
1266
+ "additionalProperties" : false,
1267
+ "properties" : {
1268
+ "name" : {
1269
+ "type" : [ "string", "null" ],
1270
+ "maxLength" : 200,
1271
+ "minLength" : 0,
1272
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1273
+ },
1274
+ "id" : {
1275
+ "type" : [ "string", "null", "integer" ],
1276
+ "format" : "int64",
1277
+ "pattern" : "([0-9]+)"
1278
+ },
1279
+ "type" : {
1280
+ "type" : [ "string", "null" ],
1281
+ "enum" : [ "ENDUSER", "SUPPORTREP" ],
1282
+ "maxLength" : 100,
1283
+ "minLength" : 0,
1284
+ "x-custom-parameters-attributes" : {
1285
+ "removeExif" : false,
1286
+ "replacementString" : "",
1287
+ "filterMatchedContent" : false,
1288
+ "antivirus" : false,
1289
+ "allowInvalid" : false,
1290
+ "descrption" : "Topic Type - Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION ",
1291
+ "secret" : false,
1292
+ "preserveCharsLimit" : 10,
1293
+ "trim" : false,
1294
+ "internalParam" : false,
1295
+ "preserveChars" : "0,5",
1296
+ "importUrl" : false,
1297
+ "decrypt" : false
1298
+ }
1299
+ }
1300
+ }
1301
+ },
1302
+ "getSingleTopic" : {
1303
+ "type" : [ "object", "null" ],
1304
+ "additionalProperties" : false,
1305
+ "properties" : {
1306
+ "creator" : {
1307
+ "$ref" : "./Topic.json#/components/schemas/creator"
1308
+ },
1309
+ "latestCommentTime" : {
1310
+ "type" : [ "string", "null" ],
1311
+ "maxLength" : 100,
1312
+ "minLength" : 0,
1313
+ "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))"
1314
+ },
1315
+ "subject" : {
1316
+ "type" : [ "string", "null" ],
1317
+ "maxLength" : 1000,
1318
+ "minLength" : 0
1319
+ },
1320
+ "likeCount" : {
1321
+ "type" : [ "string", "null", "integer" ],
1322
+ "format" : "int32",
1323
+ "minimum" : 0,
1324
+ "pattern" : "([0-9]+)"
1325
+ },
1326
+ "label" : {
1327
+ "type" : [ "string", "null" ],
1328
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
1329
+ "maxLength" : 100,
1330
+ "minLength" : 0
1331
+ },
1332
+ "isVoted" : {
1333
+ "type" : [ "boolean", "null" ]
1334
+ },
1335
+ "type" : {
1336
+ "type" : [ "string", "null" ],
1337
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
1338
+ "maxLength" : 100,
1339
+ "minLength" : 0,
1340
+ "x-custom-parameters-attributes" : {
1341
+ "removeExif" : false,
1342
+ "replacementString" : "",
1343
+ "filterMatchedContent" : false,
1344
+ "antivirus" : false,
1345
+ "allowInvalid" : false,
1346
+ "descrption" : "Topic Type - Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION ",
1347
+ "secret" : false,
1348
+ "preserveCharsLimit" : 10,
1349
+ "trim" : false,
1350
+ "internalParam" : false,
1351
+ "preserveChars" : "0,5",
1352
+ "importUrl" : false,
1353
+ "decrypt" : false
1354
+ }
1355
+ },
1356
+ "latestCommenter" : {
1357
+ "$ref" : "./Topic.json#/components/schemas/latestCommenter"
1358
+ },
1359
+ "content" : {
1360
+ "type" : [ "string", "null" ],
1361
+ "maxLength" : 50000,
1362
+ "minLength" : 0
1363
+ },
1364
+ "commentCount" : {
1365
+ "type" : [ "string", "null", "integer" ],
1366
+ "format" : "int32",
1367
+ "minimum" : 0,
1368
+ "pattern" : "([0-9]+)"
1369
+ },
1370
+ "createdTime" : {
1371
+ "type" : [ "string", "null" ],
1372
+ "maxLength" : 100,
1373
+ "minLength" : 0,
1374
+ "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))"
1375
+ },
1376
+ "lastCommenter" : {
1377
+ "$ref" : "./Topic.json#/components/schemas/creator"
1378
+ },
1379
+ "id" : {
1380
+ "type" : [ "string", "null", "integer" ],
1381
+ "format" : "int64",
1382
+ "pattern" : "([0-9]+)"
1383
+ },
1384
+ "permalink" : {
1385
+ "type" : [ "string", "null" ],
1386
+ "maxLength" : 100,
1387
+ "minLength" : 0,
1388
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1389
+ },
1390
+ "categoryId" : {
1391
+ "type" : [ "string", "null", "integer" ],
1392
+ "format" : "int64",
1393
+ "pattern" : "([0-9]+)",
1394
+ "x-custom-parameters-attributes" : {
1395
+ "removeExif" : false,
1396
+ "replacementString" : "",
1397
+ "filterMatchedContent" : false,
1398
+ "antivirus" : false,
1399
+ "allowInvalid" : false,
1400
+ "descrption" : "Id of category from which topics are to be retrieved",
1401
+ "secret" : false,
1402
+ "preserveCharsLimit" : 10,
1403
+ "trim" : false,
1404
+ "internalParam" : false,
1405
+ "preserveChars" : "0,5",
1406
+ "importUrl" : false,
1407
+ "decrypt" : false
1408
+ }
1409
+ },
1410
+ "status" : {
1411
+ "type" : [ "string", "null" ],
1412
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
1413
+ "maxLength" : 100,
1414
+ "minLength" : 0
1415
+ }
1416
+ },
1417
+ "required" : [ "categoryId", "commentCount", "content", "createdTime", "creator", "id", "isVoted", "label", "lastCommenter", "latestCommentTime", "latestCommenter", "likeCount", "permalink", "status", "subject", "type" ]
1418
+ },
1419
+ "data" : {
1420
+ "type" : [ "array", "null" ],
1421
+ "items" : {
1422
+ "$ref" : "./Topic.json#/components/schemas/getSingleTopic"
1423
+ }
1424
+ },
1425
+ "communityMyFollowedTopicsKeys" : {
1426
+ "type" : [ "object", "null" ],
1427
+ "additionalProperties" : false,
1428
+ "properties" : {
1429
+ "creator" : {
1430
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
1431
+ },
1432
+ "subject" : {
1433
+ "type" : [ "string", "null" ],
1434
+ "maxLength" : 1000,
1435
+ "minLength" : 0
1436
+ },
1437
+ "createdTime" : {
1438
+ "type" : [ "string", "null" ],
1439
+ "maxLength" : 100,
1440
+ "minLength" : 0,
1441
+ "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))"
1442
+ },
1443
+ "id" : {
1444
+ "type" : [ "string", "null", "integer" ],
1445
+ "format" : "int64",
1446
+ "pattern" : "([0-9]+)"
1447
+ },
1448
+ "label" : {
1449
+ "type" : [ "string", "null" ],
1450
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
1451
+ "maxLength" : 100,
1452
+ "minLength" : 0
1453
+ },
1454
+ "type" : {
1455
+ "type" : [ "string", "null" ],
1456
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
1457
+ "maxLength" : 100,
1458
+ "minLength" : 0
1459
+ },
1460
+ "permalink" : {
1461
+ "type" : [ "string", "null" ],
1462
+ "maxLength" : 100,
1463
+ "minLength" : 0,
1464
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1465
+ },
1466
+ "content" : {
1467
+ "type" : [ "string", "null" ],
1468
+ "maxLength" : 50000,
1469
+ "minLength" : 0
1470
+ },
1471
+ "categoryId" : {
1472
+ "type" : [ "string", "null", "integer" ],
1473
+ "format" : "int64",
1474
+ "pattern" : "([0-9]+)"
1475
+ },
1476
+ "status" : {
1477
+ "type" : [ "string", "null" ],
1478
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
1479
+ "maxLength" : 100,
1480
+ "minLength" : 0
1481
+ }
1482
+ },
1483
+ "required" : [ "categoryId", "content", "createdTime", "creator", "id", "label", "permalink", "status", "subject", "type" ]
1484
+ },
1485
+ "communityMyFollowedTopicsData" : {
1486
+ "type" : [ "array", "null" ],
1487
+ "items" : {
1488
+ "$ref" : "./Topic.json#/components/schemas/communityMyFollowedTopicsKeys"
1489
+ }
1490
+ },
1491
+ "listTopicKeys" : {
1492
+ "type" : [ "object", "null" ],
1493
+ "additionalProperties" : false,
1494
+ "properties" : {
1495
+ "creator" : {
1496
+ "$ref" : "./Topic.json#/components/schemas/creator"
1497
+ },
1498
+ "latestCommentTime" : {
1499
+ "type" : [ "string", "null" ],
1500
+ "maxLength" : 100,
1501
+ "minLength" : 0,
1502
+ "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))"
1503
+ },
1504
+ "subject" : {
1505
+ "type" : [ "string", "null" ],
1506
+ "maxLength" : 1000,
1507
+ "minLength" : 0
1508
+ },
1509
+ "likeCount" : {
1510
+ "type" : [ "string", "null", "integer" ],
1511
+ "format" : "int32",
1512
+ "minimum" : 0,
1513
+ "pattern" : "([0-9]+)"
1514
+ },
1515
+ "label" : {
1516
+ "type" : [ "string", "null" ],
1517
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
1518
+ "maxLength" : 100,
1519
+ "minLength" : 0,
1520
+ "x-custom-parameters-attributes" : {
1521
+ "removeExif" : false,
1522
+ "replacementString" : "",
1523
+ "filterMatchedContent" : false,
1524
+ "antivirus" : false,
1525
+ "allowInvalid" : false,
1526
+ "descrption" : "Topic Label",
1527
+ "secret" : false,
1528
+ "preserveCharsLimit" : 10,
1529
+ "trim" : false,
1530
+ "internalParam" : false,
1531
+ "preserveChars" : "0,5",
1532
+ "importUrl" : false,
1533
+ "decrypt" : false
1534
+ }
1535
+ },
1536
+ "isVoted" : {
1537
+ "type" : [ "boolean", "null" ]
1538
+ },
1539
+ "type" : {
1540
+ "type" : [ "string", "null" ],
1541
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
1542
+ "maxLength" : 100,
1543
+ "minLength" : 0,
1544
+ "x-custom-parameters-attributes" : {
1545
+ "removeExif" : false,
1546
+ "replacementString" : "",
1547
+ "filterMatchedContent" : false,
1548
+ "antivirus" : false,
1549
+ "allowInvalid" : false,
1550
+ "descrption" : "Topic Type - Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION ",
1551
+ "secret" : false,
1552
+ "preserveCharsLimit" : 10,
1553
+ "trim" : false,
1554
+ "internalParam" : false,
1555
+ "preserveChars" : "0,5",
1556
+ "importUrl" : false,
1557
+ "decrypt" : false
1558
+ }
1559
+ },
1560
+ "latestCommenter" : {
1561
+ "$ref" : "./Topic.json#/components/schemas/latestCommenter"
1562
+ },
1563
+ "content" : {
1564
+ "type" : [ "string", "null" ],
1565
+ "maxLength" : 50000,
1566
+ "minLength" : 0
1567
+ },
1568
+ "commentCount" : {
1569
+ "type" : [ "string", "null", "integer" ],
1570
+ "format" : "int32",
1571
+ "minimum" : 0,
1572
+ "pattern" : "([0-9]+)"
1573
+ },
1574
+ "createdTime" : {
1575
+ "type" : [ "string", "null" ],
1576
+ "maxLength" : 100,
1577
+ "minLength" : 0,
1578
+ "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))"
1579
+ },
1580
+ "lastCommenter" : {
1581
+ "$ref" : "./Topic.json#/components/schemas/creator"
1582
+ },
1583
+ "id" : {
1584
+ "type" : [ "string", "null", "integer" ],
1585
+ "format" : "int64",
1586
+ "pattern" : "([0-9]+)"
1587
+ },
1588
+ "viewCount" : {
1589
+ "type" : [ "string", "null", "integer" ],
1590
+ "format" : "int32",
1591
+ "minimum" : 0,
1592
+ "pattern" : "([0-9]+)"
1593
+ },
1594
+ "permalink" : {
1595
+ "type" : [ "string", "null" ],
1596
+ "maxLength" : 100,
1597
+ "minLength" : 0,
1598
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1599
+ },
1600
+ "categoryId" : {
1601
+ "type" : [ "string", "null", "integer" ],
1602
+ "format" : "int64",
1603
+ "pattern" : "([0-9]+)",
1604
+ "x-custom-parameters-attributes" : {
1605
+ "removeExif" : false,
1606
+ "replacementString" : "",
1607
+ "filterMatchedContent" : false,
1608
+ "antivirus" : false,
1609
+ "allowInvalid" : false,
1610
+ "descrption" : "Id of category from which topics are to be retrieved",
1611
+ "secret" : false,
1612
+ "preserveCharsLimit" : 10,
1613
+ "trim" : false,
1614
+ "internalParam" : false,
1615
+ "preserveChars" : "0,5",
1616
+ "importUrl" : false,
1617
+ "decrypt" : false
1618
+ }
1619
+ },
1620
+ "status" : {
1621
+ "type" : [ "string", "null" ],
1622
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
1623
+ "maxLength" : 100,
1624
+ "minLength" : 0
1625
+ }
1626
+ },
1627
+ "required" : [ "categoryId", "commentCount", "content", "createdTime", "creator", "id", "isVoted", "label", "lastCommenter", "latestCommentTime", "latestCommenter", "likeCount", "permalink", "status", "subject", "type", "viewCount" ]
1628
+ },
1629
+ "listTopicData" : {
1630
+ "type" : [ "array", "null" ],
1631
+ "items" : {
1632
+ "$ref" : "./Topic.json#/components/schemas/listTopicKeys"
1633
+ }
1634
+ },
1635
+ "ticket" : {
1636
+ "type" : [ "object", "null" ],
1637
+ "additionalProperties" : false,
1638
+ "properties" : {
1639
+ "number" : {
1640
+ "type" : [ "string", "null", "integer" ],
1641
+ "format" : "int32",
1642
+ "pattern" : "([0-9]+)"
1643
+ },
1644
+ "id" : {
1645
+ "type" : [ "string", "null", "integer" ],
1646
+ "format" : "int64",
1647
+ "pattern" : "([0-9]+)"
1648
+ }
1649
+ },
1650
+ "required" : [ "id", "number" ]
1651
+ },
1652
+ "tagDetails" : {
1653
+ "type" : [ "object", "null" ],
1654
+ "additionalProperties" : false,
1655
+ "properties" : {
1656
+ "name" : {
1657
+ "type" : [ "string", "null" ],
1658
+ "maxLength" : 200,
1659
+ "minLength" : 0,
1660
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+"
1661
+ },
1662
+ "permalink" : {
1663
+ "type" : [ "string", "null" ],
1664
+ "maxLength" : 100,
1665
+ "minLength" : 0,
1666
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
1667
+ }
1668
+ },
1669
+ "required" : [ "name", "permalink" ]
1670
+ },
1671
+ "tag" : {
1672
+ "type" : [ "array", "null" ],
1673
+ "items" : {
1674
+ "$ref" : "./Topic.json#/components/schemas/tagDetails"
1675
+ }
1676
+ },
1677
+ "FeaturedImageResponse" : {
1678
+ "type" : [ "object", "null" ],
1679
+ "additionalProperties" : false,
1680
+ "properties" : {
1681
+ "imageId" : {
1682
+ "type" : [ "string", "null", "integer" ],
1683
+ "format" : "int64",
1684
+ "pattern" : "([0-9]+)"
1685
+ },
1686
+ "imageUrl" : {
1687
+ "type" : [ "string", "null" ],
1688
+ "maxLength" : 255,
1689
+ "minLength" : 0,
1690
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1691
+ }
1692
+ },
1693
+ "required" : [ "imageId", "imageUrl" ]
1694
+ },
1695
+ "CommunitySeoResponse" : {
1696
+ "type" : [ "object", "null" ],
1697
+ "additionalProperties" : false,
1698
+ "properties" : {
1699
+ "keywords" : {
1700
+ "type" : [ "string", "null" ],
1701
+ "maxLength" : 100,
1702
+ "minLength" : 0
1703
+ },
1704
+ "useTitleAsPageTitle" : {
1705
+ "type" : [ "boolean", "null" ]
1706
+ },
1707
+ "description" : {
1708
+ "type" : [ "string", "null" ],
1709
+ "maxLength" : 150,
1710
+ "minLength" : 0
1711
+ },
1712
+ "title" : {
1713
+ "type" : [ "string", "null" ],
1714
+ "maxLength" : 100,
1715
+ "minLength" : 0
1716
+ }
1717
+ },
1718
+ "required" : [ "description", "keywords", "title", "useTitleAsPageTitle" ]
1719
+ },
1720
+ "topicResponse" : {
1721
+ "type" : [ "object", "null" ],
1722
+ "additionalProperties" : false,
1723
+ "properties" : {
1724
+ "subject" : {
1725
+ "type" : [ "string", "null" ],
1726
+ "maxLength" : 1000,
1727
+ "minLength" : 0,
1728
+ "x-custom-parameters-attributes" : {
1729
+ "removeExif" : false,
1730
+ "replacementString" : "",
1731
+ "filterMatchedContent" : false,
1732
+ "antivirus" : false,
1733
+ "allowInvalid" : false,
1734
+ "descrption" : "",
1735
+ "secret" : false,
1736
+ "preserveCharsLimit" : 10,
1737
+ "trim" : false,
1738
+ "internalParam" : false,
1739
+ "preserveChars" : "0,5",
1740
+ "importUrl" : false,
1741
+ "decrypt" : false
1742
+ }
1743
+ },
1744
+ "isDraft" : {
1745
+ "type" : [ "boolean", "null" ],
1746
+ "x-custom-parameters-attributes" : {
1747
+ "removeExif" : false,
1748
+ "replacementString" : "",
1749
+ "filterMatchedContent" : false,
1750
+ "antivirus" : false,
1751
+ "allowInvalid" : false,
1752
+ "descrption" : "True sets the topic as Draft,False publishes the topic",
1753
+ "secret" : false,
1754
+ "preserveCharsLimit" : 10,
1755
+ "trim" : false,
1756
+ "internalParam" : false,
1757
+ "preserveChars" : "0,5",
1758
+ "importUrl" : false,
1759
+ "decrypt" : false
1760
+ }
1761
+ },
1762
+ "likeCount" : {
1763
+ "type" : [ "string", "null", "integer" ],
1764
+ "format" : "int32",
1765
+ "minimum" : 0,
1766
+ "pattern" : "([0-9]+)"
1767
+ },
1768
+ "type" : {
1769
+ "type" : [ "string", "null" ],
1770
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
1771
+ "maxLength" : 100,
1772
+ "minLength" : 0,
1773
+ "x-custom-parameters-attributes" : {
1774
+ "removeExif" : false,
1775
+ "replacementString" : "",
1776
+ "filterMatchedContent" : false,
1777
+ "antivirus" : false,
1778
+ "allowInvalid" : false,
1779
+ "descrption" : "",
1780
+ "secret" : false,
1781
+ "preserveCharsLimit" : 10,
1782
+ "trim" : false,
1783
+ "internalParam" : false,
1784
+ "preserveChars" : "0,5",
1785
+ "importUrl" : false,
1786
+ "decrypt" : false
1787
+ }
1788
+ },
1789
+ "isSticky" : {
1790
+ "type" : [ "boolean", "null" ]
1791
+ },
1792
+ "content" : {
1793
+ "type" : [ "string", "null" ],
1794
+ "maxLength" : 50000,
1795
+ "minLength" : 0,
1796
+ "x-custom-parameters-attributes" : {
1797
+ "removeExif" : false,
1798
+ "replacementString" : "",
1799
+ "filterMatchedContent" : false,
1800
+ "antivirus" : false,
1801
+ "allowInvalid" : false,
1802
+ "descrption" : "",
1803
+ "secret" : false,
1804
+ "preserveCharsLimit" : 10,
1805
+ "trim" : false,
1806
+ "internalParam" : false,
1807
+ "preserveChars" : "0,5",
1808
+ "xss" : "antisamyfilter_custom",
1809
+ "importUrl" : false,
1810
+ "decrypt" : false
1811
+ }
1812
+ },
1813
+ "isLocked" : {
1814
+ "type" : [ "boolean", "null" ]
1815
+ },
1816
+ "createdTime" : {
1817
+ "type" : [ "string", "null" ],
1818
+ "maxLength" : 100,
1819
+ "minLength" : 0,
1820
+ "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))"
1821
+ },
1822
+ "modifiedBy" : {
1823
+ "$ref" : "./Topic.json#/components/schemas/creator"
1824
+ },
1825
+ "id" : {
1826
+ "type" : [ "string", "null", "integer" ],
1827
+ "format" : "int64",
1828
+ "pattern" : "([0-9]+)"
1829
+ },
1830
+ "tag" : {
1831
+ "$ref" : "./Topic.json#/components/schemas/tag"
1832
+ },
1833
+ "viewCount" : {
1834
+ "type" : [ "string", "null", "integer" ],
1835
+ "format" : "int32",
1836
+ "minimum" : 0,
1837
+ "pattern" : "([0-9]+)"
1838
+ },
1839
+ "seo" : {
1840
+ "$ref" : "./Topic.json#/components/schemas/CommunitySeoResponse"
1841
+ },
1842
+ "creator" : {
1843
+ "$ref" : "./Topic.json#/components/schemas/creator"
1844
+ },
1845
+ "isFollowing" : {
1846
+ "type" : [ "boolean", "null" ]
1847
+ },
1848
+ "ticket" : {
1849
+ "$ref" : "./Topic.json#/components/schemas/ticket"
1850
+ },
1851
+ "label" : {
1852
+ "type" : [ "string", "null" ],
1853
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
1854
+ "maxLength" : 100,
1855
+ "minLength" : 0
1856
+ },
1857
+ "isVoted" : {
1858
+ "type" : [ "boolean", "null" ]
1859
+ },
1860
+ "tags" : {
1861
+ "type" : [ "null", "array" ],
1862
+ "items" : {
1863
+ "type" : [ "string", "null" ],
1864
+ "maxLength" : 200,
1865
+ "minLength" : 0,
1866
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+",
1867
+ "x-custom-parameters-attributes" : [ { } ]
1868
+ },
1869
+ "uniqueItems" : false
1870
+ },
1871
+ "commentCount" : {
1872
+ "type" : [ "string", "null", "integer" ],
1873
+ "format" : "int32",
1874
+ "minimum" : 0,
1875
+ "pattern" : "([0-9]+)"
1876
+ },
1877
+ "featuredImage" : {
1878
+ "$ref" : "./Topic.json#/components/schemas/FeaturedImageResponse"
1879
+ },
1880
+ "webUrl" : {
1881
+ "type" : [ "string", "null" ],
1882
+ "maxLength" : 1000,
1883
+ "minLength" : 0,
1884
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1885
+ },
1886
+ "followersCount" : {
1887
+ "type" : [ "string", "null", "integer" ],
1888
+ "format" : "int32",
1889
+ "minimum" : 0,
1890
+ "pattern" : "([0-9]+)"
1891
+ },
1892
+ "permalink" : {
1893
+ "type" : [ "string", "null" ],
1894
+ "maxLength" : 100,
1895
+ "minLength" : 0,
1896
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
1897
+ },
1898
+ "categoryId" : {
1899
+ "type" : [ "string", "null", "integer" ],
1900
+ "format" : "int64",
1901
+ "pattern" : "([0-9]+)",
1902
+ "x-custom-parameters-attributes" : {
1903
+ "removeExif" : false,
1904
+ "replacementString" : "",
1905
+ "filterMatchedContent" : false,
1906
+ "antivirus" : false,
1907
+ "allowInvalid" : false,
1908
+ "descrption" : "Id of the Category in which Topic is to be posted",
1909
+ "secret" : false,
1910
+ "preserveCharsLimit" : 10,
1911
+ "trim" : false,
1912
+ "internalParam" : false,
1913
+ "preserveChars" : "0,5",
1914
+ "importUrl" : false,
1915
+ "decrypt" : false
1916
+ }
1917
+ },
1918
+ "notifyMe" : {
1919
+ "type" : [ "boolean", "null" ],
1920
+ "x-custom-parameters-attributes" : {
1921
+ "removeExif" : false,
1922
+ "replacementString" : "",
1923
+ "filterMatchedContent" : false,
1924
+ "antivirus" : false,
1925
+ "allowInvalid" : false,
1926
+ "descrption" : "True notifies the author on any activities on the topic",
1927
+ "secret" : false,
1928
+ "preserveCharsLimit" : 10,
1929
+ "trim" : false,
1930
+ "internalParam" : false,
1931
+ "preserveChars" : "0,5",
1932
+ "importUrl" : false,
1933
+ "decrypt" : false
1934
+ }
1935
+ },
1936
+ "status" : {
1937
+ "type" : [ "string", "null" ],
1938
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
1939
+ "maxLength" : 100,
1940
+ "minLength" : 0
1941
+ }
1942
+ },
1943
+ "required" : [ "categoryId", "commentCount", "content", "createdTime", "creator", "featuredImage", "followersCount", "id", "isDraft", "isFollowing", "isLocked", "isSticky", "isVoted", "label", "likeCount", "modifiedBy", "notifyMe", "permalink", "seo", "status", "subject", "tag", "tags", "ticket", "type", "viewCount", "webUrl" ]
1944
+ },
1945
+ "topicTypeWiseCount" : {
1946
+ "type" : [ "object", "null" ],
1947
+ "additionalProperties" : false,
1948
+ "properties" : {
1949
+ "problem" : {
1950
+ "type" : [ "string", "null", "integer" ],
1951
+ "format" : "int32",
1952
+ "minimum" : 0,
1953
+ "pattern" : "([0-9]+)"
1954
+ },
1955
+ "question" : {
1956
+ "type" : [ "string", "null", "integer" ],
1957
+ "format" : "int32",
1958
+ "minimum" : 0,
1959
+ "pattern" : "([0-9]+)"
1960
+ },
1961
+ "idea" : {
1962
+ "type" : [ "string", "null", "integer" ],
1963
+ "format" : "int32",
1964
+ "minimum" : 0,
1965
+ "pattern" : "([0-9]+)"
1966
+ },
1967
+ "discussions" : {
1968
+ "type" : [ "string", "null", "integer" ],
1969
+ "format" : "int32",
1970
+ "minimum" : 0,
1971
+ "pattern" : "([0-9]+)"
1972
+ },
1973
+ "announcement" : {
1974
+ "type" : [ "string", "null", "integer" ],
1975
+ "format" : "int32",
1976
+ "minimum" : 0,
1977
+ "pattern" : "([0-9]+)"
1978
+ }
1979
+ },
1980
+ "required" : [ "announcement", "discussions", "idea", "problem", "question" ]
1981
+ },
1982
+ "topicFollowersDetails" : {
1983
+ "type" : [ "object", "null" ],
1984
+ "additionalProperties" : false,
1985
+ "properties" : {
1986
+ "photoUrl" : {
1987
+ "type" : [ "string", "null" ],
1988
+ "maxLength" : 100,
1989
+ "minLength" : 0,
1990
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1991
+ },
1992
+ "isFollowing" : {
1993
+ "type" : [ "boolean", "null" ]
1994
+ },
1995
+ "name" : {
1996
+ "type" : [ "string", "null" ],
1997
+ "maxLength" : 200,
1998
+ "minLength" : 0,
1999
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2000
+ },
2001
+ "topicTypeWiseCount" : {
2002
+ "$ref" : "./Topic.json#/components/schemas/topicTypeWiseCount"
2003
+ },
2004
+ "id" : {
2005
+ "type" : [ "string", "null", "integer" ],
2006
+ "format" : "int64",
2007
+ "pattern" : "([0-9]+)"
2008
+ },
2009
+ "type" : {
2010
+ "type" : [ "string", "null" ],
2011
+ "enum" : [ "ENDUSER", "SUPPORTREP" ],
2012
+ "maxLength" : 100,
2013
+ "minLength" : 0
2014
+ }
2015
+ },
2016
+ "required" : [ "id", "isFollowing", "name", "photoUrl", "topicTypeWiseCount", "type" ]
2017
+ },
2018
+ "topicFollowersDetailsData" : {
2019
+ "type" : [ "array", "null" ],
2020
+ "items" : {
2021
+ "$ref" : "./Topic.json#/components/schemas/topicFollowersDetails"
2022
+ }
2023
+ },
2024
+ "relatedTopicSearch" : {
2025
+ "type" : [ "object", "null" ],
2026
+ "additionalProperties" : false,
2027
+ "properties" : {
2028
+ "creator" : {
2029
+ "$ref" : "./Topic.json#/components/schemas/creator"
2030
+ },
2031
+ "subject" : {
2032
+ "type" : [ "string", "null" ],
2033
+ "maxLength" : 1000,
2034
+ "minLength" : 0
2035
+ },
2036
+ "createdTime" : {
2037
+ "type" : [ "string", "null" ],
2038
+ "maxLength" : 100,
2039
+ "minLength" : 0,
2040
+ "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))"
2041
+ },
2042
+ "likeCount" : {
2043
+ "type" : [ "string", "null", "integer" ],
2044
+ "format" : "int32",
2045
+ "minimum" : 0,
2046
+ "pattern" : "([0-9]+)"
2047
+ },
2048
+ "id" : {
2049
+ "type" : [ "string", "null", "integer" ],
2050
+ "format" : "int64",
2051
+ "pattern" : "([0-9]+)"
2052
+ },
2053
+ "viewCount" : {
2054
+ "type" : [ "string", "null", "integer" ],
2055
+ "format" : "int32",
2056
+ "minimum" : 0,
2057
+ "pattern" : "([0-9]+)"
2058
+ },
2059
+ "permalink" : {
2060
+ "type" : [ "string", "null" ],
2061
+ "maxLength" : 100,
2062
+ "minLength" : 0,
2063
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2064
+ },
2065
+ "type" : {
2066
+ "type" : [ "string", "null" ],
2067
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
2068
+ "maxLength" : 100,
2069
+ "minLength" : 0
2070
+ },
2071
+ "categoryId" : {
2072
+ "type" : [ "string", "null", "integer" ],
2073
+ "format" : "int64",
2074
+ "pattern" : "([0-9]+)"
2075
+ },
2076
+ "commentCount" : {
2077
+ "type" : [ "string", "null", "integer" ],
2078
+ "format" : "int32",
2079
+ "minimum" : 0,
2080
+ "pattern" : "([0-9]+)"
2081
+ }
2082
+ },
2083
+ "required" : [ "categoryId", "commentCount", "createdTime", "creator", "id", "likeCount", "permalink", "subject", "type", "viewCount" ]
2084
+ },
2085
+ "attachmentDetails" : {
2086
+ "type" : [ "object", "null" ],
2087
+ "additionalProperties" : false,
2088
+ "properties" : {
2089
+ "size" : {
2090
+ "type" : [ "string", "null", "integer" ],
2091
+ "format" : "int64",
2092
+ "pattern" : "([0-9]+)"
2093
+ },
2094
+ "name" : {
2095
+ "type" : [ "string", "null" ],
2096
+ "maxLength" : 100,
2097
+ "minLength" : 0
2098
+ },
2099
+ "id" : {
2100
+ "type" : [ "string", "null", "integer" ],
2101
+ "format" : "int64",
2102
+ "pattern" : "([0-9]+)"
2103
+ }
2104
+ },
2105
+ "required" : [ "id", "name", "size" ]
2106
+ },
2107
+ "attachments" : {
2108
+ "type" : [ "array", "null" ],
2109
+ "items" : {
2110
+ "$ref" : "./Topic.json#/components/schemas/attachmentDetails"
2111
+ }
2112
+ },
2113
+ "getTopicResponse" : {
2114
+ "type" : [ "object", "null" ],
2115
+ "additionalProperties" : false,
2116
+ "properties" : {
2117
+ "subject" : {
2118
+ "type" : [ "string", "null" ],
2119
+ "maxLength" : 1000,
2120
+ "minLength" : 0
2121
+ },
2122
+ "isDraft" : {
2123
+ "type" : [ "boolean", "null" ]
2124
+ },
2125
+ "likeCount" : {
2126
+ "type" : [ "string", "null", "integer" ],
2127
+ "format" : "int32",
2128
+ "minimum" : 0,
2129
+ "pattern" : "([0-9]+)"
2130
+ },
2131
+ "type" : {
2132
+ "type" : [ "string", "null" ],
2133
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
2134
+ "maxLength" : 100,
2135
+ "minLength" : 0
2136
+ },
2137
+ "isSticky" : {
2138
+ "type" : [ "boolean", "null" ]
2139
+ },
2140
+ "bestCommentId" : {
2141
+ "type" : [ "string", "null", "integer" ],
2142
+ "format" : "int64",
2143
+ "pattern" : "([0-9]+)"
2144
+ },
2145
+ "content" : {
2146
+ "type" : [ "string", "null" ],
2147
+ "maxLength" : 50000,
2148
+ "minLength" : 0
2149
+ },
2150
+ "isLocked" : {
2151
+ "type" : [ "boolean", "null" ]
2152
+ },
2153
+ "createdTime" : {
2154
+ "type" : [ "string", "null" ],
2155
+ "maxLength" : 100,
2156
+ "minLength" : 0,
2157
+ "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))"
2158
+ },
2159
+ "modifiedBy" : {
2160
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
2161
+ },
2162
+ "id" : {
2163
+ "type" : [ "string", "null", "integer" ],
2164
+ "format" : "int64",
2165
+ "pattern" : "([0-9]+)"
2166
+ },
2167
+ "tag" : {
2168
+ "$ref" : "./Topic.json#/components/schemas/tag"
2169
+ },
2170
+ "viewCount" : {
2171
+ "type" : [ "string", "null", "integer" ],
2172
+ "format" : "int32",
2173
+ "minimum" : 0,
2174
+ "pattern" : "([0-9]+)"
2175
+ },
2176
+ "seo" : {
2177
+ "$ref" : "./Topic.json#/components/schemas/CommunitySeoResponse"
2178
+ },
2179
+ "creator" : {
2180
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
2181
+ },
2182
+ "isFollowing" : {
2183
+ "type" : [ "boolean", "null" ]
2184
+ },
2185
+ "ticket" : {
2186
+ "$ref" : "./Topic.json#/components/schemas/ticket"
2187
+ },
2188
+ "label" : {
2189
+ "type" : [ "string", "null" ],
2190
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
2191
+ "maxLength" : 100,
2192
+ "minLength" : 0
2193
+ },
2194
+ "isVoted" : {
2195
+ "type" : [ "boolean", "null" ]
2196
+ },
2197
+ "tags" : {
2198
+ "type" : [ "null", "array" ],
2199
+ "items" : {
2200
+ "type" : [ "string", "null" ],
2201
+ "maxLength" : 200,
2202
+ "minLength" : 0,
2203
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+"
2204
+ },
2205
+ "uniqueItems" : false
2206
+ },
2207
+ "commentCount" : {
2208
+ "type" : [ "string", "null", "integer" ],
2209
+ "format" : "int32",
2210
+ "minimum" : 0,
2211
+ "pattern" : "([0-9]+)"
2212
+ },
2213
+ "featuredImage" : {
2214
+ "$ref" : "./Topic.json#/components/schemas/FeaturedImageResponse"
2215
+ },
2216
+ "webUrl" : {
2217
+ "type" : [ "string", "null" ],
2218
+ "maxLength" : 1000,
2219
+ "minLength" : 0,
2220
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2221
+ },
2222
+ "mentions" : {
2223
+ "$ref" : "./Mentions.json#/components/schemas/mentionedObj"
2224
+ },
2225
+ "followersCount" : {
2226
+ "type" : [ "string", "null", "integer" ],
2227
+ "format" : "int32",
2228
+ "minimum" : 0,
2229
+ "pattern" : "([0-9]+)"
2230
+ },
2231
+ "permalink" : {
2232
+ "type" : [ "string", "null" ],
2233
+ "maxLength" : 100,
2234
+ "minLength" : 0,
2235
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+",
2236
+ "x-custom-parameters-attributes" : {
2237
+ "removeExif" : false,
2238
+ "replacementString" : "",
2239
+ "filterMatchedContent" : false,
2240
+ "antivirus" : false,
2241
+ "allowInvalid" : false,
2242
+ "descrption" : "permalink",
2243
+ "secret" : false,
2244
+ "preserveCharsLimit" : 10,
2245
+ "trim" : false,
2246
+ "internalParam" : false,
2247
+ "preserveChars" : "0,5",
2248
+ "importUrl" : false,
2249
+ "decrypt" : false
2250
+ }
2251
+ },
2252
+ "categoryId" : {
2253
+ "type" : [ "string", "null", "integer" ],
2254
+ "format" : "int64",
2255
+ "pattern" : "([0-9]+)"
2256
+ },
2257
+ "notifyMe" : {
2258
+ "type" : [ "boolean", "null" ]
2259
+ },
2260
+ "status" : {
2261
+ "type" : [ "string", "null" ],
2262
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
2263
+ "maxLength" : 100,
2264
+ "minLength" : 0
2265
+ }
2266
+ },
2267
+ "required" : [ "bestCommentId", "categoryId", "commentCount", "content", "createdTime", "creator", "featuredImage", "followersCount", "id", "isDraft", "isFollowing", "isLocked", "isSticky", "isVoted", "label", "likeCount", "mentions", "modifiedBy", "notifyMe", "permalink", "seo", "status", "subject", "tag", "tags", "ticket", "type", "viewCount", "webUrl" ]
2268
+ },
2269
+ "topicsearch" : {
2270
+ "additionalProperties" : false,
2271
+ "allOf" : [ {
2272
+ "$ref" : "./Topic.json#/components/schemas/topicResponse"
2273
+ }, {
2274
+ "type" : [ "object", "null" ],
2275
+ "properties" : {
2276
+ "module" : {
2277
+ "type" : [ "string", "null" ],
2278
+ "maxLength" : 100,
2279
+ "minLength" : 0
2280
+ }
2281
+ },
2282
+ "required" : [ "module" ]
2283
+ } ]
2284
+ },
2285
+ "topicSearchData" : {
2286
+ "type" : [ "array", "null" ],
2287
+ "items" : {
2288
+ "$ref" : "./Topic.json#/components/schemas/topicsearch"
2289
+ }
2290
+ },
2291
+ "myDraftedTopics" : {
2292
+ "type" : [ "object", "null" ],
2293
+ "additionalProperties" : false,
2294
+ "properties" : {
2295
+ "subject" : {
2296
+ "type" : [ "string", "null" ],
2297
+ "maxLength" : 1000,
2298
+ "minLength" : 0
2299
+ },
2300
+ "id" : {
2301
+ "type" : [ "string", "null", "integer" ],
2302
+ "format" : "int64",
2303
+ "pattern" : "([0-9]+)"
2304
+ },
2305
+ "type" : {
2306
+ "type" : [ "string", "null" ],
2307
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
2308
+ "maxLength" : 100,
2309
+ "minLength" : 0
2310
+ }
2311
+ },
2312
+ "required" : [ "id", "subject", "type" ]
2313
+ },
2314
+ "myDraftedTopicsData" : {
2315
+ "type" : [ "array", "null" ],
2316
+ "items" : {
2317
+ "$ref" : "./Topic.json#/components/schemas/myDraftedTopics"
2318
+ }
2319
+ }
2320
+ },
2321
+ "responses" : {
2322
+ "getParticipantsList" : {
2323
+ "description" : "getParticipantsList template definitions",
2324
+ "content" : {
2325
+ "application/json" : {
2326
+ "schema" : {
2327
+ "type" : [ "object", "null" ],
2328
+ "additionalProperties" : false,
2329
+ "properties" : {
2330
+ "data" : {
2331
+ "$ref" : "./Topic.json#/components/schemas/participantsListData"
2332
+ }
2333
+ },
2334
+ "required" : [ "data" ]
2335
+ },
2336
+ "examples" : {
2337
+ "Valid responses Definitions" : {
2338
+ "value" : {
2339
+ "data" : [ {
2340
+ "photoUrl" : null,
2341
+ "name" : "User - 1",
2342
+ "id" : "400001",
2343
+ "label" : {
2344
+ "preferences" : {
2345
+ "shape" : "RECTANGLE",
2346
+ "bgColor" : "#23F123",
2347
+ "textColor" : "#2CA123"
2348
+ },
2349
+ "name" : "Admin",
2350
+ "id" : "6000000158001",
2351
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2352
+ },
2353
+ "type" : "ENDUSER"
2354
+ }, {
2355
+ "photoUrl" : null,
2356
+ "name" : "User - 2",
2357
+ "id" : "400003",
2358
+ "label" : {
2359
+ "preferences" : {
2360
+ "shape" : "RECTANGLE",
2361
+ "bgColor" : "#23F123",
2362
+ "textColor" : "#2CA123"
2363
+ },
2364
+ "name" : "Admin",
2365
+ "id" : "6000000158001",
2366
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2367
+ },
2368
+ "type" : "SUPPORTREP"
2369
+ } ]
2370
+ }
2371
+ }
2372
+ }
2373
+ }
2374
+ },
2375
+ "x-custom-response-attributes" : {
2376
+ "disable-safe-headers" : "[]"
2377
+ }
2378
+ },
2379
+ "listAllTopics" : {
2380
+ "description" : "listAllTopics template definitions",
2381
+ "content" : {
2382
+ "application/json" : {
2383
+ "schema" : {
2384
+ "type" : [ "object", "null" ],
2385
+ "additionalProperties" : false,
2386
+ "properties" : {
2387
+ "data" : {
2388
+ "$ref" : "./Topic.json#/components/schemas/data"
2389
+ },
2390
+ "count" : {
2391
+ "type" : [ "string", "null", "integer" ],
2392
+ "format" : "int32",
2393
+ "pattern" : "([0-9]+)"
2394
+ }
2395
+ },
2396
+ "required" : [ "count", "data" ]
2397
+ },
2398
+ "examples" : {
2399
+ "Valid responses Definitions" : {
2400
+ "value" : {
2401
+ "data" : [ {
2402
+ "creator" : {
2403
+ "photoUrl" : null,
2404
+ "name" : "User - 1",
2405
+ "id" : "4000000008734",
2406
+ "label" : {
2407
+ "preferences" : {
2408
+ "shape" : "RECTANGLE",
2409
+ "bgColor" : "#23F123",
2410
+ "textColor" : "#2CA123"
2411
+ },
2412
+ "name" : "Admin",
2413
+ "id" : "6000000158001",
2414
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2415
+ },
2416
+ "type" : "ENDUSER"
2417
+ },
2418
+ "latestCommentTime" : "2013-11-04T11:21:07.000Z",
2419
+ "subject" : "First Post",
2420
+ "likeCount" : "1",
2421
+ "label" : "ANSWERED",
2422
+ "isVoted" : true,
2423
+ "type" : "QUESTION",
2424
+ "content" : "First Post",
2425
+ "commentCount" : "2",
2426
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2427
+ "lastCommenter" : {
2428
+ "name" : "User - 2",
2429
+ "id" : "4000000008734",
2430
+ "label" : {
2431
+ "preferences" : {
2432
+ "shape" : "RECTANGLE",
2433
+ "bgColor" : "#23F123",
2434
+ "textColor" : "#2CA123"
2435
+ },
2436
+ "name" : "Admin",
2437
+ "id" : "6000000158001",
2438
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2439
+ },
2440
+ "type" : "SUPPORTREP"
2441
+ },
2442
+ "id" : "3000000000059",
2443
+ "permalink" : "first-post",
2444
+ "categoryId" : "3000000000017",
2445
+ "status" : "PUBLISHED"
2446
+ }, {
2447
+ "creator" : {
2448
+ "photoUrl" : null,
2449
+ "name" : "User - 1",
2450
+ "id" : "4000000008734",
2451
+ "label" : {
2452
+ "preferences" : {
2453
+ "shape" : "RECTANGLE",
2454
+ "bgColor" : "#23F123",
2455
+ "textColor" : "#2CA123"
2456
+ },
2457
+ "name" : "Admin",
2458
+ "id" : "6000000158001",
2459
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2460
+ },
2461
+ "type" : "ENDUSER"
2462
+ },
2463
+ "latestCommentTime" : "2013-11-04T11:21:07.000Z",
2464
+ "subject" : "Welcome to Community",
2465
+ "likeCount" : "0",
2466
+ "label" : "NOSTATUS",
2467
+ "isVoted" : true,
2468
+ "type" : "ANNOUNCEMENT",
2469
+ "content" : "<p>The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.",
2470
+ "commentCount" : "0",
2471
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2472
+ "lastCommenter" : {
2473
+ "name" : "User - 2",
2474
+ "id" : "4000000008733",
2475
+ "label" : {
2476
+ "preferences" : {
2477
+ "shape" : "RECTANGLE",
2478
+ "bgColor" : "#23F123",
2479
+ "textColor" : "#2CA123"
2480
+ },
2481
+ "name" : "Admin",
2482
+ "id" : "6000000158001",
2483
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2484
+ },
2485
+ "type" : "SUPPORTREP"
2486
+ },
2487
+ "id" : "3000000000035",
2488
+ "permalink" : "welcome-to-community",
2489
+ "categoryId" : "3000000000017",
2490
+ "status" : "PUBLISHED"
2491
+ } ]
2492
+ }
2493
+ }
2494
+ }
2495
+ }
2496
+ },
2497
+ "x-custom-response-attributes" : {
2498
+ "disable-safe-headers" : "[]"
2499
+ }
2500
+ },
2501
+ "communityPreferences" : {
2502
+ "description" : "communityPreferences template definitions",
2503
+ "content" : {
2504
+ "application/json" : {
2505
+ "schema" : {
2506
+ "type" : [ "object", "null" ],
2507
+ "additionalProperties" : false,
2508
+ "properties" : {
2509
+ "defaultTopicType" : {
2510
+ "type" : [ "string", "null" ],
2511
+ "enum" : [ "DISCUSSION", "ANNOUNCEMENT", "QUESTION", "IDEA", "PROBLEM" ],
2512
+ "maxLength" : 100,
2513
+ "minLength" : 0
2514
+ },
2515
+ "topicTypes" : {
2516
+ "type" : [ "null", "array" ],
2517
+ "items" : {
2518
+ "type" : [ "string", "null" ],
2519
+ "enum" : [ "DISCUSSION", "ANNOUNCEMENT", "QUESTION", "IDEA", "PROBLEM" ],
2520
+ "maxLength" : 100,
2521
+ "minLength" : 0
2522
+ },
2523
+ "uniqueItems" : false
2524
+ },
2525
+ "landingPage" : {
2526
+ "type" : [ "string", "null" ],
2527
+ "enum" : [ "ALLCATEGORY", "RECENTPOST" ],
2528
+ "maxLength" : 100,
2529
+ "minLength" : 0
2530
+ }
2531
+ },
2532
+ "required" : [ "defaultTopicType", "landingPage", "topicTypes" ]
2533
+ },
2534
+ "examples" : {
2535
+ "Valid responses Definitions" : {
2536
+ "value" : {
2537
+ "defaultTopicType" : "QUESTION",
2538
+ "topicTypes" : [ "DISCUSSION", "ANNOUNCEMENT", "QUESTION", "IDEA", "PROBLEM" ],
2539
+ "landingPage" : "RECENTPOST"
2540
+ }
2541
+ }
2542
+ }
2543
+ }
2544
+ },
2545
+ "x-custom-response-attributes" : {
2546
+ "disable-safe-headers" : "[]"
2547
+ }
2548
+ },
2549
+ "communityMyFollowedTopics" : {
2550
+ "description" : "communityMyFollowedTopics template definitions",
2551
+ "content" : {
2552
+ "application/json" : {
2553
+ "schema" : {
2554
+ "type" : [ "object", "null" ],
2555
+ "additionalProperties" : false,
2556
+ "properties" : {
2557
+ "data" : {
2558
+ "$ref" : "./Topic.json#/components/schemas/communityMyFollowedTopicsData"
2559
+ }
2560
+ },
2561
+ "required" : [ "data" ]
2562
+ },
2563
+ "examples" : {
2564
+ "Valid responses Definitions" : {
2565
+ "value" : {
2566
+ "data" : [ {
2567
+ "creator" : {
2568
+ "photoUrl" : null,
2569
+ "name" : "User - 1",
2570
+ "id" : "4000000008734",
2571
+ "label" : {
2572
+ "preferences" : {
2573
+ "shape" : "RECTANGLE",
2574
+ "bgColor" : "#23F123",
2575
+ "textColor" : "#2CA123"
2576
+ },
2577
+ "name" : "Admin",
2578
+ "id" : "6000000158001",
2579
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2580
+ },
2581
+ "type" : "SUPPORTREP"
2582
+ },
2583
+ "subject" : "First Post",
2584
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2585
+ "label" : "ANSWERED",
2586
+ "id" : "3000000000059",
2587
+ "type" : "QUESTION",
2588
+ "permalink" : "first-post",
2589
+ "categoryId" : "3000000000017",
2590
+ "content" : "First Post",
2591
+ "status" : "PUBLISHED"
2592
+ }, {
2593
+ "creator" : {
2594
+ "photoUrl" : null,
2595
+ "name" : "User - 1",
2596
+ "id" : "4000000008734",
2597
+ "label" : {
2598
+ "preferences" : {
2599
+ "shape" : "RECTANGLE",
2600
+ "bgColor" : "#23F123",
2601
+ "textColor" : "#2CA123"
2602
+ },
2603
+ "name" : "Admin",
2604
+ "id" : "6000000158001",
2605
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2606
+ },
2607
+ "type" : "SUPPORTREP"
2608
+ },
2609
+ "subject" : "Welcome to Community",
2610
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2611
+ "label" : "NOSTATUS",
2612
+ "id" : "3000000000035",
2613
+ "type" : "ANNOUNCEMENT",
2614
+ "permalink" : "welcome-to-community",
2615
+ "categoryId" : "3000000000017",
2616
+ "content" : "The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.",
2617
+ "status" : "PUBLISHED"
2618
+ } ]
2619
+ }
2620
+ }
2621
+ }
2622
+ }
2623
+ },
2624
+ "x-custom-response-attributes" : {
2625
+ "disable-safe-headers" : "[]"
2626
+ }
2627
+ },
2628
+ "listAllTopicsWithViewCount" : {
2629
+ "description" : "listAllTopicsWithViewCount template definitions",
2630
+ "content" : {
2631
+ "application/json" : {
2632
+ "schema" : {
2633
+ "type" : [ "object", "null" ],
2634
+ "additionalProperties" : false,
2635
+ "properties" : {
2636
+ "data" : {
2637
+ "$ref" : "./Topic.json#/components/schemas/listTopicData"
2638
+ },
2639
+ "count" : {
2640
+ "type" : [ "string", "null", "integer" ],
2641
+ "format" : "int32",
2642
+ "pattern" : "([0-9]+)"
2643
+ }
2644
+ },
2645
+ "required" : [ "count", "data" ]
2646
+ },
2647
+ "examples" : {
2648
+ "Valid responses Definitions" : {
2649
+ "value" : {
2650
+ "data" : [ {
2651
+ "creator" : {
2652
+ "photoUrl" : null,
2653
+ "name" : "User - 1",
2654
+ "id" : "4000000008734",
2655
+ "label" : {
2656
+ "preferences" : {
2657
+ "shape" : "RECTANGLE",
2658
+ "bgColor" : "#23F123",
2659
+ "textColor" : "#2CA123"
2660
+ },
2661
+ "name" : "Admin",
2662
+ "id" : "6000000158001",
2663
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2664
+ },
2665
+ "type" : "ENDUSER"
2666
+ },
2667
+ "latestCommentTime" : "",
2668
+ "subject" : "First Post",
2669
+ "likeCount" : "1",
2670
+ "label" : "NOSTATUS",
2671
+ "type" : "QUESTION",
2672
+ "content" : "First Post",
2673
+ "commentCount" : "0",
2674
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2675
+ "lastCommenter" : null,
2676
+ "id" : "3000000000059",
2677
+ "viewCount" : "1",
2678
+ "categoryId" : "3000000000017"
2679
+ }, {
2680
+ "creator" : {
2681
+ "photoUrl" : null,
2682
+ "name" : "User - 1",
2683
+ "id" : "4000000008734",
2684
+ "label" : {
2685
+ "preferences" : {
2686
+ "shape" : "RECTANGLE",
2687
+ "bgColor" : "#23F123",
2688
+ "textColor" : "#2CA123"
2689
+ },
2690
+ "name" : "Admin",
2691
+ "id" : "6000000158001",
2692
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2693
+ },
2694
+ "type" : "ENDUSER"
2695
+ },
2696
+ "latestCommentTime" : "",
2697
+ "subject" : "Welcome to Community",
2698
+ "likeCount" : "0",
2699
+ "label" : "NOSTATUS",
2700
+ "type" : "ANNOUNCEMENT",
2701
+ "content" : "<p>The Community hub inside Zoho Desk lets you build a powerful community around your business, while still serving customers via other channels.</p>",
2702
+ "commentCount" : "0",
2703
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2704
+ "lastCommenter" : null,
2705
+ "id" : "3000000000035",
2706
+ "viewCount" : "1",
2707
+ "categoryId" : "3000000000017"
2708
+ } ]
2709
+ }
2710
+ }
2711
+ }
2712
+ }
2713
+ },
2714
+ "x-custom-response-attributes" : {
2715
+ "disable-safe-headers" : "[]"
2716
+ }
2717
+ },
2718
+ "communityPreViewTopicJson" : {
2719
+ "description" : "communityPreViewTopicJson template definitions",
2720
+ "content" : {
2721
+ "application/json" : {
2722
+ "schema" : {
2723
+ "type" : [ "object", "null" ],
2724
+ "additionalProperties" : false,
2725
+ "properties" : {
2726
+ "subject" : {
2727
+ "type" : [ "string", "null" ],
2728
+ "maxLength" : 1000,
2729
+ "minLength" : 0,
2730
+ "x-custom-parameters-attributes" : {
2731
+ "removeExif" : false,
2732
+ "replacementString" : "",
2733
+ "filterMatchedContent" : false,
2734
+ "antivirus" : false,
2735
+ "allowInvalid" : false,
2736
+ "descrption" : "",
2737
+ "secret" : false,
2738
+ "preserveCharsLimit" : 10,
2739
+ "trim" : false,
2740
+ "internalParam" : false,
2741
+ "preserveChars" : "0,5",
2742
+ "importUrl" : false,
2743
+ "decrypt" : false
2744
+ }
2745
+ },
2746
+ "isDraft" : {
2747
+ "type" : [ "boolean", "null" ],
2748
+ "x-custom-parameters-attributes" : {
2749
+ "removeExif" : false,
2750
+ "replacementString" : "",
2751
+ "filterMatchedContent" : false,
2752
+ "antivirus" : false,
2753
+ "allowInvalid" : false,
2754
+ "descrption" : "",
2755
+ "secret" : false,
2756
+ "preserveCharsLimit" : 10,
2757
+ "trim" : false,
2758
+ "internalParam" : false,
2759
+ "preserveChars" : "0,5",
2760
+ "importUrl" : false,
2761
+ "decrypt" : false
2762
+ }
2763
+ },
2764
+ "type" : {
2765
+ "type" : [ "string", "null" ],
2766
+ "enum" : [ "QUESTION", "IDEA", "PROBLEM", "DISCUSSION" ],
2767
+ "maxLength" : 100,
2768
+ "minLength" : 0,
2769
+ "x-custom-parameters-attributes" : {
2770
+ "removeExif" : false,
2771
+ "replacementString" : "",
2772
+ "filterMatchedContent" : false,
2773
+ "antivirus" : false,
2774
+ "allowInvalid" : false,
2775
+ "descrption" : "",
2776
+ "secret" : false,
2777
+ "preserveCharsLimit" : 10,
2778
+ "trim" : false,
2779
+ "internalParam" : false,
2780
+ "preserveChars" : "0,5",
2781
+ "importUrl" : false,
2782
+ "decrypt" : false
2783
+ }
2784
+ },
2785
+ "content" : {
2786
+ "type" : [ "string", "null" ],
2787
+ "maxLength" : 50000,
2788
+ "minLength" : 0,
2789
+ "x-custom-parameters-attributes" : {
2790
+ "removeExif" : false,
2791
+ "replacementString" : "",
2792
+ "filterMatchedContent" : false,
2793
+ "antivirus" : false,
2794
+ "allowInvalid" : false,
2795
+ "descrption" : "",
2796
+ "secret" : false,
2797
+ "preserveCharsLimit" : 10,
2798
+ "trim" : false,
2799
+ "internalParam" : false,
2800
+ "preserveChars" : "0,5",
2801
+ "xss" : "antisamyfilter_custom",
2802
+ "importUrl" : false,
2803
+ "decrypt" : false
2804
+ }
2805
+ },
2806
+ "categoryId" : {
2807
+ "type" : [ "string", "null", "integer" ],
2808
+ "format" : "int64",
2809
+ "pattern" : "([0-9]+)",
2810
+ "x-custom-parameters-attributes" : {
2811
+ "removeExif" : false,
2812
+ "replacementString" : "",
2813
+ "filterMatchedContent" : false,
2814
+ "antivirus" : false,
2815
+ "allowInvalid" : false,
2816
+ "descrption" : "",
2817
+ "secret" : false,
2818
+ "preserveCharsLimit" : 10,
2819
+ "trim" : false,
2820
+ "internalParam" : false,
2821
+ "preserveChars" : "0,5",
2822
+ "importUrl" : false,
2823
+ "decrypt" : false
2824
+ }
2825
+ },
2826
+ "notifyMe" : {
2827
+ "type" : [ "boolean", "null" ],
2828
+ "x-custom-parameters-attributes" : {
2829
+ "removeExif" : false,
2830
+ "replacementString" : "",
2831
+ "filterMatchedContent" : false,
2832
+ "antivirus" : false,
2833
+ "allowInvalid" : false,
2834
+ "descrption" : "",
2835
+ "secret" : false,
2836
+ "preserveCharsLimit" : 10,
2837
+ "trim" : false,
2838
+ "internalParam" : false,
2839
+ "preserveChars" : "0,5",
2840
+ "importUrl" : false,
2841
+ "decrypt" : false
2842
+ }
2843
+ }
2844
+ },
2845
+ "required" : [ "categoryId", "content", "isDraft", "notifyMe", "subject", "type" ]
2846
+ },
2847
+ "examples" : {
2848
+ "Valid responses Definitions" : {
2849
+ "value" : {
2850
+ "subject" : "First Post",
2851
+ "isDraft" : false,
2852
+ "type" : "QUESTION",
2853
+ "categoryId" : "3000000000017",
2854
+ "content" : "First Post",
2855
+ "tags" : [ "Java", "Python" ],
2856
+ "notifyMe" : true
2857
+ }
2858
+ }
2859
+ }
2860
+ }
2861
+ },
2862
+ "x-custom-response-attributes" : {
2863
+ "disable-safe-headers" : "[]"
2864
+ }
2865
+ },
2866
+ "addOrUpdateTopic" : {
2867
+ "description" : "addOrUpdateTopic template definitions",
2868
+ "content" : {
2869
+ "application/json" : {
2870
+ "schema" : {
2871
+ "allOf" : [ {
2872
+ "type" : "object",
2873
+ "properties" : {
2874
+ "attachments" : {
2875
+ "type" : [ "null", "array" ],
2876
+ "items" : {
2877
+ "type" : [ "null", "object" ],
2878
+ "additionalProperties" : false,
2879
+ "maxProperties" : 3,
2880
+ "minProperties" : 3,
2881
+ "properties" : {
2882
+ "size" : {
2883
+ "type" : [ "string", "null", "integer" ],
2884
+ "format" : "int64",
2885
+ "pattern" : "([0-9]+)"
2886
+ },
2887
+ "name" : {
2888
+ "type" : [ "string", "null" ],
2889
+ "maxLength" : 100,
2890
+ "minLength" : 0
2891
+ },
2892
+ "id" : {
2893
+ "type" : [ "string", "null", "integer" ],
2894
+ "format" : "int64",
2895
+ "pattern" : "([0-9]+)"
2896
+ }
2897
+ },
2898
+ "required" : [ "id", "name", "size" ]
2899
+ },
2900
+ "uniqueItems" : false
2901
+ }
2902
+ }
2903
+ }, {
2904
+ "additionalProperties" : false,
2905
+ "allOf" : [ {
2906
+ "$ref" : "./Topic.json#/components/schemas/topicResponse"
2907
+ }, {
2908
+ "type" : [ "object", "null" ],
2909
+ "properties" : {
2910
+ "mentions" : {
2911
+ "$ref" : "./Mentions.json#/components/schemas/mentionedObj"
2912
+ }
2913
+ },
2914
+ "required" : [ "mentions" ]
2915
+ } ]
2916
+ } ]
2917
+ },
2918
+ "examples" : {
2919
+ "Valid responses Definitions" : {
2920
+ "value" : {
2921
+ "creator" : {
2922
+ "photoUrl" : null,
2923
+ "name" : "User - 1",
2924
+ "id" : "4000000008734",
2925
+ "label" : {
2926
+ "preferences" : {
2927
+ "shape" : "RECTANGLE",
2928
+ "bgColor" : "#23F123",
2929
+ "textColor" : "#2CA123"
2930
+ },
2931
+ "name" : "Admin",
2932
+ "id" : "6000000158001",
2933
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
2934
+ },
2935
+ "type" : "ENDUSER"
2936
+ },
2937
+ "attachments" : [ {
2938
+ "size" : "1024",
2939
+ "name" : "New Attachment.jpeg",
2940
+ "id" : "8651"
2941
+ }, {
2942
+ "size" : "1024",
2943
+ "name" : "Sample Attachment.jpeg",
2944
+ "id" : "8661"
2945
+ } ],
2946
+ "isFollowing" : false,
2947
+ "ticket" : {
2948
+ "no" : "105",
2949
+ "id" : "300000006"
2950
+ },
2951
+ "subject" : "First Post",
2952
+ "isDraft" : false,
2953
+ "likeCount" : "0",
2954
+ "label" : "NO STATUS",
2955
+ "isVoted" : false,
2956
+ "type" : "QUESTION",
2957
+ "isSticky" : false,
2958
+ "content" : "First Post",
2959
+ "tags" : [ "Java EE", "Python" ],
2960
+ "commentCount" : "0",
2961
+ "webUrl" : "https://desk.zoho.com/portal/portalname/en/community/topic/first-post",
2962
+ "isLocked" : false,
2963
+ "createdTime" : "2013-11-04T11:21:07.000Z",
2964
+ "id" : "30000000000539",
2965
+ "followersCount" : "0",
2966
+ "tag" : [ {
2967
+ "name" : "Java EE",
2968
+ "permalink" : "java-ee"
2969
+ }, {
2970
+ "name" : "Python",
2971
+ "permalink" : "python"
2972
+ } ],
2973
+ "viewCount" : "1",
2974
+ "permalink" : "first-post",
2975
+ "categoryId" : "3000000000017",
2976
+ "notifyMe" : true
2977
+ }
2978
+ }
2979
+ }
2980
+ }
2981
+ },
2982
+ "x-custom-response-attributes" : {
2983
+ "disable-safe-headers" : "[]"
2984
+ }
2985
+ },
2986
+ "getUserTopics" : {
2987
+ "description" : "getUserTopics template definitions",
2988
+ "content" : {
2989
+ "application/json" : {
2990
+ "schema" : {
2991
+ "type" : [ "object", "null" ],
2992
+ "additionalProperties" : false,
2993
+ "properties" : {
2994
+ "data" : {
2995
+ "$ref" : "./Topic.json#/components/schemas/data"
2996
+ }
2997
+ },
2998
+ "required" : [ "data" ]
2999
+ },
3000
+ "examples" : {
3001
+ "Valid responses Definitions" : {
3002
+ "value" : {
3003
+ "data" : [ {
3004
+ "creator" : {
3005
+ "photoUrl" : null,
3006
+ "name" : "User - 1",
3007
+ "id" : "5000000029005",
3008
+ "label" : {
3009
+ "preferences" : {
3010
+ "shape" : "RECTANGLE",
3011
+ "bgColor" : "#23F123",
3012
+ "textColor" : "#2CA123"
3013
+ },
3014
+ "name" : "Admin",
3015
+ "id" : "6000000158001",
3016
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3017
+ },
3018
+ "type" : "SUPPORTREP"
3019
+ },
3020
+ "latestCommentTime" : "2017-04-06T08:07:42.033Z",
3021
+ "subject" : "(Updated) Posting a new topic through REST API.",
3022
+ "likeCount" : "1",
3023
+ "label" : "NOSTATUS",
3024
+ "type" : "IDEA",
3025
+ "content" : "<div>Posting a new topic through REST API.</div><div>Posting a new topic through REST API.</div>",
3026
+ "commentCount" : "0",
3027
+ "lastCommenter" : {
3028
+ "name" : "User - 2",
3029
+ "id" : "5000000029005",
3030
+ "label" : {
3031
+ "preferences" : {
3032
+ "shape" : "RECTANGLE",
3033
+ "bgColor" : "#23F123",
3034
+ "textColor" : "#2CA123"
3035
+ },
3036
+ "name" : "Admin",
3037
+ "id" : "6000000158001",
3038
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3039
+ },
3040
+ "type" : "ENDUSER"
3041
+ },
3042
+ "createdTime" : "2017-04-06T08:07:39.032Z",
3043
+ "id" : "27000000005038",
3044
+ "permalink" : "posting-a-new-topic-through-rest-api-6-4-2017-3",
3045
+ "categoryId" : "27000000000033"
3046
+ }, {
3047
+ "creator" : {
3048
+ "photoUrl" : null,
3049
+ "name" : "User - 1",
3050
+ "id" : "5000000029005",
3051
+ "label" : {
3052
+ "preferences" : {
3053
+ "shape" : "RECTANGLE",
3054
+ "bgColor" : "#23F123",
3055
+ "textColor" : "#2CA123"
3056
+ },
3057
+ "name" : "Admin",
3058
+ "id" : "6000000158001",
3059
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3060
+ },
3061
+ "type" : "SUPPORTREP"
3062
+ },
3063
+ "latestCommentTime" : "2017-04-06T07:54:47.034Z",
3064
+ "subject" : "(Updated) Posting a new topic through REST API.",
3065
+ "likeCount" : "1",
3066
+ "label" : "NOSTATUS",
3067
+ "type" : "IDEA",
3068
+ "content" : "<div>Posting a new topic through REST API.</div><div>Posting a new topic through REST API.</div>",
3069
+ "commentCount" : "0",
3070
+ "lastCommenter" : {
3071
+ "name" : "User - 2",
3072
+ "id" : "5000000029005",
3073
+ "label" : {
3074
+ "preferences" : {
3075
+ "shape" : "RECTANGLE",
3076
+ "bgColor" : "#23F123",
3077
+ "textColor" : "#2CA123"
3078
+ },
3079
+ "name" : "Admin",
3080
+ "id" : "6000000158001",
3081
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3082
+ },
3083
+ "type" : "ENDUSER"
3084
+ },
3085
+ "createdTime" : "2017-04-06T07:54:45.034Z",
3086
+ "id" : "27000000005016",
3087
+ "permalink" : "posting-a-new-topic-through-rest-api-6-4-2017-1",
3088
+ "categoryId" : "27000000000033"
3089
+ } ]
3090
+ }
3091
+ }
3092
+ }
3093
+ }
3094
+ },
3095
+ "x-custom-response-attributes" : {
3096
+ "disable-safe-headers" : "[]"
3097
+ }
3098
+ },
3099
+ "listAllCommunityTopicFollowers" : {
3100
+ "description" : "listAllCommunityTopicFollowers template definitions",
3101
+ "content" : {
3102
+ "application/json" : {
3103
+ "schema" : {
3104
+ "type" : [ "object", "null" ],
3105
+ "additionalProperties" : false,
3106
+ "properties" : {
3107
+ "data" : {
3108
+ "$ref" : "./Topic.json#/components/schemas/topicFollowersDetailsData"
3109
+ }
3110
+ },
3111
+ "required" : [ "data" ]
3112
+ },
3113
+ "examples" : {
3114
+ "Valid responses Definitions" : {
3115
+ "value" : {
3116
+ "data" : [ {
3117
+ "photoUrl" : null,
3118
+ "isFollowing" : false,
3119
+ "name" : "User - 1",
3120
+ "topicTypeWiseCount" : {
3121
+ "problem" : "3",
3122
+ "question" : "2",
3123
+ "idea" : "1",
3124
+ "announcement" : "4"
3125
+ },
3126
+ "id" : "200000001",
3127
+ "type" : "ENDUSER"
3128
+ }, {
3129
+ "photoUrl" : null,
3130
+ "isFollowing" : false,
3131
+ "name" : "User - 3",
3132
+ "topicTypeWiseCount" : {
3133
+ "problem" : "3",
3134
+ "question" : "2",
3135
+ "idea" : "1",
3136
+ "announcement" : "4"
3137
+ },
3138
+ "id" : "20000002",
3139
+ "type" : "ENDUSER"
3140
+ } ]
3141
+ }
3142
+ }
3143
+ }
3144
+ }
3145
+ },
3146
+ "x-custom-response-attributes" : {
3147
+ "disable-safe-headers" : "[]"
3148
+ }
3149
+ },
3150
+ "getTopicResponse" : {
3151
+ "description" : "getTopicResponse template definitions",
3152
+ "content" : {
3153
+ "application/json" : {
3154
+ "schema" : {
3155
+ "allOf" : [ {
3156
+ "type" : "object",
3157
+ "properties" : {
3158
+ "attachments" : {
3159
+ "type" : [ "null", "array" ],
3160
+ "items" : {
3161
+ "type" : [ "null", "object" ],
3162
+ "additionalProperties" : false,
3163
+ "maxProperties" : 3,
3164
+ "minProperties" : 3,
3165
+ "properties" : {
3166
+ "size" : {
3167
+ "type" : [ "string", "null", "integer" ],
3168
+ "format" : "int64",
3169
+ "pattern" : "([0-9]+)"
3170
+ },
3171
+ "name" : {
3172
+ "type" : [ "string", "null" ],
3173
+ "maxLength" : 100,
3174
+ "minLength" : 0
3175
+ },
3176
+ "id" : {
3177
+ "type" : [ "string", "null", "integer" ],
3178
+ "format" : "int64",
3179
+ "pattern" : "([0-9]+)"
3180
+ }
3181
+ },
3182
+ "required" : [ "id", "name", "size" ]
3183
+ },
3184
+ "uniqueItems" : false
3185
+ }
3186
+ }
3187
+ }, {
3188
+ "type" : [ "object", "null" ],
3189
+ "additionalProperties" : false,
3190
+ "properties" : {
3191
+ "subject" : {
3192
+ "type" : [ "string", "null" ],
3193
+ "maxLength" : 1000,
3194
+ "minLength" : 0
3195
+ },
3196
+ "isDraft" : {
3197
+ "type" : [ "boolean", "null" ]
3198
+ },
3199
+ "likeCount" : {
3200
+ "type" : [ "string", "null", "integer" ],
3201
+ "format" : "int32",
3202
+ "minimum" : 0,
3203
+ "pattern" : "([0-9]+)"
3204
+ },
3205
+ "type" : {
3206
+ "type" : [ "string", "null" ],
3207
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
3208
+ "maxLength" : 100,
3209
+ "minLength" : 0
3210
+ },
3211
+ "isSticky" : {
3212
+ "type" : [ "boolean", "null" ]
3213
+ },
3214
+ "bestCommentId" : {
3215
+ "type" : [ "string", "null", "integer" ],
3216
+ "format" : "int64",
3217
+ "pattern" : "([0-9]+)"
3218
+ },
3219
+ "content" : {
3220
+ "type" : [ "string", "null" ],
3221
+ "maxLength" : 50000,
3222
+ "minLength" : 0
3223
+ },
3224
+ "isLocked" : {
3225
+ "type" : [ "boolean", "null" ]
3226
+ },
3227
+ "createdTime" : {
3228
+ "type" : [ "string", "null" ],
3229
+ "maxLength" : 100,
3230
+ "minLength" : 0,
3231
+ "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))"
3232
+ },
3233
+ "modifiedBy" : {
3234
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
3235
+ },
3236
+ "id" : {
3237
+ "type" : [ "string", "null", "integer" ],
3238
+ "format" : "int64",
3239
+ "pattern" : "([0-9]+)"
3240
+ },
3241
+ "tag" : {
3242
+ "$ref" : "./Topic.json#/components/schemas/tag"
3243
+ },
3244
+ "viewCount" : {
3245
+ "type" : [ "string", "null", "integer" ],
3246
+ "format" : "int32",
3247
+ "minimum" : 0,
3248
+ "pattern" : "([0-9]+)"
3249
+ },
3250
+ "seo" : {
3251
+ "$ref" : "./Topic.json#/components/schemas/CommunitySeoResponse"
3252
+ },
3253
+ "creator" : {
3254
+ "$ref" : "./Topic.json#/components/schemas/creatorWithContactId"
3255
+ },
3256
+ "isFollowing" : {
3257
+ "type" : [ "boolean", "null" ]
3258
+ },
3259
+ "ticket" : {
3260
+ "$ref" : "./Topic.json#/components/schemas/ticket"
3261
+ },
3262
+ "label" : {
3263
+ "type" : [ "string", "null" ],
3264
+ "enum" : [ "NOSTATUS", "NEEDMOREINFO", "WORKINGONIT", "ANSWERED", "UNANSWERED", "MAYBELATER", "UNDERREVIEW", "IMPLEMENTED", "WILLNOTIMPLEMENT", "NOTAPROBLEM", "TEMPORARYFIX", "ANALYZING", "SOLVED", "UNSOLVED", "MOSTVOTED", "INPROGRESS" ],
3265
+ "maxLength" : 100,
3266
+ "minLength" : 0
3267
+ },
3268
+ "isVoted" : {
3269
+ "type" : [ "boolean", "null" ]
3270
+ },
3271
+ "tags" : {
3272
+ "type" : [ "null", "array" ],
3273
+ "items" : {
3274
+ "type" : [ "string", "null" ],
3275
+ "maxLength" : 200,
3276
+ "minLength" : 0,
3277
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+"
3278
+ },
3279
+ "uniqueItems" : false
3280
+ },
3281
+ "commentCount" : {
3282
+ "type" : [ "string", "null", "integer" ],
3283
+ "format" : "int32",
3284
+ "minimum" : 0,
3285
+ "pattern" : "([0-9]+)"
3286
+ },
3287
+ "featuredImage" : {
3288
+ "$ref" : "./Topic.json#/components/schemas/FeaturedImageResponse"
3289
+ },
3290
+ "webUrl" : {
3291
+ "type" : [ "string", "null" ],
3292
+ "maxLength" : 1000,
3293
+ "minLength" : 0,
3294
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3295
+ },
3296
+ "mentions" : {
3297
+ "$ref" : "./Mentions.json#/components/schemas/mentionedObj"
3298
+ },
3299
+ "followersCount" : {
3300
+ "type" : [ "string", "null", "integer" ],
3301
+ "format" : "int32",
3302
+ "minimum" : 0,
3303
+ "pattern" : "([0-9]+)"
3304
+ },
3305
+ "permalink" : {
3306
+ "type" : [ "string", "null" ],
3307
+ "maxLength" : 100,
3308
+ "minLength" : 0,
3309
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
3310
+ },
3311
+ "categoryId" : {
3312
+ "type" : [ "string", "null", "integer" ],
3313
+ "format" : "int64",
3314
+ "pattern" : "([0-9]+)"
3315
+ },
3316
+ "notifyMe" : {
3317
+ "type" : [ "boolean", "null" ]
3318
+ },
3319
+ "status" : {
3320
+ "type" : [ "string", "null" ],
3321
+ "enum" : [ "DRAFT", "PUBLISHED", "SPAM", "AWAITINGAPPROVAL", "TRASHED" ],
3322
+ "maxLength" : 100,
3323
+ "minLength" : 0
3324
+ }
3325
+ },
3326
+ "required" : [ "bestCommentId", "categoryId", "commentCount", "content", "createdTime", "creator", "featuredImage", "followersCount", "id", "isDraft", "isFollowing", "isLocked", "isSticky", "isVoted", "label", "likeCount", "mentions", "modifiedBy", "notifyMe", "permalink", "seo", "status", "subject", "tag", "tags", "ticket", "type", "viewCount", "webUrl" ]
3327
+ } ]
3328
+ },
3329
+ "examples" : {
3330
+ "Valid responses Definitions" : {
3331
+ "value" : {
3332
+ "attachments" : [ {
3333
+ "size" : "1024",
3334
+ "name" : "New Attachment.jpeg",
3335
+ "id" : "8651"
3336
+ }, {
3337
+ "size" : "1024",
3338
+ "name" : "Sample Attachment.jpeg",
3339
+ "id" : "8661"
3340
+ } ],
3341
+ "subject" : "First Post",
3342
+ "isDraft" : false,
3343
+ "likeCount" : "1",
3344
+ "type" : "QUESTION",
3345
+ "isSticky" : true,
3346
+ "content" : "First Post",
3347
+ "bestCommentId" : "3000000254017",
3348
+ "isLocked" : false,
3349
+ "createdTime" : "2013-11-04T11:21:07.000Z",
3350
+ "id" : "3000000000059",
3351
+ "tag" : [ {
3352
+ "name" : "Java EE",
3353
+ "permalink" : "java-ee"
3354
+ }, {
3355
+ "name" : "Python",
3356
+ "permalink" : "python"
3357
+ } ],
3358
+ "viewCount" : "8",
3359
+ "seo" : {
3360
+ "keywords" : "community, topic",
3361
+ "useTitleAsPageTitle" : true,
3362
+ "description" : "community topic seo",
3363
+ "title" : "community topic seo"
3364
+ },
3365
+ "creator" : {
3366
+ "photoUrl" : null,
3367
+ "name" : "User - 1",
3368
+ "id" : "4000000008734",
3369
+ "label" : {
3370
+ "preferences" : {
3371
+ "shape" : "RECTANGLE",
3372
+ "bgColor" : "#23F123",
3373
+ "textColor" : "#2CA123"
3374
+ },
3375
+ "name" : "Admin",
3376
+ "id" : "6000000158001",
3377
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3378
+ },
3379
+ "type" : "ENDUSER"
3380
+ },
3381
+ "isFollowing" : false,
3382
+ "ticket" : {
3383
+ "no" : "103",
3384
+ "id" : "300000003"
3385
+ },
3386
+ "label" : "ANSWERED",
3387
+ "isVoted" : false,
3388
+ "commentCount" : "2",
3389
+ "featuredImage" : {
3390
+ "imageId" : "4000000019009"
3391
+ },
3392
+ "webUrl" : "https://desk.zoho.com/portal/portalname/en/community/topic/first-post",
3393
+ "followersCount" : "0",
3394
+ "permalink" : "first-post",
3395
+ "categoryId" : "3000000000017",
3396
+ "notifyMe" : true,
3397
+ "status" : "PUBLISHED"
3398
+ }
3399
+ }
3400
+ }
3401
+ }
3402
+ },
3403
+ "x-custom-response-attributes" : {
3404
+ "disable-safe-headers" : "[]"
3405
+ }
3406
+ },
3407
+ "relatedTopicSearchResponse" : {
3408
+ "description" : "relatedTopicSearchResponse template definitions",
3409
+ "content" : {
3410
+ "application/json" : {
3411
+ "schema" : {
3412
+ "type" : [ "array", "null" ],
3413
+ "items" : {
3414
+ "$ref" : "./Topic.json#/components/schemas/relatedTopicSearch"
3415
+ }
3416
+ },
3417
+ "examples" : {
3418
+ "Valid responses Definitions" : {
3419
+ "value" : {
3420
+ "creator" : {
3421
+ "photoUrl" : "https://desk.zoho.com/portal/api/user/1310000000033001/photo",
3422
+ "name" : "Zoho User",
3423
+ "id" : "21357000000172003",
3424
+ "label" : {
3425
+ "preferences" : {
3426
+ "shape" : "RECTANGLE",
3427
+ "bgColor" : "#23F123",
3428
+ "textColor" : "#2CA123"
3429
+ },
3430
+ "name" : "Admin",
3431
+ "id" : "6000000158001",
3432
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3433
+ },
3434
+ "type" : "ENDUSER"
3435
+ },
3436
+ "subject" : "Related Topic",
3437
+ "createdTime" : "2018-02-07T07:56:32.277Z",
3438
+ "likeCount" : "1",
3439
+ "id" : "1226000000363014",
3440
+ "viewCount" : "3",
3441
+ "permalink" : "related-topic",
3442
+ "type" : "PROBLEM",
3443
+ "categoryId" : "10628000000007185",
3444
+ "commentCount" : "0"
3445
+ }
3446
+ }
3447
+ }
3448
+ }
3449
+ },
3450
+ "x-custom-response-attributes" : {
3451
+ "disable-safe-headers" : "[]"
3452
+ }
3453
+ },
3454
+ "getTopicByPermalink" : {
3455
+ "description" : "getTopicByPermalink template definitions",
3456
+ "content" : {
3457
+ "application/json" : {
3458
+ "schema" : {
3459
+ "additionalProperties" : false,
3460
+ "allOf" : [ {
3461
+ "$ref" : "./Topic.json#/components/schemas/getTopicResponse"
3462
+ }, {
3463
+ "type" : [ "object", "null" ],
3464
+ "properties" : {
3465
+ "attachments" : {
3466
+ "$ref" : "./Topic.json#/components/schemas/attachments"
3467
+ }
3468
+ },
3469
+ "required" : [ "attachments" ]
3470
+ } ]
3471
+ },
3472
+ "examples" : {
3473
+ "Valid responses Definitions" : {
3474
+ "value" : {
3475
+ "attachments" : [ {
3476
+ "size" : "1024",
3477
+ "name" : "New Attachment.jpeg",
3478
+ "id" : "8651"
3479
+ }, {
3480
+ "size" : "1024",
3481
+ "name" : "Sample Attachment.jpeg",
3482
+ "id" : "8661"
3483
+ } ],
3484
+ "subject" : "First Post",
3485
+ "isDraft" : false,
3486
+ "likeCount" : "1",
3487
+ "type" : "QUESTION",
3488
+ "isSticky" : true,
3489
+ "content" : "First Post",
3490
+ "bestCommentId" : "3000000254017",
3491
+ "isLocked" : false,
3492
+ "createdTime" : "2013-11-04T11:21:07.000Z",
3493
+ "id" : "3000000000059",
3494
+ "tag" : [ {
3495
+ "name" : "Java EE",
3496
+ "permalink" : "java-ee"
3497
+ }, {
3498
+ "name" : "Python",
3499
+ "permalink" : "python"
3500
+ } ],
3501
+ "viewCount" : "8",
3502
+ "seo" : {
3503
+ "keywords" : "community, topic",
3504
+ "useTitleAsPageTitle" : true,
3505
+ "description" : "community topic seo",
3506
+ "title" : "community topic seo"
3507
+ },
3508
+ "creator" : {
3509
+ "photoUrl" : null,
3510
+ "name" : "User - 1",
3511
+ "id" : "4000000008734",
3512
+ "label" : {
3513
+ "preferences" : {
3514
+ "shape" : "RECTANGLE",
3515
+ "bgColor" : "#23F123",
3516
+ "textColor" : "#2CA123"
3517
+ },
3518
+ "name" : "Admin",
3519
+ "id" : "6000000158001",
3520
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3521
+ },
3522
+ "type" : "ENDUSER"
3523
+ },
3524
+ "isFollowing" : false,
3525
+ "ticket" : {
3526
+ "no" : "103",
3527
+ "id" : "300000003"
3528
+ },
3529
+ "label" : "ANSWERED",
3530
+ "isVoted" : false,
3531
+ "tags" : [ "Java EE", "Python" ],
3532
+ "commentCount" : "2",
3533
+ "featuredImage" : {
3534
+ "imageId" : "4000000019009"
3535
+ },
3536
+ "webUrl" : "https://desk.zoho.com/portal/portalname/en/community/topic/first-post",
3537
+ "followersCount" : "0",
3538
+ "permalink" : "first-post",
3539
+ "categoryId" : "3000000000017",
3540
+ "notifyMe" : true
3541
+ }
3542
+ }
3543
+ }
3544
+ }
3545
+ },
3546
+ "x-custom-response-attributes" : {
3547
+ "disable-safe-headers" : "[]"
3548
+ }
3549
+ },
3550
+ "topicSearchResponse" : {
3551
+ "description" : "topicSearchResponse template definitions",
3552
+ "content" : {
3553
+ "application/json" : {
3554
+ "schema" : {
3555
+ "allOf" : [ {
3556
+ "type" : "object",
3557
+ "properties" : {
3558
+ "count" : {
3559
+ "type" : [ "null", "object" ],
3560
+ "additionalProperties" : false,
3561
+ "patternProperties" : {
3562
+ "([0-9]+)" : {
3563
+ "type" : [ "string", "null", "integer" ],
3564
+ "format" : "int32",
3565
+ "pattern" : "([0-9]+)"
3566
+ }
3567
+ }
3568
+ }
3569
+ }
3570
+ }, {
3571
+ "type" : [ "object", "null" ],
3572
+ "additionalProperties" : false,
3573
+ "properties" : {
3574
+ "data" : {
3575
+ "$ref" : "./Topic.json#/components/schemas/topicSearchData"
3576
+ }
3577
+ },
3578
+ "required" : [ "data" ]
3579
+ } ]
3580
+ },
3581
+ "examples" : {
3582
+ "Valid responses Definitions" : {
3583
+ "value" : {
3584
+ "data" : [ {
3585
+ "creator" : {
3586
+ "photoUrl" : "https://desk.zoho.com/portal/api/user/1310000000033001/photo",
3587
+ "name" : "User - 1",
3588
+ "id" : "1310000000033001",
3589
+ "label" : {
3590
+ "preferences" : {
3591
+ "shape" : "RECTANGLE",
3592
+ "bgColor" : "#23F123",
3593
+ "textColor" : "#2CA123"
3594
+ },
3595
+ "name" : "Admin",
3596
+ "id" : "6000000158001",
3597
+ "logoUrl" : "https://desk.zoho.com/portal/api/publicImages/6000000158231?orgId=14132"
3598
+ },
3599
+ "type" : "ENDUSER"
3600
+ },
3601
+ "isFollowing" : false,
3602
+ "ticket" : {
3603
+ "number" : "665",
3604
+ "id" : "1310000001519003"
3605
+ },
3606
+ "subject" : "test123",
3607
+ "module" : "Community",
3608
+ "isDraft" : false,
3609
+ "likeCount" : "2",
3610
+ "label" : "NOSTATUS",
3611
+ "isVoted" : false,
3612
+ "type" : "QUESTION",
3613
+ "isSticky" : false,
3614
+ "content" : "testttttt",
3615
+ "commentCount" : "1",
3616
+ "isLocked" : false,
3617
+ "createdTime" : "2017-10-20T10:06:26.000Z",
3618
+ "tag" : [ ],
3619
+ "id" : "1226000000363014",
3620
+ "viewCount" : "2",
3621
+ "followersCount" : "0",
3622
+ "permalink" : "test123",
3623
+ "categoryId" : "1226000000121007",
3624
+ "status" : "PUBLISHED",
3625
+ "notifyMe" : true
3626
+ } ]
3627
+ }
3628
+ }
3629
+ }
3630
+ }
3631
+ },
3632
+ "x-custom-response-attributes" : {
3633
+ "disable-safe-headers" : "[]"
3634
+ }
3635
+ },
3636
+ "myDraftedTopicsResponse" : {
3637
+ "description" : "myDraftedTopicsResponse template definitions",
3638
+ "content" : {
3639
+ "application/json" : {
3640
+ "schema" : {
3641
+ "type" : [ "object", "null" ],
3642
+ "additionalProperties" : false,
3643
+ "properties" : {
3644
+ "data" : {
3645
+ "$ref" : "./Topic.json#/components/schemas/myDraftedTopicsData"
3646
+ },
3647
+ "count" : {
3648
+ "type" : [ "string", "null", "integer" ],
3649
+ "format" : "int32",
3650
+ "pattern" : "([0-9]+)"
3651
+ }
3652
+ },
3653
+ "required" : [ "count", "data" ]
3654
+ },
3655
+ "examples" : {
3656
+ "Valid responses Definitions" : {
3657
+ "value" : {
3658
+ "data" : [ {
3659
+ "name" : "API not working",
3660
+ "id" : "101",
3661
+ "type" : "PROBLEM"
3662
+ }, {
3663
+ "name" : "How to tackle React Team",
3664
+ "id" : "102",
3665
+ "type" : "QUESTION"
3666
+ } ],
3667
+ "count" : "2"
3668
+ }
3669
+ }
3670
+ }
3671
+ }
3672
+ },
3673
+ "x-custom-response-attributes" : {
3674
+ "disable-safe-headers" : "[]"
3675
+ }
3676
+ }
3677
+ },
3678
+ "parameters" : {
3679
+ "topicId" : {
3680
+ "name" : "topicId",
3681
+ "in" : "path",
3682
+ "required" : true,
3683
+ "style" : "simple",
3684
+ "explode" : false,
3685
+ "schema" : {
3686
+ "type" : [ "string", "null", "integer" ],
3687
+ "format" : "int64",
3688
+ "pattern" : "([0-9]+)"
3689
+ }
3690
+ },
3691
+ "isDescending" : {
3692
+ "name" : "isDescending",
3693
+ "in" : "query",
3694
+ "description" : "Sort list of topics by Ascending or Descending",
3695
+ "required" : false,
3696
+ "style" : "form",
3697
+ "explode" : true,
3698
+ "schema" : {
3699
+ "type" : [ "boolean", "null" ],
3700
+ "description" : "Sort list of topics by Ascending or Descending"
3701
+ }
3702
+ },
3703
+ "limit" : {
3704
+ "name" : "limit",
3705
+ "in" : "query",
3706
+ "description" : "limit",
3707
+ "required" : false,
3708
+ "style" : "form",
3709
+ "explode" : true,
3710
+ "schema" : {
3711
+ "type" : [ "string", "null", "integer" ],
3712
+ "format" : "int32",
3713
+ "description" : "limit",
3714
+ "maximum" : 100,
3715
+ "minimum" : 1,
3716
+ "pattern" : "([0-9]+)"
3717
+ }
3718
+ },
3719
+ "from" : {
3720
+ "name" : "from",
3721
+ "in" : "query",
3722
+ "description" : "Index from which list is retrieved and it starts from 1",
3723
+ "required" : false,
3724
+ "style" : "form",
3725
+ "explode" : true,
3726
+ "schema" : {
3727
+ "type" : [ "string", "null", "integer" ],
3728
+ "format" : "int32",
3729
+ "description" : "Index from which list is retrieved and it starts from 1",
3730
+ "minimum" : 0,
3731
+ "pattern" : "([0-9]+)"
3732
+ }
3733
+ },
3734
+ "includeCount" : {
3735
+ "name" : "includeCount",
3736
+ "in" : "query",
3737
+ "description" : "includes count on true",
3738
+ "required" : false,
3739
+ "style" : "form",
3740
+ "explode" : true,
3741
+ "schema" : {
3742
+ "type" : [ "boolean", "null" ],
3743
+ "description" : "includes count on true"
3744
+ }
3745
+ },
3746
+ "type" : {
3747
+ "name" : "type",
3748
+ "in" : "query",
3749
+ "description" : "Topic Type - Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION ",
3750
+ "required" : false,
3751
+ "style" : "form",
3752
+ "explode" : true,
3753
+ "schema" : {
3754
+ "type" : [ "string", "null" ],
3755
+ "description" : "Topic Type - Value can be QUESTION,IDEA,ANNOUNCEMENT,PROBLEM or DISCUSSION ",
3756
+ "enum" : [ "QUESTION", "IDEA", "ANNOUNCEMENT", "PROBLEM", "DISCUSSION" ],
3757
+ "maxLength" : 100,
3758
+ "minLength" : 0
3759
+ }
3760
+ },
3761
+ "searchKeyWordMatch" : {
3762
+ "name" : "searchKeyWordMatch",
3763
+ "in" : "query",
3764
+ "description" : "Specifies how multiple search keywords should be matched when filtering results. Allowed values @ANY@, @ALL@. ~ANY~ : Returns results that match any one of the provided keywords (OR condition). ~ALL~ : Returns results that match all of the provided keywords (AND condition).",
3765
+ "required" : false,
3766
+ "style" : "form",
3767
+ "explode" : true,
3768
+ "schema" : {
3769
+ "type" : [ "string", "null" ],
3770
+ "description" : "Specifies how multiple search keywords should be matched when filtering results. Allowed values @ANY@, @ALL@. ~ANY~ : Returns results that match any one of the provided keywords (OR condition). ~ALL~ : Returns results that match all of the provided keywords (AND condition).",
3771
+ "enum" : [ "ANY", "ALL" ],
3772
+ "maxLength" : 100,
3773
+ "minLength" : 0
3774
+ }
3775
+ },
3776
+ "isSticky" : {
3777
+ "name" : "isSticky",
3778
+ "in" : "query",
3779
+ "description" : "True retrives sticky posts",
3780
+ "required" : false,
3781
+ "style" : "form",
3782
+ "explode" : true,
3783
+ "schema" : {
3784
+ "type" : [ "boolean", "null" ],
3785
+ "description" : "True retrives sticky posts"
3786
+ }
3787
+ },
3788
+ "categoryId" : {
3789
+ "name" : "categoryId",
3790
+ "in" : "query",
3791
+ "description" : "Id of category from which topics are to be retrieved",
3792
+ "required" : false,
3793
+ "style" : "form",
3794
+ "explode" : true,
3795
+ "schema" : {
3796
+ "type" : [ "string", "null", "integer" ],
3797
+ "format" : "int64",
3798
+ "description" : "Id of category from which topics are to be retrieved",
3799
+ "pattern" : "([0-9]+)"
3800
+ }
3801
+ },
3802
+ "categoryIdMultiple" : {
3803
+ "name" : "categoryId",
3804
+ "in" : "query",
3805
+ "description" : "Id or comma-separated Ids of categories from which topics are to be retrieved",
3806
+ "required" : false,
3807
+ "style" : "simple",
3808
+ "explode" : true,
3809
+ "schema" : {
3810
+ "type" : [ "array" ],
3811
+ "description" : "Id or comma-separated Ids of categories from which topics are to be retrieved",
3812
+ "items" : {
3813
+ "type" : [ "integer" ],
3814
+ "format" : "int64",
3815
+ "pattern" : "([0-9]+)"
3816
+ },
3817
+ "uniqueItems" : true
3818
+ }
3819
+ }
3820
+ },
3821
+ "requestBodies" : {
3822
+ "communityPreViewTopicJson" : {
3823
+ "content" : {
3824
+ "application/json" : {
3825
+ "schema" : {
3826
+ "type" : [ "object", "null" ],
3827
+ "additionalProperties" : false,
3828
+ "properties" : {
3829
+ "subject" : {
3830
+ "type" : [ "string", "null" ],
3831
+ "description" : "",
3832
+ "maxLength" : 1000,
3833
+ "minLength" : 0
3834
+ },
3835
+ "isDraft" : {
3836
+ "type" : [ "boolean", "null" ],
3837
+ "description" : ""
3838
+ },
3839
+ "type" : {
3840
+ "type" : [ "string", "null" ],
3841
+ "description" : "",
3842
+ "enum" : [ "QUESTION", "IDEA", "PROBLEM", "DISCUSSION" ],
3843
+ "maxLength" : 100,
3844
+ "minLength" : 0
3845
+ },
3846
+ "content" : {
3847
+ "type" : [ "string", "null" ],
3848
+ "description" : "",
3849
+ "maxLength" : 50000,
3850
+ "minLength" : 0,
3851
+ "x-custom-parameters-attributes" : {
3852
+ "xss" : "antisamyfilter_custom"
3853
+ }
3854
+ },
3855
+ "categoryId" : {
3856
+ "type" : [ "string", "null", "integer" ],
3857
+ "format" : "int64",
3858
+ "description" : "",
3859
+ "pattern" : "([0-9]+)"
3860
+ },
3861
+ "notifyMe" : {
3862
+ "type" : [ "boolean", "null" ],
3863
+ "description" : ""
3864
+ }
3865
+ },
3866
+ "required" : [ "categoryId", "content", "isDraft", "notifyMe", "subject", "type" ]
3867
+ },
3868
+ "examples" : {
3869
+ "Valid requestBody Definitions" : {
3870
+ "value" : {
3871
+ "subject" : "First Post",
3872
+ "isDraft" : false,
3873
+ "type" : "QUESTION",
3874
+ "content" : "First Post",
3875
+ "categoryId" : "3000000000033",
3876
+ "notifyMe" : true,
3877
+ "tags" : [ "Java", "Python" ]
3878
+ }
3879
+ }
3880
+ }
3881
+ }
3882
+ },
3883
+ "x-custom-request-body-attributes" : {
3884
+ "non-empty" : false,
3885
+ "allow-invalid" : false
3886
+ }
3887
+ },
3888
+ "communityUpdateTopicJson" : {
3889
+ "content" : {
3890
+ "application/json" : {
3891
+ "schema" : {
3892
+ "type" : [ "object", "null" ],
3893
+ "additionalProperties" : false,
3894
+ "properties" : {
3895
+ "subject" : {
3896
+ "type" : [ "string", "null" ],
3897
+ "description" : "",
3898
+ "maxLength" : 1000,
3899
+ "minLength" : 0
3900
+ },
3901
+ "isDraft" : {
3902
+ "type" : [ "boolean", "null" ],
3903
+ "description" : "True sets the topic as Draft,False publishes the topic"
3904
+ },
3905
+ "attachmentIds" : {
3906
+ "type" : [ "null", "array" ],
3907
+ "items" : {
3908
+ "type" : [ "string", "null", "integer" ],
3909
+ "format" : "int64",
3910
+ "pattern" : "([0-9]+)",
3911
+ "x-custom-parameters-attributes" : [ { } ]
3912
+ },
3913
+ "uniqueItems" : false
3914
+ },
3915
+ "type" : {
3916
+ "type" : [ "string", "null" ],
3917
+ "description" : "",
3918
+ "enum" : [ "QUESTION", "IDEA", "PROBLEM", "DISCUSSION" ],
3919
+ "maxLength" : 100,
3920
+ "minLength" : 0
3921
+ },
3922
+ "content" : {
3923
+ "type" : [ "string", "null" ],
3924
+ "description" : "",
3925
+ "maxLength" : 50000,
3926
+ "minLength" : 0,
3927
+ "x-custom-parameters-attributes" : {
3928
+ "xss" : "antisamyfilter_custom"
3929
+ }
3930
+ },
3931
+ "notifyMe" : {
3932
+ "type" : [ "boolean", "null" ],
3933
+ "description" : "True notifies the author on any activities on the topic"
3934
+ },
3935
+ "tags" : {
3936
+ "type" : [ "null", "array" ],
3937
+ "items" : {
3938
+ "type" : [ "string", "null" ],
3939
+ "maxLength" : 200,
3940
+ "minLength" : 0,
3941
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+",
3942
+ "x-custom-parameters-attributes" : [ { } ]
3943
+ },
3944
+ "uniqueItems" : false
3945
+ },
3946
+ "notifyMentions" : {
3947
+ "type" : [ "boolean", "null" ],
3948
+ "description" : "whether to notify mentioned user while updateing content."
3949
+ }
3950
+ },
3951
+ "required" : [ "content", "subject", "type" ]
3952
+ },
3953
+ "examples" : {
3954
+ "Valid requestBody Definitions" : {
3955
+ "value" : {
3956
+ "subject" : "First Post",
3957
+ "isDraft" : false,
3958
+ "attachmentIds" : [ "8651", "8661" ],
3959
+ "type" : "QUESTION",
3960
+ "content" : "First Post",
3961
+ "categoryId" : "3000000000017",
3962
+ "tags" : [ "Java", "Python" ],
3963
+ "notifyMe" : true
3964
+ }
3965
+ }
3966
+ }
3967
+ }
3968
+ },
3969
+ "x-custom-request-body-attributes" : {
3970
+ "non-empty" : false,
3971
+ "allow-invalid" : false
3972
+ }
3973
+ },
3974
+ "communityAddTopicJson" : {
3975
+ "content" : {
3976
+ "application/json" : {
3977
+ "schema" : {
3978
+ "type" : [ "object", "null" ],
3979
+ "additionalProperties" : false,
3980
+ "properties" : {
3981
+ "subject" : {
3982
+ "type" : [ "string", "null" ],
3983
+ "description" : "",
3984
+ "maxLength" : 1000,
3985
+ "minLength" : 0
3986
+ },
3987
+ "isDraft" : {
3988
+ "type" : [ "boolean", "null" ],
3989
+ "description" : ""
3990
+ },
3991
+ "attachmentIds" : {
3992
+ "type" : [ "null", "array" ],
3993
+ "items" : {
3994
+ "type" : [ "string", "null", "integer" ],
3995
+ "format" : "int64",
3996
+ "pattern" : "([0-9]+)",
3997
+ "x-custom-parameters-attributes" : [ { } ]
3998
+ },
3999
+ "uniqueItems" : false
4000
+ },
4001
+ "type" : {
4002
+ "type" : [ "string", "null" ],
4003
+ "description" : "",
4004
+ "enum" : [ "QUESTION", "IDEA", "PROBLEM", "DISCUSSION" ],
4005
+ "maxLength" : 100,
4006
+ "minLength" : 0
4007
+ },
4008
+ "content" : {
4009
+ "type" : [ "string", "null" ],
4010
+ "description" : "",
4011
+ "maxLength" : 50000,
4012
+ "minLength" : 0,
4013
+ "x-custom-parameters-attributes" : {
4014
+ "xss" : "antisamyfilter_custom"
4015
+ }
4016
+ },
4017
+ "categoryId" : {
4018
+ "type" : [ "string", "null", "integer" ],
4019
+ "format" : "int64",
4020
+ "description" : "",
4021
+ "pattern" : "([0-9]+)"
4022
+ },
4023
+ "notifyMe" : {
4024
+ "type" : [ "boolean", "null" ],
4025
+ "description" : ""
4026
+ },
4027
+ "tags" : {
4028
+ "type" : [ "null", "array" ],
4029
+ "items" : {
4030
+ "type" : [ "string", "null" ],
4031
+ "maxLength" : 200,
4032
+ "minLength" : 0,
4033
+ "pattern" : "[A-Za-z0-9\\P{InBasicLatin}]+",
4034
+ "x-custom-parameters-attributes" : [ { } ]
4035
+ },
4036
+ "uniqueItems" : false
4037
+ }
4038
+ },
4039
+ "required" : [ "categoryId", "content", "subject", "type" ]
4040
+ },
4041
+ "examples" : {
4042
+ "Valid requestBody Definitions" : {
4043
+ "value" : {
4044
+ "subject" : "First Post",
4045
+ "isDraft" : false,
4046
+ "attachmentIds" : [ "8651", "8661" ],
4047
+ "type" : "QUESTION",
4048
+ "content" : "First Post",
4049
+ "categoryId" : "3000000000017",
4050
+ "tags" : [ "Java", "Python" ],
4051
+ "notifyMe" : true
4052
+ }
4053
+ }
4054
+ }
4055
+ }
4056
+ },
4057
+ "x-custom-request-body-attributes" : {
4058
+ "non-empty" : false,
4059
+ "allow-invalid" : false
4060
+ }
4061
+ }
4062
+ },
4063
+ "securitySchemes" : {
4064
+ "cookie-auth" : {
4065
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
4066
+ },
4067
+ "org-oauth" : {
4068
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
4069
+ },
4070
+ "jwt-oauth" : {
4071
+ "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
4072
+ },
4073
+ "iam-oauth2-schema" : {
4074
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
4075
+ }
4076
+ }
4077
+ },
4078
+ "x-entity" : "Topic"
4079
+ }