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,3766 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Solution",
5
+ "version" : "1.0.0"
6
+ },
7
+ "paths" : {
8
+ "/portal/api/kbArticles/{entityId}/comments" : {
9
+ "get" : {
10
+ "tags" : [ "Solution" ],
11
+ "operationId" : "articleComments",
12
+ "parameters" : [ {
13
+ "$ref" : "#/components/parameters/limit"
14
+ }, {
15
+ "$ref" : "#/components/parameters/from"
16
+ }, {
17
+ "name" : "sortBy",
18
+ "in" : "query",
19
+ "description" : "sKey that sorts comments by the commentedTime attribute. The default sorting order is ascending. A '-' prefix denotes a descending order of sorting.",
20
+ "required" : false,
21
+ "style" : "form",
22
+ "explode" : true,
23
+ "schema" : {
24
+ "type" : [ "string", "null" ],
25
+ "description" : "sKey that sorts comments by the commentedTime attribute. The default sorting order is ascending. A '-' prefix denotes a descending order of sorting.",
26
+ "maxLength" : 100,
27
+ "minLength" : 0,
28
+ "pattern" : "-?(commentedTime)"
29
+ }
30
+ }, {
31
+ "$ref" : "#/components/parameters/entityId"
32
+ }, {
33
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
34
+ } ],
35
+ "responses" : {
36
+ "422" : {
37
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
38
+ },
39
+ "204" : {
40
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
41
+ },
42
+ "200" : {
43
+ "$ref" : "./ArticleComment.json#/components/responses/listArticleComments"
44
+ }
45
+ },
46
+ "security" : [ {
47
+ "jwt-oauth" : [ "jwt-oauth" ]
48
+ } ],
49
+ "x-audience" : [ "external-public" ],
50
+ "x-custom-url-attribute" : {
51
+ "security" : {
52
+ "throttle" : {
53
+ "inline" : [ {
54
+ "scope" : "APPSERVER",
55
+ "rules" : [ {
56
+ "duration" : 60000,
57
+ "lock-period" : 600000,
58
+ "threshold" : 30,
59
+ "hip" : false
60
+ } ],
61
+ "window" : "ROLLING",
62
+ "key" : "url.path+user.zuid"
63
+ } ]
64
+ },
65
+ "extraparams" : {
66
+ "disable" : true,
67
+ "ignore" : false
68
+ },
69
+ "authentication" : { }
70
+ },
71
+ "apimethod" : "com.zoho.desk.helpcenter.ticket.CommentService.getArticleComments"
72
+ }
73
+ }
74
+ },
75
+ "/portal/api/kbArticles/{id}/locale/{locale}/relatedArticles" : {
76
+ "get" : {
77
+ "tags" : [ "Solution" ],
78
+ "summary" : "Search related articles with locale",
79
+ "description" : "To get a list of related articles",
80
+ "operationId" : "searchRelatedArticlesForTranslation",
81
+ "parameters" : [ {
82
+ "name" : "include",
83
+ "in" : "query",
84
+ "description" : "Extra info to be included. Allowed values : parentCategories",
85
+ "required" : false,
86
+ "style" : "simple",
87
+ "explode" : true,
88
+ "schema" : {
89
+ "type" : [ "null", "array" ],
90
+ "description" : "Extra info to be included. Allowed values : parentCategories",
91
+ "items" : {
92
+ "type" : [ "string", "null" ],
93
+ "enum" : [ "parentCategories" ],
94
+ "maxLength" : 100,
95
+ "minLength" : 0,
96
+ "x-custom-parameters-attributes" : [ ]
97
+ },
98
+ "uniqueItems" : true,
99
+ "x-audience" : [ "company-internal" ]
100
+ }
101
+ }, {
102
+ "$ref" : "#/components/parameters/limit"
103
+ }, {
104
+ "$ref" : "#/components/parameters/id"
105
+ }, {
106
+ "$ref" : "#/components/parameters/locale"
107
+ }, {
108
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
109
+ }, {
110
+ "$ref" : "#/components/parameters/rootCategoryId"
111
+ },{
112
+ "$ref" : "#/components/parameters/categoryId"
113
+ }],
114
+ "responses" : {
115
+ "200" : {
116
+ "$ref" : "#/components/responses/articleListResponse"
117
+ }
118
+ },
119
+ "security" : [ {
120
+ "jwt-oauth" : [ "jwt-oauth" ]
121
+ } ],
122
+ "x-audience" : [ "external-public" ],
123
+ "x-custom-url-attribute" : {
124
+ "security" : {
125
+ "throttle" : {
126
+ "inline" : [ {
127
+ "scope" : "APPSERVER",
128
+ "rules" : [ {
129
+ "duration" : 60000,
130
+ "lock-period" : 300000,
131
+ "threshold" : 100,
132
+ "hip" : false
133
+ }, {
134
+ "duration" : 3600000,
135
+ "lock-period" : 900000,
136
+ "threshold" : 300,
137
+ "hip" : false
138
+ } ],
139
+ "window" : "ROLLING",
140
+ "key" : "url.path+user.remoteip"
141
+ } ]
142
+ },
143
+ "extraparams" : {
144
+ "disable" : true,
145
+ "ignore" : false
146
+ },
147
+ "authentication" : { }
148
+ },
149
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.relatedArticles"
150
+ }
151
+ }
152
+ },
153
+ "/portal/api/kbArticles/{id}/feedbacks" : {
154
+ "post" : {
155
+ "tags" : [ "Solution" ],
156
+ "operationId" : "createArticlesFeedback",
157
+ "parameters" : [ {
158
+ "$ref" : "#/components/parameters/id"
159
+ }, {
160
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
161
+ } ],
162
+ "requestBody" : {
163
+ "$ref" : "#/components/requestBodies/feedback_portal"
164
+ },
165
+ "responses" : {
166
+ "422" : {
167
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
168
+ },
169
+ "204" : {
170
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
171
+ }
172
+ },
173
+ "security" : [ {
174
+ "jwt-oauth" : [ "jwt-oauth" ]
175
+ } ],
176
+ "x-audience" : [ "external-public" ],
177
+ "x-custom-url-attribute" : {
178
+ "security" : {
179
+ "throttle" : {
180
+ "policy" : "SubEntityCreate_Policy"
181
+ },
182
+ "extraparams" : {
183
+ "disable" : true,
184
+ "ignore" : false
185
+ },
186
+ "authentication" : { }
187
+ },
188
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.addFeedback"
189
+ }
190
+ }
191
+ },
192
+ "/portal/api/kbArticles/{id}/locale/{locale}/like" : {
193
+ "post" : {
194
+ "tags" : [ "Solution" ],
195
+ "summary" : "Like article",
196
+ "description" : "This API records a like (positive reaction) on an article.",
197
+ "operationId" : "updateArticleTranslationLikeCount",
198
+ "parameters" : [ {
199
+ "$ref" : "#/components/parameters/id"
200
+ }, {
201
+ "$ref" : "#/components/parameters/locale"
202
+ }, {
203
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
204
+ } ],
205
+ "responses" : {
206
+ "204" : {
207
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
208
+ }
209
+ },
210
+ "security" : [ {
211
+ "jwt-oauth" : [ "jwt-oauth" ]
212
+ } ],
213
+ "x-audience" : [ "external-public" ],
214
+ "x-custom-url-attribute" : {
215
+ "security" : {
216
+ "throttle" : {
217
+ "policy" : "UserReaction_Policy"
218
+ },
219
+ "extraparams" : {
220
+ "disable" : true,
221
+ "ignore" : false
222
+ },
223
+ "authentication" : { }
224
+ },
225
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.likeArticle"
226
+ }
227
+ }
228
+ },
229
+ "/portal/api/kbArticles/{id}" : {
230
+ "get" : {
231
+ "tags" : [ "Solution" ],
232
+ "summary" : "Get article",
233
+ "description" : "This API fetches a single help article from the knowledge base.",
234
+ "operationId" : "retriveAnArticle",
235
+ "parameters" : [ {
236
+ "name" : "include",
237
+ "in" : "query",
238
+ "description" : "Extra info to be included. Allowed values : parentCategories",
239
+ "required" : false,
240
+ "style" : "simple",
241
+ "explode" : true,
242
+ "schema" : {
243
+ "type" : [ "null", "array" ],
244
+ "description" : "Extra info to be included. Allowed values : parentCategories",
245
+ "items" : {
246
+ "type" : [ "string", "null" ],
247
+ "enum" : [ "parentCategories" ],
248
+ "maxLength" : 100,
249
+ "minLength" : 0,
250
+ "x-custom-parameters-attributes" : [ ]
251
+ },
252
+ "uniqueItems" : true,
253
+ "x-audience" : [ "company-internal" ]
254
+ }
255
+ }, {
256
+ "$ref" : "#/components/parameters/id"
257
+ }, {
258
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
259
+ } ],
260
+ "responses" : {
261
+ "200" : {
262
+ "$ref" : "#/components/responses/retriveAnArticleResponse"
263
+ }
264
+ },
265
+ "security" : [ {
266
+ "jwt-oauth" : [ "jwt-oauth" ]
267
+ } ],
268
+ "x-audience" : [ "external-public" ],
269
+ "x-custom-url-attribute" : {
270
+ "security" : {
271
+ "throttle" : {
272
+ "inline" : [ {
273
+ "scope" : "APPSERVER",
274
+ "rules" : [ {
275
+ "duration" : 60000,
276
+ "lock-period" : 300000,
277
+ "threshold" : 100,
278
+ "hip" : false
279
+ }, {
280
+ "duration" : 3600000,
281
+ "lock-period" : 900000,
282
+ "threshold" : 300,
283
+ "hip" : false
284
+ } ],
285
+ "window" : "ROLLING",
286
+ "key" : "url.path+user.remoteip"
287
+ } ]
288
+ },
289
+ "extraparams" : {
290
+ "disable" : true,
291
+ "ignore" : false
292
+ },
293
+ "authentication" : { }
294
+ },
295
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticleWithoutLocale"
296
+ }
297
+ }
298
+ },
299
+ "/portal/api/kbArticles/{entityId}/comments/{commentId}" : {
300
+ "get" : {
301
+ "tags" : [ "Solution" ],
302
+ "operationId" : "articleCommentsById",
303
+ "parameters" : [ {
304
+ "name" : "commentId",
305
+ "in" : "path",
306
+ "required" : true,
307
+ "style" : "simple",
308
+ "explode" : false,
309
+ "schema" : {
310
+ "type" : [ "string", "null", "integer" ],
311
+ "format" : "int64",
312
+ "pattern" : "([0-9]+)"
313
+ }
314
+ }, {
315
+ "$ref" : "#/components/parameters/entityId"
316
+ }, {
317
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
318
+ } ],
319
+ "responses" : {
320
+ "204" : {
321
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
322
+ },
323
+ "200" : {
324
+ "$ref" : "./TicketComment.json#/components/responses/articleCommentResponse"
325
+ }
326
+ },
327
+ "security" : [ {
328
+ "jwt-oauth" : [ "jwt-oauth" ]
329
+ } ],
330
+ "x-audience" : [ "external-public" ],
331
+ "x-custom-url-attribute" : {
332
+ "security" : {
333
+ "throttle" : {
334
+ "inline" : [ {
335
+ "scope" : "APPSERVER",
336
+ "rules" : [ {
337
+ "duration" : 60000,
338
+ "lock-period" : 600000,
339
+ "threshold" : 30,
340
+ "hip" : false
341
+ } ],
342
+ "window" : "ROLLING",
343
+ "key" : "url.path+user.remoteip"
344
+ } ]
345
+ },
346
+ "extraparams" : {
347
+ "disable" : true,
348
+ "ignore" : false
349
+ },
350
+ "authentication" : { }
351
+ },
352
+ "apimethod" : "com.zoho.desk.helpcenter.ticket.CommentService.getArticleComment"
353
+ }
354
+ }
355
+ },
356
+ "/portal/api/kbArticles/search" : {
357
+ "get" : {
358
+ "tags" : [ "Solution" ],
359
+ "summary" : "Search articles",
360
+ "description" : "This API searches for articles in the knowledge base.",
361
+ "operationId" : "searchAllArticles",
362
+ "parameters" : [ {
363
+ "name" : "include",
364
+ "in" : "query",
365
+ "description" : "Extra info to be included. Allowed values : parentCategories",
366
+ "required" : false,
367
+ "style" : "simple",
368
+ "explode" : true,
369
+ "schema" : {
370
+ "type" : [ "null", "array" ],
371
+ "description" : "Extra info to be included. Allowed values : parentCategories",
372
+ "items" : {
373
+ "type" : [ "string", "null" ],
374
+ "enum" : [ "parentCategories" ],
375
+ "maxLength" : 100,
376
+ "minLength" : 0,
377
+ "x-custom-parameters-attributes" : [ ]
378
+ },
379
+ "uniqueItems" : true,
380
+ "x-audience" : [ "company-internal" ]
381
+ }
382
+ }, {
383
+ "name" : "searchStr",
384
+ "in" : "query",
385
+ "description" : "Keyword to use for the search",
386
+ "required" : true,
387
+ "style" : "form",
388
+ "explode" : true,
389
+ "schema" : {
390
+ "type" : [ "string", "null" ],
391
+ "description" : "Keyword to use for the search",
392
+ "maxLength" : 255,
393
+ "minLength" : 0,
394
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$\\@\\(\\)\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
395
+ }
396
+ }, {
397
+ "name" : "departmentId",
398
+ "in" : "query",
399
+ "description" : "To retrieve the articles under particular department",
400
+ "required" : false,
401
+ "style" : "form",
402
+ "explode" : true,
403
+ "schema" : {
404
+ "type" : [ "string", "null", "integer" ],
405
+ "format" : "int64",
406
+ "description" : "To retrieve the articles under particular department",
407
+ "pattern" : "([0-9]+)",
408
+ "x-audience" : [ "company-internal" ]
409
+ }
410
+ }, {
411
+ "$ref" : "#/components/parameters/limit"
412
+ }, {
413
+ "name" : "includeCount",
414
+ "in" : "query",
415
+ "description" : "Display count in articles response",
416
+ "required" : false,
417
+ "style" : "form",
418
+ "explode" : true,
419
+ "schema" : {
420
+ "type" : [ "boolean", "null" ],
421
+ "description" : "Display count in articles response",
422
+ "x-audience" : [ "company-internal" ]
423
+ }
424
+ }, {
425
+ "$ref" : "#/components/parameters/from"
426
+ }, {
427
+ "name" : "sortBy",
428
+ "in" : "query",
429
+ "description" : "Sort by can be createdTime and relevance attributes. The default sorting order is relevance. -createdTime prefix denotes descending order of sorting.",
430
+ "required" : false,
431
+ "style" : "form",
432
+ "explode" : true,
433
+ "schema" : {
434
+ "type" : [ "string", "null" ],
435
+ "description" : "Sort by can be createdTime and relevance attributes. The default sorting order is relevance. -createdTime prefix denotes descending order of sorting.",
436
+ "enum" : [ "relevance", "createdTime", "-createdTime" ],
437
+ "maxLength" : 100,
438
+ "minLength" : 0
439
+ }
440
+ }, {
441
+ "name" : "locale",
442
+ "in" : "path",
443
+ "description" : "Locale of the article",
444
+ "required" : true,
445
+ "style" : "simple",
446
+ "explode" : false,
447
+ "schema" : {
448
+ "type" : [ "string", "null" ],
449
+ "description" : "Locale of the article",
450
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
451
+ "maxLength" : 100,
452
+ "minLength" : 0,
453
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
454
+ "x-audience" : [ "company-internal" ]
455
+ }
456
+ }, {
457
+ "$ref" : "#/components/parameters/categoryId"
458
+ }, {
459
+ "name" : "rootCategoryId",
460
+ "in" : "query",
461
+ "description" : "ID of the root category to which the articles must belong",
462
+ "required" : false,
463
+ "style" : "form",
464
+ "explode" : true,
465
+ "schema" : {
466
+ "type" : [ "string", "null", "integer" ],
467
+ "format" : "int64",
468
+ "description" : "ID of the root category to which the articles must belong",
469
+ "pattern" : "([0-9]+)",
470
+ "x-custom-parameters-attributes" : {
471
+ "split" : ","
472
+ },
473
+ "x-audience" : [ "company-internal" ]
474
+ }
475
+ }, {
476
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
477
+ }, {
478
+ "$ref" : "#/components/parameters/searchKeyWordMatch"
479
+ } ],
480
+ "responses" : {
481
+ "200" : {
482
+ "$ref" : "#/components/responses/newArticleList"
483
+ },
484
+ "422" : {
485
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
486
+ }
487
+ },
488
+ "security" : [ {
489
+ "jwt-oauth" : [ "jwt-oauth" ]
490
+ } ],
491
+ "x-audience" : [ "external-public" ],
492
+ "x-custom-url-attribute" : {
493
+ "security" : {
494
+ "throttle" : {
495
+ "inline" : [ {
496
+ "scope" : "APPSERVER",
497
+ "rules" : [ {
498
+ "duration" : 60000,
499
+ "lock-period" : 300000,
500
+ "threshold" : 100,
501
+ "hip" : false
502
+ }, {
503
+ "duration" : 3600000,
504
+ "lock-period" : 900000,
505
+ "threshold" : 300,
506
+ "hip" : false
507
+ } ],
508
+ "window" : "ROLLING",
509
+ "key" : "url.path+user.remoteip"
510
+ } ]
511
+ },
512
+ "extraparams" : {
513
+ "disable" : true,
514
+ "ignore" : false
515
+ },
516
+ "authentication" : { }
517
+ },
518
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.searchArticles"
519
+ }
520
+ }
521
+ },
522
+ "/portal/api/kbArticles/{id}/locale/{locale}/answer" : {
523
+ "get" : {
524
+ "tags" : [ "Solution" ],
525
+ "summary" : "Get answer of an article translation",
526
+ "description" : "Fetch article translation content",
527
+ "operationId" : "retriveArticleAnswer",
528
+ "parameters" : [ {
529
+ "$ref" : "#/components/parameters/id"
530
+ }, {
531
+ "$ref" : "#/components/parameters/locale"
532
+ }, {
533
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
534
+ } ],
535
+ "responses" : {
536
+ "200" : {
537
+ "$ref" : "#/components/responses/articleAnswerResponse"
538
+ }
539
+ },
540
+ "security" : [ {
541
+ "jwt-oauth" : [ "jwt-oauth" ]
542
+ } ],
543
+ "x-audience" : [ "external-public" ],
544
+ "x-custom-url-attribute" : {
545
+ "security" : {
546
+ "throttle" : {
547
+ "inline" : [ {
548
+ "scope" : "APPSERVER",
549
+ "rules" : [ {
550
+ "duration" : 60000,
551
+ "lock-period" : 300000,
552
+ "threshold" : 10,
553
+ "hip" : false
554
+ }, {
555
+ "duration" : 3600000,
556
+ "lock-period" : 900000,
557
+ "threshold" : 80,
558
+ "hip" : false
559
+ } ],
560
+ "window" : "ROLLING",
561
+ "key" : "url.path+user.remoteip"
562
+ } ]
563
+ },
564
+ "extraparams" : {
565
+ "disable" : true,
566
+ "ignore" : false
567
+ },
568
+ "authentication" : { }
569
+ },
570
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticleAnswer"
571
+ }
572
+ }
573
+ },
574
+ "/portal/api/kbTags" : {
575
+ "get" : {
576
+ "tags" : [ "Solution" ],
577
+ "summary" : "Get Tags list",
578
+ "description" : "To get list of articles associated tags",
579
+ "operationId" : "getTagsList",
580
+ "parameters" : [ {
581
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
582
+ } ],
583
+ "responses" : {
584
+ "200" : {
585
+ "$ref" : "#/components/responses/getTagsResponse"
586
+ }
587
+ },
588
+ "security" : [ {
589
+ "jwt-oauth" : [ "jwt-oauth" ]
590
+ } ],
591
+ "x-audience" : [ "external-public" ],
592
+ "x-custom-url-attribute" : {
593
+ "security" : {
594
+ "throttle" : {
595
+ "inline" : [ {
596
+ "scope" : "APPSERVER",
597
+ "rules" : [ {
598
+ "duration" : 60000,
599
+ "lock-period" : 600000,
600
+ "threshold" : 30,
601
+ "hip" : false
602
+ } ],
603
+ "window" : "ROLLING",
604
+ "key" : "url.path+user.remoteip"
605
+ } ]
606
+ },
607
+ "extraparams" : {
608
+ "disable" : true,
609
+ "ignore" : false
610
+ },
611
+ "authentication" : { }
612
+ },
613
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.tagList"
614
+ }
615
+ }
616
+ },
617
+ "/portal/api/kbArticles/relatedArticleSearch" : {
618
+ "get" : {
619
+ "tags" : [ "Solution" ],
620
+ "operationId" : "searchRelatedArticles",
621
+ "parameters" : [ {
622
+ "$ref" : "#/components/parameters/limit"
623
+ }, {
624
+ "$ref" : "#/components/parameters/solutionId"
625
+ }, {
626
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
627
+ }, {
628
+ "$ref" : "#/components/parameters/rootCategoryId"
629
+ }],
630
+ "responses" : {
631
+ "200" : {
632
+ "$ref" : "#/components/responses/searchRelatedArticlesResponse"
633
+ },
634
+ "422" : {
635
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
636
+ }
637
+ },
638
+ "security" : [ {
639
+ "jwt-oauth" : [ "jwt-oauth" ]
640
+ } ],
641
+ "x-audience" : [ "external-public" ],
642
+ "x-custom-url-attribute" : {
643
+ "security" : {
644
+ "throttle" : {
645
+ "inline" : [ {
646
+ "scope" : "APPSERVER",
647
+ "rules" : [ {
648
+ "duration" : 60000,
649
+ "lock-period" : 600000,
650
+ "threshold" : 100,
651
+ "hip" : false
652
+ } ],
653
+ "window" : "ROLLING",
654
+ "key" : "url.path+user.remoteip"
655
+ } ]
656
+ },
657
+ "extraparams" : {
658
+ "disable" : true,
659
+ "ignore" : false
660
+ },
661
+ "authentication" : { }
662
+ },
663
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.searchRelatedArticles"
664
+ }
665
+ }
666
+ },
667
+ "/portal/api/kbArticles/{id}/dislike" : {
668
+ "post" : {
669
+ "tags" : [ "Solution" ],
670
+ "operationId" : "updateArticledisLikeCount",
671
+ "parameters" : [ {
672
+ "$ref" : "#/components/parameters/id"
673
+ }, {
674
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
675
+ } ],
676
+ "responses" : {
677
+ "204" : {
678
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
679
+ }
680
+ },
681
+ "security" : [ {
682
+ "jwt-oauth" : [ "jwt-oauth" ]
683
+ } ],
684
+ "x-audience" : [ "external-public" ],
685
+ "x-custom-url-attribute" : {
686
+ "security" : {
687
+ "throttle" : {
688
+ "inline" : [ {
689
+ "scope" : "APPSERVER",
690
+ "rules" : [ {
691
+ "duration" : 60000,
692
+ "lock-period" : 600000,
693
+ "threshold" : 50,
694
+ "hip" : false
695
+ } ],
696
+ "window" : "ROLLING",
697
+ "key" : "url.path+user.remoteip"
698
+ } ]
699
+ },
700
+ "extraparams" : {
701
+ "disable" : true,
702
+ "ignore" : false
703
+ },
704
+ "authentication" : { }
705
+ },
706
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.updateArticledisLikeCount"
707
+ }
708
+ }
709
+ },
710
+ "/portal/api/kbArticles/{id}/locale/{locale}/dislike" : {
711
+ "post" : {
712
+ "tags" : [ "Solution" ],
713
+ "summary" : "Dislike article",
714
+ "description" : "This API records an unlike (negative reaction) on an article.",
715
+ "operationId" : "updateArticleTranslationDisLikeCount",
716
+ "parameters" : [ {
717
+ "$ref" : "#/components/parameters/id"
718
+ }, {
719
+ "$ref" : "#/components/parameters/locale"
720
+ }, {
721
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
722
+ } ],
723
+ "responses" : {
724
+ "204" : {
725
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
726
+ }
727
+ },
728
+ "security" : [ {
729
+ "jwt-oauth" : [ "jwt-oauth" ]
730
+ } ],
731
+ "x-audience" : [ "external-public" ],
732
+ "x-custom-url-attribute" : {
733
+ "security" : {
734
+ "throttle" : {
735
+ "policy" : "UserReaction_Policy"
736
+ },
737
+ "extraparams" : {
738
+ "disable" : true,
739
+ "ignore" : false
740
+ },
741
+ "authentication" : { }
742
+ },
743
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.dislikeArticle"
744
+ }
745
+ }
746
+ },
747
+ "/portal/api/kbArticles/{id}/locale/{locale}/previousNextArticles" : {
748
+ "get" : {
749
+ "tags" : [ "Solution" ],
750
+ "summary" : "Nearby Article Translations",
751
+ "description" : "This API lists a particular number of help articles below and above the current article, based on the limit specified.",
752
+ "operationId" : "getPreviousNextArticlesWithLocale",
753
+ "parameters" : [ {
754
+ "$ref" : "#/components/parameters/limit"
755
+ }, {
756
+ "$ref" : "#/components/parameters/id"
757
+ }, {
758
+ "$ref" : "#/components/parameters/locale"
759
+ }, {
760
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
761
+ } ],
762
+ "responses" : {
763
+ "200" : {
764
+ "$ref" : "#/components/responses/previousNextArticleWithLocale"
765
+ }
766
+ },
767
+ "security" : [ {
768
+ "jwt-oauth" : [ "jwt-oauth" ]
769
+ } ],
770
+ "x-audience" : [ "external-public" ],
771
+ "x-custom-url-attribute" : {
772
+ "security" : {
773
+ "throttle" : {
774
+ "inline" : [ {
775
+ "scope" : "APPSERVER",
776
+ "rules" : [ {
777
+ "duration" : 60000,
778
+ "lock-period" : 300000,
779
+ "threshold" : 100,
780
+ "hip" : false
781
+ }, {
782
+ "duration" : 3600000,
783
+ "lock-period" : 900000,
784
+ "threshold" : 300,
785
+ "hip" : false
786
+ } ],
787
+ "window" : "ROLLING",
788
+ "key" : "url.path+user.remoteip"
789
+ } ]
790
+ },
791
+ "extraparams" : {
792
+ "disable" : true,
793
+ "ignore" : false
794
+ },
795
+ "authentication" : { }
796
+ },
797
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getPreviousNextArticles"
798
+ }
799
+ }
800
+ },
801
+ "/portal/api/kbArticles/articleByPermalink" : {
802
+ "get" : {
803
+ "tags" : [ "Solution" ],
804
+ "summary" : "Article by permalink",
805
+ "description" : "To get article by Permalink",
806
+ "operationId" : "articleByPermalink",
807
+ "parameters" : [ {
808
+ "name" : "include",
809
+ "in" : "query",
810
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
811
+ "required" : false,
812
+ "style" : "simple",
813
+ "explode" : true,
814
+ "schema" : {
815
+ "type" : [ "null", "array" ],
816
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
817
+ "items" : {
818
+ "type" : [ "string", "null" ],
819
+ "enum" : [ "parentCategories", "locales" ],
820
+ "maxLength" : 100,
821
+ "minLength" : 0,
822
+ "x-custom-parameters-attributes" : [ ]
823
+ },
824
+ "uniqueItems" : true,
825
+ "x-audience" : [ "company-internal" ]
826
+ }
827
+ }, {
828
+ "name" : "permalink",
829
+ "in" : "query",
830
+ "description" : "String to get solution id",
831
+ "required" : true,
832
+ "style" : "form",
833
+ "explode" : true,
834
+ "schema" : {
835
+ "type" : [ "string", "null" ],
836
+ "description" : "String to get solution id",
837
+ "maxLength" : 500,
838
+ "minLength" : 0,
839
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
840
+ }
841
+ }, {
842
+ "name" : "locale",
843
+ "in" : "path",
844
+ "description" : "Locale of the article",
845
+ "required" : true,
846
+ "style" : "simple",
847
+ "explode" : false,
848
+ "schema" : {
849
+ "type" : [ "string", "null" ],
850
+ "description" : "Locale of the article",
851
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
852
+ "maxLength" : 100,
853
+ "minLength" : 0,
854
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
855
+ "x-audience" : [ "company-internal" ]
856
+ }
857
+ }, {
858
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
859
+ } ],
860
+ "responses" : {
861
+ "200" : {
862
+ "$ref" : "#/components/responses/articleByPermalinkResponse"
863
+ },
864
+ "422" : {
865
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
866
+ }
867
+ },
868
+ "security" : [ {
869
+ "jwt-oauth" : [ "jwt-oauth" ]
870
+ } ],
871
+ "x-audience" : [ "external-public" ],
872
+ "x-custom-url-attribute" : {
873
+ "security" : {
874
+ "throttle" : {
875
+ "inline" : [ {
876
+ "scope" : "APPSERVER",
877
+ "rules" : [ {
878
+ "duration" : 60000,
879
+ "lock-period" : 300000,
880
+ "threshold" : 100,
881
+ "hip" : false
882
+ }, {
883
+ "duration" : 3600000,
884
+ "lock-period" : 900000,
885
+ "threshold" : 300,
886
+ "hip" : false
887
+ } ],
888
+ "window" : "ROLLING",
889
+ "key" : "url.path+user.remoteip"
890
+ } ]
891
+ },
892
+ "extraparams" : {
893
+ "disable" : true,
894
+ "ignore" : false
895
+ },
896
+ "authentication" : { }
897
+ },
898
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticleByPermalink"
899
+ }
900
+ }
901
+ },
902
+ "/portal/api/kbArticles/{id}/locale/{locale}" : {
903
+ "get" : {
904
+ "tags" : [ "Solution" ],
905
+ "summary" : "Get article translation",
906
+ "description" : "This API fetches a single help article from the knowledge base based on locale.",
907
+ "operationId" : "retriveAnArticleTranslation",
908
+ "parameters" : [ {
909
+ "name" : "include",
910
+ "in" : "query",
911
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
912
+ "required" : false,
913
+ "style" : "simple",
914
+ "explode" : true,
915
+ "schema" : {
916
+ "type" : [ "null", "array" ],
917
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
918
+ "items" : {
919
+ "type" : [ "string", "null" ],
920
+ "enum" : [ "parentCategories", "locales" ],
921
+ "maxLength" : 100,
922
+ "minLength" : 0,
923
+ "x-custom-parameters-attributes" : [ ]
924
+ },
925
+ "uniqueItems" : true,
926
+ "x-audience" : [ "company-internal" ]
927
+ }
928
+ }, {
929
+ "$ref" : "#/components/parameters/id"
930
+ }, {
931
+ "$ref" : "#/components/parameters/locale"
932
+ }, {
933
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
934
+ } ],
935
+ "responses" : {
936
+ "200" : {
937
+ "$ref" : "#/components/responses/solutionCommonJsonWithoutLocales"
938
+ }
939
+ },
940
+ "security" : [ {
941
+ "jwt-oauth" : [ "jwt-oauth" ]
942
+ } ],
943
+ "x-audience" : [ "external-public" ],
944
+ "x-custom-url-attribute" : {
945
+ "security" : {
946
+ "throttle" : {
947
+ "inline" : [ {
948
+ "scope" : "APPSERVER",
949
+ "rules" : [ {
950
+ "duration" : 60000,
951
+ "lock-period" : 300000,
952
+ "threshold" : 150,
953
+ "hip" : false
954
+ }, {
955
+ "duration" : 300000,
956
+ "lock-period" : 300000,
957
+ "threshold" : 600,
958
+ "hip" : false
959
+ }, {
960
+ "duration" : 900000,
961
+ "lock-period" : 300000,
962
+ "threshold" : 1500,
963
+ "hip" : false
964
+ } ],
965
+ "window" : "ROLLING",
966
+ "key" : "url.path+user.remoteip"
967
+ } ]
968
+ },
969
+ "extraparams" : {
970
+ "disable" : true,
971
+ "ignore" : false
972
+ },
973
+ "authentication" : { }
974
+ },
975
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticle"
976
+ }
977
+ }
978
+ },
979
+ "/portal/api/kbArticles" : {
980
+ "get" : {
981
+ "tags" : [ "Solution" ],
982
+ "summary" : "List articles",
983
+ "description" : "This API lists a particular number of help articles, based on the limit specified.",
984
+ "operationId" : "listAllArticles",
985
+ "parameters" : [ {
986
+ "name" : "include",
987
+ "in" : "query",
988
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
989
+ "required" : false,
990
+ "style" : "simple",
991
+ "explode" : true,
992
+ "schema" : {
993
+ "type" : [ "null", "array" ],
994
+ "description" : "Extra info to be included. Allowed values : parentCategories, locales",
995
+ "items" : {
996
+ "type" : [ "string", "null" ],
997
+ "enum" : [ "parentCategories", "locales" ],
998
+ "maxLength" : 100,
999
+ "minLength" : 0,
1000
+ "x-custom-parameters-attributes" : [ ]
1001
+ },
1002
+ "uniqueItems" : true,
1003
+ "x-audience" : [ "company-internal" ]
1004
+ }
1005
+ }, {
1006
+ "$ref" : "#/components/parameters/limit"
1007
+ }, {
1008
+ "$ref" : "#/components/parameters/from"
1009
+ }, {
1010
+ "name" : "sortBy",
1011
+ "in" : "query",
1012
+ "description" : "Key that sorts articles by a particular attribute: createdTime, modifiedTime, likeCount, viewCount, or unlikeCount",
1013
+ "required" : false,
1014
+ "style" : "form",
1015
+ "explode" : true,
1016
+ "schema" : {
1017
+ "type" : [ "string", "null" ],
1018
+ "description" : "Key that sorts articles by a particular attribute: createdTime, modifiedTime, likeCount, viewCount, or unlikeCount",
1019
+ "maxLength" : 100,
1020
+ "minLength" : 0,
1021
+ "pattern" : "[+-]?(mostliked|mostviewed|mostunliked|createdTime|modifiedTime)"
1022
+ }
1023
+ }, {
1024
+ "name" : "tag",
1025
+ "in" : "query",
1026
+ "description" : "Key that filters articles, based on tags",
1027
+ "required" : false,
1028
+ "style" : "form",
1029
+ "explode" : true,
1030
+ "schema" : {
1031
+ "type" : [ "string", "null" ],
1032
+ "description" : "Key that filters articles, based on tags",
1033
+ "maxLength" : 100,
1034
+ "minLength" : 0,
1035
+ "pattern" : "[a-z0-9\\_\\-\\+\\%\\P{InBasicLatin}]+"
1036
+ }
1037
+ }, {
1038
+ "name" : "locale",
1039
+ "in" : "query",
1040
+ "description" : "Locale of the article",
1041
+ "required" : false,
1042
+ "style" : "form",
1043
+ "explode" : true,
1044
+ "schema" : {
1045
+ "type" : [ "string", "null" ],
1046
+ "description" : "Locale of the article",
1047
+ "enum" : [ "en" ],
1048
+ "maxLength" : 100,
1049
+ "minLength" : 0,
1050
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1051
+ "x-audience" : [ "company-internal" ]
1052
+ }
1053
+ }, {
1054
+ "$ref" : "#/components/parameters/categoryId"
1055
+ }, {
1056
+ "name" : "includeChildCategoryArticles",
1057
+ "in" : "query",
1058
+ "description" : "Key that specifies if articles belonging to child categories must be fetched or not",
1059
+ "required" : false,
1060
+ "style" : "form",
1061
+ "explode" : true,
1062
+ "schema" : {
1063
+ "type" : [ "boolean", "null" ],
1064
+ "description" : "Key that specifies if articles belonging to child categories must be fetched or not",
1065
+ "x-audience" : [ "company-internal" ]
1066
+ }
1067
+ }, {
1068
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1069
+ } ],
1070
+ "responses" : {
1071
+ "200" : {
1072
+ "$ref" : "#/components/responses/newArticleList"
1073
+ }
1074
+ },
1075
+ "security" : [ {
1076
+ "jwt-oauth" : [ "jwt-oauth" ]
1077
+ } ],
1078
+ "x-audience" : [ "external-public" ],
1079
+ "x-custom-url-attribute" : {
1080
+ "security" : {
1081
+ "throttle" : {
1082
+ "inline" : [ {
1083
+ "scope" : "APPSERVER",
1084
+ "rules" : [ {
1085
+ "duration" : 60000,
1086
+ "lock-period" : 300000,
1087
+ "threshold" : 200,
1088
+ "hip" : false
1089
+ }, {
1090
+ "duration" : 3600000,
1091
+ "lock-period" : 900000,
1092
+ "threshold" : 600,
1093
+ "hip" : false
1094
+ } ],
1095
+ "window" : "ROLLING",
1096
+ "key" : "url.path+user.zuid"
1097
+ } ]
1098
+ },
1099
+ "extraparams" : {
1100
+ "disable" : true,
1101
+ "ignore" : false
1102
+ },
1103
+ "authentication" : { }
1104
+ },
1105
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticles"
1106
+ }
1107
+ }
1108
+ },
1109
+ "/portal/api/kbArticles/{articleId}/locale/{locale}/attachments/{attachmentId}/content" : {
1110
+ "get" : {
1111
+ "tags" : [ "Solution" ],
1112
+ "summary" : "",
1113
+ "description" : "",
1114
+ "operationId" : "downloadArticleTranlsationAttachment",
1115
+ "parameters" : [ {
1116
+ "$ref" : "#/components/parameters/articleId"
1117
+ }, {
1118
+ "$ref" : "#/components/parameters/attachmentId"
1119
+ }, {
1120
+ "$ref" : "#/components/parameters/locale"
1121
+ }, {
1122
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1123
+ } ],
1124
+ "responses" : {
1125
+ "200" : {
1126
+ "$ref" : "../common/Common.json#/components/responses/fileResponse"
1127
+ }
1128
+ }
1129
+ }
1130
+ },
1131
+ "/portal/api/kbArticles/{id}/locale/{locale}/feedbacks" : {
1132
+ "post" : {
1133
+ "tags" : [ "Solution" ],
1134
+ "summary" : "Create article feedback",
1135
+ "description" : "This API adds a feedback to an article.",
1136
+ "operationId" : "createArticleTranslationFeedback",
1137
+ "parameters" : [ {
1138
+ "$ref" : "#/components/parameters/id"
1139
+ }, {
1140
+ "$ref" : "#/components/parameters/locale"
1141
+ }, {
1142
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1143
+ } ],
1144
+ "requestBody" : {
1145
+ "$ref" : "#/components/requestBodies/createArticleTranslationFeedback_feedback_portal"
1146
+ },
1147
+ "responses" : {
1148
+ "422" : {
1149
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1150
+ },
1151
+ "200" : {
1152
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1153
+ },
1154
+ "204" : {
1155
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1156
+ }
1157
+ },
1158
+ "security" : [ {
1159
+ "jwt-oauth" : [ "jwt-oauth" ]
1160
+ } ],
1161
+ "x-audience" : [ "external-public" ],
1162
+ "x-custom-url-attribute" : {
1163
+ "security" : {
1164
+ "throttle" : {
1165
+ "policy" : "SubEntityCreate_Policy"
1166
+ },
1167
+ "extraparams" : {
1168
+ "disable" : true,
1169
+ "ignore" : false
1170
+ },
1171
+ "authentication" : { }
1172
+ },
1173
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.addAFeedback"
1174
+ }
1175
+ }
1176
+ },
1177
+ "/portal/api/kbArticles/{id}/like" : {
1178
+ "post" : {
1179
+ "tags" : [ "Solution" ],
1180
+ "operationId" : "updateArticleLikeCount",
1181
+ "parameters" : [ {
1182
+ "$ref" : "#/components/parameters/id"
1183
+ }, {
1184
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1185
+ } ],
1186
+ "responses" : {
1187
+ "204" : {
1188
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1189
+ }
1190
+ },
1191
+ "security" : [ {
1192
+ "jwt-oauth" : [ "jwt-oauth" ]
1193
+ } ],
1194
+ "x-audience" : [ "external-public" ],
1195
+ "x-custom-url-attribute" : {
1196
+ "security" : {
1197
+ "throttle" : {
1198
+ "inline" : [ {
1199
+ "scope" : "APPSERVER",
1200
+ "rules" : [ {
1201
+ "duration" : 60000,
1202
+ "lock-period" : 600000,
1203
+ "threshold" : 50,
1204
+ "hip" : false
1205
+ } ],
1206
+ "window" : "ROLLING",
1207
+ "key" : "url.path+user.remoteip"
1208
+ } ]
1209
+ },
1210
+ "extraparams" : {
1211
+ "disable" : true,
1212
+ "ignore" : false
1213
+ },
1214
+ "authentication" : { }
1215
+ },
1216
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.updateArticleLikeCount"
1217
+ }
1218
+ }
1219
+ },
1220
+ "/portal/api/kbArticles/{id}/previousNextArticles" : {
1221
+ "get" : {
1222
+ "tags" : [ "Solution" ],
1223
+ "operationId" : "getPreviousNextArticles",
1224
+ "parameters" : [ {
1225
+ "$ref" : "#/components/parameters/limit"
1226
+ }, {
1227
+ "$ref" : "#/components/parameters/id"
1228
+ }, {
1229
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1230
+ } ],
1231
+ "responses" : {
1232
+ "200" : {
1233
+ "$ref" : "#/components/responses/previousNextArticleWithLocale"
1234
+ }
1235
+ },
1236
+ "security" : [ {
1237
+ "jwt-oauth" : [ "jwt-oauth" ]
1238
+ } ],
1239
+ "x-audience" : [ "external-public" ],
1240
+ "x-custom-url-attribute" : {
1241
+ "security" : {
1242
+ "throttle" : {
1243
+ "inline" : [ {
1244
+ "scope" : "APPSERVER",
1245
+ "rules" : [ {
1246
+ "duration" : 60000,
1247
+ "lock-period" : 300000,
1248
+ "threshold" : 100,
1249
+ "hip" : false
1250
+ }, {
1251
+ "duration" : 3600000,
1252
+ "lock-period" : 900000,
1253
+ "threshold" : 300,
1254
+ "hip" : false
1255
+ } ],
1256
+ "window" : "ROLLING",
1257
+ "key" : "url.path+user.remoteip"
1258
+ } ]
1259
+ },
1260
+ "extraparams" : {
1261
+ "disable" : true,
1262
+ "ignore" : false
1263
+ },
1264
+ "authentication" : { }
1265
+ },
1266
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getPreviousNextArticles"
1267
+ }
1268
+ }
1269
+ },
1270
+ "/portal/api/kbArticles/{solutionId}/attachments" : {
1271
+ "get" : {
1272
+ "tags" : [ "Solution" ],
1273
+ "operationId" : "listAllArticleAttachments",
1274
+ "parameters" : [ {
1275
+ "name" : "solutionId",
1276
+ "in" : "path",
1277
+ "required" : true,
1278
+ "style" : "simple",
1279
+ "explode" : false,
1280
+ "schema" : {
1281
+ "type" : [ "string", "null", "integer" ],
1282
+ "format" : "int64",
1283
+ "pattern" : "([0-9]+)"
1284
+ }
1285
+ }, {
1286
+ "$ref" : "#/components/parameters/limit"
1287
+ }, {
1288
+ "$ref" : "#/components/parameters/from"
1289
+ }, {
1290
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1291
+ } ],
1292
+ "responses" : {
1293
+ "200" : {
1294
+ "$ref" : "#/components/responses/listAllArticleAttachments"
1295
+ }
1296
+ },
1297
+ "security" : [ {
1298
+ "jwt-oauth" : [ "jwt-oauth" ]
1299
+ } ],
1300
+ "x-audience" : [ "external-public" ],
1301
+ "x-custom-url-attribute" : {
1302
+ "security" : {
1303
+ "throttle" : {
1304
+ "inline" : [ {
1305
+ "scope" : "APPSERVER",
1306
+ "rules" : [ {
1307
+ "duration" : 60000,
1308
+ "lock-period" : 60000,
1309
+ "threshold" : 90,
1310
+ "hip" : false
1311
+ } ],
1312
+ "window" : "ROLLING",
1313
+ "key" : "url.path+user.zuid"
1314
+ } ]
1315
+ },
1316
+ "extraparams" : {
1317
+ "disable" : true,
1318
+ "ignore" : false
1319
+ },
1320
+ "authentication" : { }
1321
+ },
1322
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.getAttachments"
1323
+ }
1324
+ }
1325
+ },
1326
+ "/portal/api/communityTopics/{topicId}/relatedArticles" : {
1327
+ "get" : {
1328
+ "tags" : [ "Solution" ],
1329
+ "summary" : "Related Articles by topic",
1330
+ "description" : "To get articles related to a topic",
1331
+ "operationId" : "relatedArticlesByTopic",
1332
+ "parameters" : [ {
1333
+ "name" : "include",
1334
+ "in" : "query",
1335
+ "description" : "Extra info to be included. Allowed values : parentCategories",
1336
+ "required" : false,
1337
+ "style" : "simple",
1338
+ "explode" : true,
1339
+ "schema" : {
1340
+ "type" : [ "null", "array" ],
1341
+ "description" : "Extra info to be included. Allowed values : parentCategories",
1342
+ "items" : {
1343
+ "type" : [ "string", "null" ],
1344
+ "enum" : [ "parentCategories" ],
1345
+ "maxLength" : 100,
1346
+ "minLength" : 0,
1347
+ "x-custom-parameters-attributes" : [ ]
1348
+ },
1349
+ "uniqueItems" : true,
1350
+ "x-audience" : [ "company-internal" ]
1351
+ }
1352
+ }, {
1353
+ "$ref" : "#/components/parameters/limit"
1354
+ }, {
1355
+ "$ref" : "#/components/parameters/from"
1356
+ }, {
1357
+ "name" : "topicId",
1358
+ "in" : "path",
1359
+ "required" : true,
1360
+ "style" : "simple",
1361
+ "explode" : false,
1362
+ "schema" : {
1363
+ "type" : [ "string", "null", "integer" ],
1364
+ "format" : "int64",
1365
+ "pattern" : "([0-9]+)"
1366
+ }
1367
+ }, {
1368
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1369
+ } ],
1370
+ "responses" : {
1371
+ "200" : {
1372
+ "$ref" : "#/components/responses/newArticleList"
1373
+ }
1374
+ },
1375
+ "security" : [ {
1376
+ "jwt-oauth" : [ "jwt-oauth" ]
1377
+ } ],
1378
+ "x-audience" : [ "external-public" ],
1379
+ "x-custom-url-attribute" : {
1380
+ "security" : {
1381
+ "throttle" : {
1382
+ "inline" : [ {
1383
+ "scope" : "APPSERVER",
1384
+ "rules" : [ {
1385
+ "duration" : 60000,
1386
+ "lock-period" : 600000,
1387
+ "threshold" : 100,
1388
+ "hip" : false
1389
+ } ],
1390
+ "window" : "ROLLING",
1391
+ "key" : "url.path+user.remoteip"
1392
+ } ]
1393
+ },
1394
+ "extraparams" : {
1395
+ "disable" : true,
1396
+ "ignore" : false
1397
+ },
1398
+ "authentication" : { }
1399
+ },
1400
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.SolutionService.getRelatedArticlesForATopic"
1401
+ }
1402
+ }
1403
+ },
1404
+ "/portal/api/kbArticles/{articleId}/attachments/{attachmentId}/content" : {
1405
+ "get" : {
1406
+ "tags" : [ "Solution" ],
1407
+ "summary" : "",
1408
+ "description" : "",
1409
+ "operationId" : "downloadArticleAttachment",
1410
+ "parameters" : [ {
1411
+ "$ref" : "#/components/parameters/articleId"
1412
+ }, {
1413
+ "$ref" : "#/components/parameters/attachmentId"
1414
+ }, {
1415
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1416
+ } ],
1417
+ "responses" : {
1418
+ "200" : {
1419
+ "$ref" : "../common/Common.json#/components/responses/fileResponse"
1420
+ }
1421
+ }
1422
+ }
1423
+ },
1424
+ "/portal/api/kbArticles/{solutionId}/locale/{locale}/attachments" : {
1425
+ "get" : {
1426
+ "tags" : [ "Solution" ],
1427
+ "summary" : "List article attachments",
1428
+ "description" : "This API lists the files attached to help articles in the knowledge base.",
1429
+ "operationId" : "listAllArticleAttachmentsWithLocale",
1430
+ "parameters" : [ {
1431
+ "$ref" : "#/components/parameters/solutionId"
1432
+ }, {
1433
+ "$ref" : "#/components/parameters/locale"
1434
+ }, {
1435
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1436
+ } ],
1437
+ "responses" : {
1438
+ "200" : {
1439
+ "$ref" : "#/components/responses/listAllArticleAttachments"
1440
+ }
1441
+ },
1442
+ "security" : [ {
1443
+ "jwt-oauth" : [ "jwt-oauth" ]
1444
+ } ],
1445
+ "x-audience" : [ "external-public" ],
1446
+ "x-custom-url-attribute" : {
1447
+ "security" : {
1448
+ "throttle" : {
1449
+ "inline" : [ {
1450
+ "scope" : "APPSERVER",
1451
+ "rules" : [ {
1452
+ "duration" : 60000,
1453
+ "lock-period" : 300000,
1454
+ "threshold" : 100,
1455
+ "hip" : false
1456
+ }, {
1457
+ "duration" : 3600000,
1458
+ "lock-period" : 900000,
1459
+ "threshold" : 300,
1460
+ "hip" : false
1461
+ } ],
1462
+ "window" : "ROLLING",
1463
+ "key" : "url.path+user.zuid"
1464
+ } ]
1465
+ },
1466
+ "extraparams" : {
1467
+ "disable" : true,
1468
+ "ignore" : false
1469
+ },
1470
+ "authentication" : { }
1471
+ },
1472
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.getArticleAttachments"
1473
+ }
1474
+ }
1475
+ },
1476
+ "/portal/api/kbArticles/{id}/locale/{locale}/undoVote" : {
1477
+ "post" : {
1478
+ "tags" : [ "Solution" ],
1479
+ "summary" : "Undo article translation vote",
1480
+ "description" : "To revert back the user vote from knowledge base article translation",
1481
+ "operationId" : "undoArticleTranslationVote",
1482
+ "parameters" : [ {
1483
+ "$ref" : "#/components/parameters/id"
1484
+ }, {
1485
+ "$ref" : "#/components/parameters/locale"
1486
+ }, {
1487
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1488
+ } ],
1489
+ "responses" : {
1490
+ "204" : {
1491
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1492
+ }
1493
+ },
1494
+ "security" : [ {
1495
+ "jwt-oauth" : [ "jwt-oauth" ]
1496
+ } ],
1497
+ "x-audience" : [ "external-public" ],
1498
+ "x-custom-url-attribute" : {
1499
+ "security" : {
1500
+ "throttle" : {
1501
+ "policy" : "UserReaction_Policy"
1502
+ },
1503
+ "extraparams" : {
1504
+ "disable" : true,
1505
+ "ignore" : false
1506
+ },
1507
+ "authentication" : { }
1508
+ },
1509
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.undoTranslationVote"
1510
+ }
1511
+ }
1512
+ },
1513
+ "/portal/api/kbArticles/searchByTag" : {
1514
+ "get" : {
1515
+ "tags" : [ "Solution" ],
1516
+ "summary" : "Search articles by tag",
1517
+ "description" : "This API searches for articles with a particular tag.",
1518
+ "operationId" : "searchByTag",
1519
+ "parameters" : [ {
1520
+ "name" : "include",
1521
+ "in" : "query",
1522
+ "description" : "Extra info to be included. Allowed values : parentCategories",
1523
+ "required" : false,
1524
+ "style" : "simple",
1525
+ "explode" : true,
1526
+ "schema" : {
1527
+ "type" : [ "null", "array" ],
1528
+ "description" : "Extra info to be included. Allowed values : parentCategories",
1529
+ "items" : {
1530
+ "type" : [ "string", "null" ],
1531
+ "enum" : [ "parentCategories" ],
1532
+ "maxLength" : 100,
1533
+ "minLength" : 0,
1534
+ "x-custom-parameters-attributes" : [ ]
1535
+ },
1536
+ "uniqueItems" : true,
1537
+ "x-audience" : [ "company-internal" ]
1538
+ }
1539
+ }, {
1540
+ "name" : "tag",
1541
+ "in" : "query",
1542
+ "description" : "Key that filters articles, based on tags",
1543
+ "required" : true,
1544
+ "style" : "form",
1545
+ "explode" : true,
1546
+ "schema" : {
1547
+ "type" : [ "string", "null" ],
1548
+ "description" : "Key that filters articles, based on tags",
1549
+ "maxLength" : 100,
1550
+ "minLength" : 0,
1551
+ "pattern" : "[a-zA-Z0-9_\\-+=/\\P{InBasicLatin}]+"
1552
+ }
1553
+ }, {
1554
+ "name" : "departmentId",
1555
+ "in" : "query",
1556
+ "description" : "To retrieve the articles under particular department",
1557
+ "required" : false,
1558
+ "style" : "form",
1559
+ "explode" : true,
1560
+ "schema" : {
1561
+ "type" : [ "string", "null", "integer" ],
1562
+ "format" : "int64",
1563
+ "description" : "To retrieve the articles under particular department",
1564
+ "pattern" : "([0-9]+)",
1565
+ "x-audience" : [ "company-internal" ]
1566
+ }
1567
+ }, {
1568
+ "$ref" : "#/components/parameters/limit"
1569
+ }, {
1570
+ "name" : "includeCount",
1571
+ "in" : "query",
1572
+ "description" : "Display count in articles response",
1573
+ "required" : false,
1574
+ "style" : "form",
1575
+ "explode" : true,
1576
+ "schema" : {
1577
+ "type" : [ "boolean", "null" ],
1578
+ "description" : "Display count in articles response",
1579
+ "x-audience" : [ "company-internal" ]
1580
+ }
1581
+ }, {
1582
+ "$ref" : "#/components/parameters/from"
1583
+ }, {
1584
+ "name" : "locale",
1585
+ "in" : "path",
1586
+ "description" : "Locale of the article",
1587
+ "required" : true,
1588
+ "style" : "simple",
1589
+ "explode" : false,
1590
+ "schema" : {
1591
+ "type" : [ "string", "null" ],
1592
+ "description" : "Locale of the article",
1593
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1594
+ "maxLength" : 100,
1595
+ "minLength" : 0,
1596
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)",
1597
+ "x-audience" : [ "company-internal" ]
1598
+ }
1599
+ }, {
1600
+ "$ref" : "#/components/parameters/categoryId"
1601
+ }, {
1602
+ "name" : "rootCategoryId",
1603
+ "in" : "query",
1604
+ "description" : "ID of the root category to which the articles must belong",
1605
+ "required" : false,
1606
+ "style" : "form",
1607
+ "explode" : true,
1608
+ "schema" : {
1609
+ "type" : [ "string", "null", "integer" ],
1610
+ "format" : "int64",
1611
+ "description" : "ID of the root category to which the articles must belong",
1612
+ "pattern" : "([0-9]+)",
1613
+ "x-custom-parameters-attributes" : {
1614
+ "split" : ","
1615
+ },
1616
+ "x-audience" : [ "company-internal" ]
1617
+ }
1618
+ }, {
1619
+ "$ref" : "../common/Common.json#/components/parameters/portalId"
1620
+ } ],
1621
+ "responses" : {
1622
+ "200" : {
1623
+ "$ref" : "#/components/responses/newArticleList"
1624
+ },
1625
+ "422" : {
1626
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1627
+ }
1628
+ },
1629
+ "security" : [ {
1630
+ "jwt-oauth" : [ "jwt-oauth" ]
1631
+ } ],
1632
+ "x-audience" : [ "external-public" ],
1633
+ "x-custom-url-attribute" : {
1634
+ "security" : {
1635
+ "throttle" : {
1636
+ "inline" : [ {
1637
+ "scope" : "APPSERVER",
1638
+ "rules" : [ {
1639
+ "duration" : 60000,
1640
+ "lock-period" : 300000,
1641
+ "threshold" : 100,
1642
+ "hip" : false
1643
+ }, {
1644
+ "duration" : 3600000,
1645
+ "lock-period" : 900000,
1646
+ "threshold" : 300,
1647
+ "hip" : false
1648
+ } ],
1649
+ "window" : "ROLLING",
1650
+ "key" : "url.path+user.remoteip"
1651
+ } ]
1652
+ },
1653
+ "extraparams" : {
1654
+ "disable" : true,
1655
+ "ignore" : false
1656
+ },
1657
+ "authentication" : { }
1658
+ },
1659
+ "apimethod" : "com.zoho.desk.helpcenter.articles.rest.portal.PortalArticleService.searchArticlesByTag"
1660
+ }
1661
+ }
1662
+ }
1663
+ },
1664
+ "components" : {
1665
+ "schemas" : {
1666
+ "solutionCommonResponseWithLocale" : {
1667
+ "type" : [ "object", "null" ],
1668
+ "additionalProperties" : false,
1669
+ "properties" : {
1670
+ "webUrl" : {
1671
+ "type" : [ "string", "null" ],
1672
+ "maxLength" : 500,
1673
+ "minLength" : 0,
1674
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1675
+ },
1676
+ "id" : {
1677
+ "type" : [ "string", "null", "integer" ],
1678
+ "format" : "int64",
1679
+ "pattern" : "([0-9]+)"
1680
+ },
1681
+ "title" : {
1682
+ "type" : [ "string", "null" ],
1683
+ "maxLength" : 100,
1684
+ "minLength" : 0
1685
+ },
1686
+ "permalink" : {
1687
+ "type" : [ "string", "null" ],
1688
+ "maxLength" : 100,
1689
+ "minLength" : 0,
1690
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
1691
+ },
1692
+ "locale" : {
1693
+ "type" : [ "string", "null" ],
1694
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1695
+ "maxLength" : 100,
1696
+ "minLength" : 0,
1697
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1698
+ },
1699
+ "categoryId" : {
1700
+ "type" : [ "string", "null", "integer" ],
1701
+ "format" : "int64",
1702
+ "pattern" : "([0-9]+)"
1703
+ }
1704
+ },
1705
+ "required" : [ "categoryId", "id", "locale", "permalink", "title", "webUrl" ]
1706
+ },
1707
+ "category" : {
1708
+ "type" : [ "object", "null" ],
1709
+ "additionalProperties" : false,
1710
+ "properties" : {
1711
+ "name" : {
1712
+ "type" : [ "string", "null" ],
1713
+ "maxLength" : 100,
1714
+ "minLength" : 0
1715
+ },
1716
+ "id" : {
1717
+ "type" : [ "string", "null", "integer" ],
1718
+ "format" : "int64",
1719
+ "pattern" : "([0-9]+)"
1720
+ }
1721
+ },
1722
+ "required" : [ "id", "name" ]
1723
+ },
1724
+ "singleArticleListResponse" : {
1725
+ "additionalProperties" : false,
1726
+ "allOf" : [ {
1727
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonResponseWithLocale"
1728
+ }, {
1729
+ "type" : [ "object", "null" ],
1730
+ "properties" : {
1731
+ "summary" : {
1732
+ "type" : [ "string", "null" ],
1733
+ "maxLength" : 65553,
1734
+ "minLength" : 0
1735
+ },
1736
+ "modifiedTime" : {
1737
+ "type" : [ "string", "null" ],
1738
+ "maxLength" : 100,
1739
+ "minLength" : 0,
1740
+ "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))"
1741
+ },
1742
+ "createdTime" : {
1743
+ "type" : [ "string", "null" ],
1744
+ "maxLength" : 100,
1745
+ "minLength" : 0,
1746
+ "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))"
1747
+ },
1748
+ "category" : {
1749
+ "$ref" : "./Solution.json#/components/schemas/category"
1750
+ }
1751
+ },
1752
+ "required" : [ "category", "createdTime", "modifiedTime", "summary" ]
1753
+ } ]
1754
+ },
1755
+ "articleListItems" : {
1756
+ "type" : [ "array", "null" ],
1757
+ "items" : {
1758
+ "$ref" : "./Solution.json#/components/schemas/singleArticleListResponse"
1759
+ }
1760
+ },
1761
+ "author" : {
1762
+ "type" : [ "object", "null" ],
1763
+ "additionalProperties" : false,
1764
+ "properties" : {
1765
+ "photoURL" : {
1766
+ "type" : [ "string", "null" ],
1767
+ "maxLength" : 250,
1768
+ "minLength" : 0,
1769
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1770
+ },
1771
+ "name" : {
1772
+ "type" : [ "string", "null" ],
1773
+ "maxLength" : 200,
1774
+ "minLength" : 0,
1775
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1776
+ },
1777
+ "id" : {
1778
+ "type" : [ "string", "null", "integer" ],
1779
+ "format" : "int64",
1780
+ "pattern" : "([0-9]+)"
1781
+ },
1782
+ "status" : {
1783
+ "type" : [ "string", "null" ],
1784
+ "maxLength" : 200,
1785
+ "minLength" : 0,
1786
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1787
+ },
1788
+ "zuid" : {
1789
+ "type" : [ "string", "null", "integer" ],
1790
+ "format" : "int64",
1791
+ "pattern" : "([0-9]+)"
1792
+ }
1793
+ },
1794
+ "required" : [ "id", "name", "photoURL", "status", "zuid" ]
1795
+ },
1796
+ "prevNextJson" : {
1797
+ "type" : [ "object", "null" ],
1798
+ "additionalProperties" : false,
1799
+ "properties" : {
1800
+ "apiUrl" : {
1801
+ "type" : [ "string", "null" ],
1802
+ "maxLength" : 500,
1803
+ "minLength" : 0,
1804
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1805
+ },
1806
+ "webUrl" : {
1807
+ "type" : [ "string", "null" ],
1808
+ "maxLength" : 500,
1809
+ "minLength" : 0,
1810
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1811
+ },
1812
+ "id" : {
1813
+ "type" : [ "string", "null", "integer" ],
1814
+ "format" : "int64",
1815
+ "pattern" : "([0-9]+)"
1816
+ },
1817
+ "permalink" : {
1818
+ "type" : [ "string", "null" ],
1819
+ "maxLength" : 100,
1820
+ "minLength" : 0,
1821
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
1822
+ },
1823
+ "title" : {
1824
+ "type" : [ "string", "null" ],
1825
+ "maxLength" : 100,
1826
+ "minLength" : 0
1827
+ },
1828
+ "locale" : {
1829
+ "type" : [ "string", "null" ],
1830
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1831
+ "maxLength" : 100,
1832
+ "minLength" : 0,
1833
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1834
+ }
1835
+ },
1836
+ "required" : [ "apiUrl", "id", "locale", "permalink", "title", "webUrl" ]
1837
+ },
1838
+ "seo" : {
1839
+ "type" : [ "object", "null" ],
1840
+ "additionalProperties" : false,
1841
+ "properties" : {
1842
+ "keywords" : {
1843
+ "type" : [ "string", "null" ],
1844
+ "maxLength" : 100,
1845
+ "minLength" : 0
1846
+ },
1847
+ "isEnabled" : {
1848
+ "type" : [ "boolean", "null" ]
1849
+ },
1850
+ "description" : {
1851
+ "type" : [ "string", "null" ],
1852
+ "maxLength" : 100,
1853
+ "minLength" : 0
1854
+ },
1855
+ "title" : {
1856
+ "type" : [ "string", "null" ],
1857
+ "maxLength" : 100,
1858
+ "minLength" : 0
1859
+ }
1860
+ },
1861
+ "required" : [ "description", "isEnabled", "keywords", "title" ]
1862
+ },
1863
+ "solutionCommonJson" : {
1864
+ "type" : [ "object", "null" ],
1865
+ "additionalProperties" : false,
1866
+ "properties" : {
1867
+ "next" : {
1868
+ "$ref" : "./Solution.json#/components/schemas/prevNextJson"
1869
+ },
1870
+ "modifiedTime" : {
1871
+ "type" : [ "string", "null" ],
1872
+ "maxLength" : 100,
1873
+ "minLength" : 0,
1874
+ "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))"
1875
+ },
1876
+ "isFollowing" : {
1877
+ "type" : [ "boolean", "null" ]
1878
+ },
1879
+ "myVote" : {
1880
+ "type" : [ "string", "null" ],
1881
+ "maxLength" : 100,
1882
+ "minLength" : 0
1883
+ },
1884
+ "departmentId" : {
1885
+ "type" : [ "string", "null", "integer" ],
1886
+ "format" : "int64",
1887
+ "pattern" : "([0-9]+)"
1888
+ },
1889
+ "prev" : {
1890
+ "$ref" : "./Solution.json#/components/schemas/prevNextJson"
1891
+ },
1892
+ "dislikeCount" : {
1893
+ "type" : [ "string", "null", "integer" ],
1894
+ "format" : "int64",
1895
+ "pattern" : "([0-9]+)"
1896
+ },
1897
+ "likeCount" : {
1898
+ "type" : [ "string", "null", "integer" ],
1899
+ "format" : "int64",
1900
+ "pattern" : "([0-9]+)"
1901
+ },
1902
+ "title" : {
1903
+ "type" : [ "string", "null" ],
1904
+ "maxLength" : 100,
1905
+ "minLength" : 0
1906
+ },
1907
+ "tags" : {
1908
+ "type" : [ "null", "array" ],
1909
+ "items" : {
1910
+ "type" : [ "string", "null" ],
1911
+ "maxLength" : 100,
1912
+ "minLength" : 0
1913
+ },
1914
+ "uniqueItems" : false
1915
+ },
1916
+ "answer" : {
1917
+ "type" : [ "string", "null" ],
1918
+ "maxLength" : 16777215,
1919
+ "minLength" : 0
1920
+ },
1921
+ "webUrl" : {
1922
+ "type" : [ "string", "null" ],
1923
+ "maxLength" : 500,
1924
+ "minLength" : 0,
1925
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1926
+ },
1927
+ "createdTime" : {
1928
+ "type" : [ "string", "null" ],
1929
+ "maxLength" : 100,
1930
+ "minLength" : 0,
1931
+ "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))"
1932
+ },
1933
+ "id" : {
1934
+ "type" : [ "string", "null", "integer" ],
1935
+ "format" : "int64",
1936
+ "pattern" : "([0-9]+)"
1937
+ },
1938
+ "seo" : {
1939
+ "$ref" : "./Solution.json#/components/schemas/seo"
1940
+ },
1941
+ "permalink" : {
1942
+ "type" : [ "string", "null" ],
1943
+ "maxLength" : 100,
1944
+ "minLength" : 0,
1945
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
1946
+ },
1947
+ "categoryId" : {
1948
+ "type" : [ "string", "null", "integer" ],
1949
+ "format" : "int64",
1950
+ "pattern" : "([0-9]+)"
1951
+ }
1952
+ },
1953
+ "required" : [ "answer", "categoryId", "createdTime", "departmentId", "dislikeCount", "id", "isFollowing", "likeCount", "modifiedTime", "myVote", "next", "permalink", "prev", "seo", "tags", "title", "webUrl" ]
1954
+ },
1955
+ "prevNextJsonWithLocale" : {
1956
+ "type" : [ "object", "null" ],
1957
+ "additionalProperties" : false,
1958
+ "properties" : {
1959
+ "apiUrl" : {
1960
+ "type" : [ "string", "null" ],
1961
+ "maxLength" : 500,
1962
+ "minLength" : 0,
1963
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1964
+ },
1965
+ "webUrl" : {
1966
+ "type" : [ "string", "null" ],
1967
+ "maxLength" : 500,
1968
+ "minLength" : 0,
1969
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
1970
+ },
1971
+ "id" : {
1972
+ "type" : [ "string", "null", "integer" ],
1973
+ "format" : "int64",
1974
+ "pattern" : "([0-9]+)"
1975
+ },
1976
+ "permalink" : {
1977
+ "type" : [ "string", "null" ],
1978
+ "maxLength" : 100,
1979
+ "minLength" : 0,
1980
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
1981
+ },
1982
+ "title" : {
1983
+ "type" : [ "string", "null" ],
1984
+ "maxLength" : 100,
1985
+ "minLength" : 0
1986
+ },
1987
+ "locale" : {
1988
+ "type" : [ "string", "null" ],
1989
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
1990
+ "maxLength" : 100,
1991
+ "minLength" : 0,
1992
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
1993
+ }
1994
+ },
1995
+ "required" : [ "apiUrl", "id", "locale", "permalink", "title", "webUrl" ]
1996
+ },
1997
+ "locales" : {
1998
+ "type" : [ "object", "null" ],
1999
+ "additionalProperties" : false,
2000
+ "properties" : {
2001
+ "apiUrl" : {
2002
+ "type" : [ "string", "null" ],
2003
+ "maxLength" : 500,
2004
+ "minLength" : 0,
2005
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2006
+ },
2007
+ "webUrl" : {
2008
+ "type" : [ "string", "null" ],
2009
+ "maxLength" : 500,
2010
+ "minLength" : 0,
2011
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2012
+ },
2013
+ "locale" : {
2014
+ "type" : [ "string", "null" ],
2015
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2016
+ "maxLength" : 100,
2017
+ "minLength" : 0,
2018
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2019
+ },
2020
+ "permalink" : {
2021
+ "type" : [ "string", "null" ],
2022
+ "maxLength" : 100,
2023
+ "minLength" : 0,
2024
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
2025
+ }
2026
+ },
2027
+ "required" : [ "apiUrl", "locale", "permalink", "webUrl" ]
2028
+ },
2029
+ "localesArray" : {
2030
+ "type" : [ "array", "null" ],
2031
+ "items" : {
2032
+ "$ref" : "./Solution.json#/components/schemas/locales"
2033
+ }
2034
+ },
2035
+ "categoryJson" : {
2036
+ "type" : [ "object", "null" ],
2037
+ "additionalProperties" : false,
2038
+ "properties" : {
2039
+ "name" : {
2040
+ "type" : [ "string", "null" ],
2041
+ "maxLength" : 100,
2042
+ "minLength" : 0
2043
+ },
2044
+ "id" : {
2045
+ "type" : [ "string", "null", "integer" ],
2046
+ "format" : "int64",
2047
+ "pattern" : "([0-9]+)"
2048
+ },
2049
+ "locale" : {
2050
+ "type" : [ "string", "null" ],
2051
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2052
+ "maxLength" : 100,
2053
+ "minLength" : 0,
2054
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2055
+ }
2056
+ },
2057
+ "required" : [ "id", "locale", "name" ]
2058
+ },
2059
+ "newArticleResponse" : {
2060
+ "type" : [ "object", "null" ],
2061
+ "additionalProperties" : false,
2062
+ "properties" : {
2063
+ "summary" : {
2064
+ "type" : [ "string", "null" ],
2065
+ "maxLength" : 65553,
2066
+ "minLength" : 0
2067
+ },
2068
+ "modifiedTime" : {
2069
+ "type" : [ "string", "null" ],
2070
+ "maxLength" : 100,
2071
+ "minLength" : 0,
2072
+ "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))"
2073
+ },
2074
+ "translationId" : {
2075
+ "type" : [ "string", "null", "integer" ],
2076
+ "format" : "int64",
2077
+ "pattern" : "([0-9]+)"
2078
+ },
2079
+ "webUrl" : {
2080
+ "type" : [ "string", "null" ],
2081
+ "maxLength" : 500,
2082
+ "minLength" : 0,
2083
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2084
+ },
2085
+ "createdTime" : {
2086
+ "type" : [ "string", "null" ],
2087
+ "maxLength" : 100,
2088
+ "minLength" : 0,
2089
+ "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))"
2090
+ },
2091
+ "id" : {
2092
+ "type" : [ "string", "null", "integer" ],
2093
+ "format" : "int64",
2094
+ "pattern" : "([0-9]+)"
2095
+ },
2096
+ "title" : {
2097
+ "type" : [ "string", "null" ],
2098
+ "maxLength" : 100,
2099
+ "minLength" : 0
2100
+ },
2101
+ "locale" : {
2102
+ "type" : [ "string", "null" ],
2103
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2104
+ "maxLength" : 100,
2105
+ "minLength" : 0,
2106
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2107
+ },
2108
+ "category" : {
2109
+ "$ref" : "./Solution.json#/components/schemas/categoryJson"
2110
+ },
2111
+ "permalink" : {
2112
+ "type" : [ "string", "null" ],
2113
+ "maxLength" : 100,
2114
+ "minLength" : 0,
2115
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
2116
+ },
2117
+ "categoryId" : {
2118
+ "type" : [ "string", "null", "integer" ],
2119
+ "format" : "int64",
2120
+ "pattern" : "([0-9]+)",
2121
+ "x-custom-parameters-attributes" : {
2122
+ "removeExif" : false,
2123
+ "replacementString" : "",
2124
+ "filterMatchedContent" : false,
2125
+ "antivirus" : false,
2126
+ "allowInvalid" : false,
2127
+ "descrption" : "ID of the category to which the articles must belong",
2128
+ "secret" : false,
2129
+ "preserveCharsLimit" : 10,
2130
+ "trim" : false,
2131
+ "internalParam" : false,
2132
+ "preserveChars" : "0,5",
2133
+ "importUrl" : false,
2134
+ "decrypt" : false
2135
+ }
2136
+ },
2137
+ "rootCategoryId" : {
2138
+ "type" : [ "string", "null", "integer" ],
2139
+ "format" : "int64",
2140
+ "pattern" : "([0-9]+)",
2141
+ "x-custom-parameters-attributes" : {
2142
+ "removeExif" : false,
2143
+ "replacementString" : "",
2144
+ "filterMatchedContent" : false,
2145
+ "antivirus" : false,
2146
+ "allowInvalid" : false,
2147
+ "descrption" : "ID of the root category to which the articles must belong",
2148
+ "secret" : false,
2149
+ "preserveCharsLimit" : 10,
2150
+ "split" : ",",
2151
+ "trim" : false,
2152
+ "internalParam" : true,
2153
+ "preserveChars" : "0,5",
2154
+ "importUrl" : false,
2155
+ "decrypt" : false
2156
+ }
2157
+ }
2158
+ },
2159
+ "required" : [ "category", "categoryId", "createdTime", "id", "locale", "modifiedTime", "permalink", "rootCategoryId", "summary", "title", "translationId", "webUrl" ]
2160
+ },
2161
+ "newArticleItems" : {
2162
+ "type" : [ "array", "null" ],
2163
+ "items" : {
2164
+ "$ref" : "./Solution.json#/components/schemas/newArticleResponse"
2165
+ }
2166
+ },
2167
+ "solutionCommonResponse" : {
2168
+ "type" : [ "object", "null" ],
2169
+ "additionalProperties" : false,
2170
+ "properties" : {
2171
+ "webUrl" : {
2172
+ "type" : [ "string", "null" ],
2173
+ "maxLength" : 500,
2174
+ "minLength" : 0,
2175
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2176
+ },
2177
+ "id" : {
2178
+ "type" : [ "string", "null", "integer" ],
2179
+ "format" : "int64",
2180
+ "pattern" : "([0-9]+)"
2181
+ },
2182
+ "title" : {
2183
+ "type" : [ "string", "null" ],
2184
+ "maxLength" : 100,
2185
+ "minLength" : 0
2186
+ },
2187
+ "permalink" : {
2188
+ "type" : [ "string", "null" ],
2189
+ "maxLength" : 100,
2190
+ "minLength" : 0,
2191
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
2192
+ },
2193
+ "categoryId" : {
2194
+ "type" : [ "string", "null", "integer" ],
2195
+ "format" : "int64",
2196
+ "pattern" : "([0-9]+)",
2197
+ "x-custom-parameters-attributes" : {
2198
+ "removeExif" : false,
2199
+ "replacementString" : "",
2200
+ "filterMatchedContent" : false,
2201
+ "antivirus" : false,
2202
+ "allowInvalid" : false,
2203
+ "descrption" : "categoryId in which articles are to be fetched",
2204
+ "secret" : false,
2205
+ "preserveCharsLimit" : 10,
2206
+ "trim" : false,
2207
+ "internalParam" : false,
2208
+ "preserveChars" : "0,5",
2209
+ "importUrl" : false,
2210
+ "decrypt" : false
2211
+ }
2212
+ }
2213
+ },
2214
+ "required" : [ "categoryId", "id", "permalink", "title", "webUrl" ]
2215
+ },
2216
+ "relatedArticlesByTopic" : {
2217
+ "additionalProperties" : false,
2218
+ "allOf" : [ {
2219
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonResponse"
2220
+ }, {
2221
+ "type" : [ "object", "null" ],
2222
+ "properties" : {
2223
+ "summary" : {
2224
+ "type" : [ "string", "null" ],
2225
+ "maxLength" : 65553,
2226
+ "minLength" : 0
2227
+ }
2228
+ },
2229
+ "required" : [ "summary" ]
2230
+ } ]
2231
+ },
2232
+ "relatedArticlesByTopicData" : {
2233
+ "type" : [ "array", "null" ],
2234
+ "items" : {
2235
+ "$ref" : "./Solution.json#/components/schemas/relatedArticlesByTopic"
2236
+ }
2237
+ },
2238
+ "authorWithStatus" : {
2239
+ "type" : [ "object", "null" ],
2240
+ "additionalProperties" : false,
2241
+ "properties" : {
2242
+ "photoURL" : {
2243
+ "type" : [ "string", "null" ],
2244
+ "maxLength" : 250,
2245
+ "minLength" : 0,
2246
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2247
+ },
2248
+ "name" : {
2249
+ "type" : [ "string", "null" ],
2250
+ "maxLength" : 200,
2251
+ "minLength" : 0,
2252
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2253
+ },
2254
+ "id" : {
2255
+ "type" : [ "string", "null", "integer" ],
2256
+ "format" : "int64",
2257
+ "pattern" : "([0-9]+)"
2258
+ },
2259
+ "status" : {
2260
+ "type" : [ "string", "null" ],
2261
+ "enum" : [ "ACTIVE", "DISABLED", "LICENSE_DOWNGRADED", "DELETED", "ANONYMIZED", "CLOSED" ],
2262
+ "maxLength" : 100,
2263
+ "minLength" : 0
2264
+ },
2265
+ "zuid" : {
2266
+ "type" : [ "string", "null", "integer" ],
2267
+ "format" : "int64",
2268
+ "pattern" : "([0-9]+)"
2269
+ }
2270
+ },
2271
+ "required" : [ "id", "name", "photoURL", "status", "zuid" ]
2272
+ },
2273
+ "articleAttachmentResponse" : {
2274
+ "type" : [ "object", "null" ],
2275
+ "additionalProperties" : false,
2276
+ "properties" : {
2277
+ "contentUrl" : {
2278
+ "type" : [ "string", "null" ],
2279
+ "maxLength" : 500,
2280
+ "minLength" : 0,
2281
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2282
+ },
2283
+ "size" : {
2284
+ "type" : [ "string", "null", "integer" ],
2285
+ "format" : "int64",
2286
+ "pattern" : "([0-9]+)"
2287
+ },
2288
+ "name" : {
2289
+ "type" : [ "string", "null" ],
2290
+ "maxLength" : 500,
2291
+ "minLength" : 0
2292
+ },
2293
+ "createdTime" : {
2294
+ "type" : [ "string", "null" ],
2295
+ "maxLength" : 100,
2296
+ "minLength" : 0,
2297
+ "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))"
2298
+ },
2299
+ "inlineUrl" : {
2300
+ "type" : [ "string", "null" ],
2301
+ "maxLength" : 500,
2302
+ "minLength" : 0,
2303
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2304
+ },
2305
+ "id" : {
2306
+ "type" : [ "string", "null", "integer" ],
2307
+ "format" : "int64",
2308
+ "pattern" : "([0-9]+)"
2309
+ }
2310
+ },
2311
+ "required" : [ "contentUrl", "createdTime", "id", "inlineUrl", "name", "size" ]
2312
+ },
2313
+ "attachmentsData" : {
2314
+ "type" : [ "array", "null" ],
2315
+ "items" : {
2316
+ "$ref" : "./Solution.json#/components/schemas/articleAttachmentResponse"
2317
+ }
2318
+ }
2319
+ },
2320
+ "responses" : {
2321
+ "articleListResponse" : {
2322
+ "description" : "articleListResponse template definitions",
2323
+ "content" : {
2324
+ "application/json" : {
2325
+ "schema" : {
2326
+ "allOf" : [ {
2327
+ "type" : "object",
2328
+ "properties" : {
2329
+ "data" : {
2330
+ "type" : "array",
2331
+ "items" : {
2332
+ "type" : "object",
2333
+ "properties" : {
2334
+ "parentCategories" : {
2335
+ "type" : [ "null", "array" ],
2336
+ "items" : {
2337
+ "type" : [ "null", "object" ],
2338
+ "additionalProperties" : false,
2339
+ "maxProperties" : 6,
2340
+ "minProperties" : 6,
2341
+ "properties" : {
2342
+ "webUrl" : {
2343
+ "type" : [ "string", "null" ],
2344
+ "maxLength" : 255,
2345
+ "minLength" : 3,
2346
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
2347
+ },
2348
+ "name" : {
2349
+ "type" : [ "string", "null" ],
2350
+ "maxLength" : 100,
2351
+ "minLength" : 0
2352
+ },
2353
+ "id" : {
2354
+ "type" : [ "string", "null", "integer" ],
2355
+ "format" : "int64",
2356
+ "pattern" : "([0-9]+)"
2357
+ },
2358
+ "translatedName" : {
2359
+ "type" : [ "string", "null" ],
2360
+ "maxLength" : 100,
2361
+ "minLength" : 0
2362
+ },
2363
+ "permalink" : {
2364
+ "type" : [ "string", "null" ],
2365
+ "maxLength" : 100,
2366
+ "minLength" : 0,
2367
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2368
+ },
2369
+ "locale" : {
2370
+ "type" : [ "string", "null" ],
2371
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2372
+ "maxLength" : 100,
2373
+ "minLength" : 0,
2374
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2375
+ }
2376
+ },
2377
+ "required" : [ "id", "locale", "name", "permalink", "translatedName", "webUrl" ]
2378
+ },
2379
+ "uniqueItems" : false
2380
+ }
2381
+ }
2382
+ }
2383
+ }
2384
+ }
2385
+ }, {
2386
+ "type" : [ "object", "null" ],
2387
+ "additionalProperties" : false,
2388
+ "properties" : {
2389
+ "data" : {
2390
+ "$ref" : "./Solution.json#/components/schemas/articleListItems"
2391
+ }
2392
+ },
2393
+ "required" : [ "data" ]
2394
+ } ]
2395
+ },
2396
+ "examples" : {
2397
+ "Valid responses Definitions" : {
2398
+ "value" : {
2399
+ "data" : [ {
2400
+ "summary" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly.The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save time on frequently asked questions.<br><br>Every action that you can perform with respect to a ticket has a corresponding keyboard shortcut.",
2401
+ "modifiedTime" : "2019-11-04T05:10:46.000Z",
2402
+ "translationId" : "292101000000332013",
2403
+ "webUrl" : "https://desk.zoho.com/portal/informatica/en/kb/articles/answering-your-first-ticket",
2404
+ "createdTime" : "2018-12-27T06:58:26.000Z",
2405
+ "id" : "292101000001113069",
2406
+ "category" : {
2407
+ "name" : "1",
2408
+ "id" : "292101000000216021",
2409
+ "locale" : "en"
2410
+ },
2411
+ "title" : "Answering your first ticket.",
2412
+ "permalink" : "answering-your-first-ticket",
2413
+ "locale" : "en",
2414
+ "categoryId" : "292101000000216021",
2415
+ "rootCategoryId" : "292101000000088379"
2416
+ } ]
2417
+ }
2418
+ }
2419
+ }
2420
+ }
2421
+ },
2422
+ "x-custom-response-attributes" : {
2423
+ "disable-safe-headers" : "[]"
2424
+ }
2425
+ },
2426
+ "retriveAnArticleResponse" : {
2427
+ "description" : "retriveAnArticleResponse template definitions",
2428
+ "content" : {
2429
+ "application/json" : {
2430
+ "schema" : {
2431
+ "allOf" : [ {
2432
+ "type" : "object",
2433
+ "properties" : {
2434
+ "parentCategories" : {
2435
+ "type" : [ "null", "array" ],
2436
+ "items" : {
2437
+ "type" : [ "null", "object" ],
2438
+ "additionalProperties" : false,
2439
+ "maxProperties" : 6,
2440
+ "minProperties" : 6,
2441
+ "properties" : {
2442
+ "webUrl" : {
2443
+ "type" : [ "string", "null" ],
2444
+ "maxLength" : 255,
2445
+ "minLength" : 3,
2446
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
2447
+ },
2448
+ "name" : {
2449
+ "type" : [ "string", "null" ],
2450
+ "maxLength" : 100,
2451
+ "minLength" : 0
2452
+ },
2453
+ "id" : {
2454
+ "type" : [ "string", "null", "integer" ],
2455
+ "format" : "int64",
2456
+ "pattern" : "([0-9]+)"
2457
+ },
2458
+ "translatedName" : {
2459
+ "type" : [ "string", "null" ],
2460
+ "maxLength" : 100,
2461
+ "minLength" : 0
2462
+ },
2463
+ "permalink" : {
2464
+ "type" : [ "string", "null" ],
2465
+ "maxLength" : 100,
2466
+ "minLength" : 0,
2467
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2468
+ },
2469
+ "locale" : {
2470
+ "type" : [ "string", "null" ],
2471
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2472
+ "maxLength" : 100,
2473
+ "minLength" : 0,
2474
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2475
+ }
2476
+ },
2477
+ "required" : [ "id", "locale", "name", "permalink", "translatedName", "webUrl" ]
2478
+ },
2479
+ "uniqueItems" : false
2480
+ }
2481
+ }
2482
+ }, {
2483
+ "anyOf" : [ {
2484
+ "additionalProperties" : false,
2485
+ "allOf" : [ {
2486
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonJson"
2487
+ }, {
2488
+ "type" : [ "object", "null" ],
2489
+ "properties" : {
2490
+ "author" : {
2491
+ "$ref" : "./Solution.json#/components/schemas/author"
2492
+ },
2493
+ "followersCount" : {
2494
+ "type" : [ "string", "null", "integer" ],
2495
+ "format" : "int32",
2496
+ "pattern" : "([0-9]+)"
2497
+ },
2498
+ "commentCount" : {
2499
+ "type" : [ "string", "null", "integer" ],
2500
+ "format" : "int32",
2501
+ "pattern" : "([0-9]+)"
2502
+ }
2503
+ },
2504
+ "required" : [ "author", "commentCount", "followersCount" ]
2505
+ } ]
2506
+ }, {
2507
+ "additionalProperties" : false,
2508
+ "allOf" : [ {
2509
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonResponseWithLocale"
2510
+ }, {
2511
+ "type" : [ "object", "null" ],
2512
+ "properties" : {
2513
+ "next" : {
2514
+ "$ref" : "./Solution.json#/components/schemas/prevNextJsonWithLocale"
2515
+ },
2516
+ "summary" : {
2517
+ "type" : [ "string", "null" ],
2518
+ "maxLength" : 65553,
2519
+ "minLength" : 0
2520
+ },
2521
+ "modifiedTime" : {
2522
+ "type" : [ "string", "null" ],
2523
+ "maxLength" : 100,
2524
+ "minLength" : 0,
2525
+ "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))"
2526
+ },
2527
+ "isFollowing" : {
2528
+ "type" : [ "boolean", "null" ]
2529
+ },
2530
+ "myVote" : {
2531
+ "type" : [ "string", "null" ],
2532
+ "maxLength" : 100,
2533
+ "minLength" : 0
2534
+ },
2535
+ "author" : {
2536
+ "$ref" : "./Solution.json#/components/schemas/author"
2537
+ },
2538
+ "departmentId" : {
2539
+ "type" : [ "string", "null", "integer" ],
2540
+ "format" : "int64",
2541
+ "pattern" : "([0-9]+)"
2542
+ },
2543
+ "prev" : {
2544
+ "$ref" : "./Solution.json#/components/schemas/prevNextJsonWithLocale"
2545
+ },
2546
+ "dislikeCount" : {
2547
+ "type" : [ "string", "null", "integer" ],
2548
+ "format" : "int64",
2549
+ "pattern" : "([0-9]+)"
2550
+ },
2551
+ "likeCount" : {
2552
+ "type" : [ "string", "null", "integer" ],
2553
+ "format" : "int64",
2554
+ "pattern" : "([0-9]+)"
2555
+ },
2556
+ "tags" : {
2557
+ "type" : [ "null", "array" ],
2558
+ "items" : {
2559
+ "type" : [ "string", "null" ],
2560
+ "maxLength" : 100,
2561
+ "minLength" : 0
2562
+ },
2563
+ "uniqueItems" : false
2564
+ },
2565
+ "rootCategoryId" : {
2566
+ "type" : [ "string", "null", "integer" ],
2567
+ "format" : "int64",
2568
+ "pattern" : "([0-9]+)"
2569
+ },
2570
+ "commentCount" : {
2571
+ "type" : [ "string", "null", "integer" ],
2572
+ "format" : "int32",
2573
+ "pattern" : "([0-9]+)"
2574
+ },
2575
+ "locales" : {
2576
+ "$ref" : "./Solution.json#/components/schemas/localesArray"
2577
+ },
2578
+ "answer" : {
2579
+ "type" : [ "string", "null" ],
2580
+ "maxLength" : 16777215,
2581
+ "minLength" : 0
2582
+ },
2583
+ "translationId" : {
2584
+ "type" : [ "string", "null", "integer" ],
2585
+ "format" : "int64",
2586
+ "pattern" : "([0-9]+)"
2587
+ },
2588
+ "createdTime" : {
2589
+ "type" : [ "string", "null" ],
2590
+ "maxLength" : 100,
2591
+ "minLength" : 0,
2592
+ "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))"
2593
+ },
2594
+ "followersCount" : {
2595
+ "type" : [ "string", "null", "integer" ],
2596
+ "format" : "int32",
2597
+ "pattern" : "([0-9]+)"
2598
+ },
2599
+ "seo" : {
2600
+ "$ref" : "./Solution.json#/components/schemas/seo"
2601
+ },
2602
+ "category" : {
2603
+ "$ref" : "./Solution.json#/components/schemas/categoryJson"
2604
+ }
2605
+ },
2606
+ "required" : [ "answer", "author", "category", "commentCount", "createdTime", "departmentId", "dislikeCount", "followersCount", "isFollowing", "likeCount", "locales", "modifiedTime", "myVote", "next", "prev", "rootCategoryId", "seo", "summary", "tags", "translationId" ]
2607
+ } ]
2608
+ } ]
2609
+ } ]
2610
+ },
2611
+ "examples" : {
2612
+ "Valid responses Definitions" : {
2613
+ "value" : {
2614
+ "summary" : "Looking for a detachable keyboard for your zPad",
2615
+ "modifiedTime" : "2019-11-04T05:10:46.000Z",
2616
+ "isFollowing" : true,
2617
+ "myVote" : null,
2618
+ "author" : {
2619
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/292101000000088033/photo?orgId=669661594",
2620
+ "name" : "Yod Agbaria",
2621
+ "id" : "292101000000088033",
2622
+ "status" : "ACTIVE",
2623
+ "zuid" : "32435"
2624
+ },
2625
+ "departmentId" : "292101000000006907",
2626
+ "dislikeCount" : "2",
2627
+ "likeCount" : "110",
2628
+ "title" : "Buying a detachable keyboard",
2629
+ "locale" : "en",
2630
+ "tags" : [ "detachable keyboard", "zpad", "zboard", "accessory" ],
2631
+ "rootCategoryId" : "292101000000088379",
2632
+ "locales" : [ {
2633
+ "apiUrl" : "https://desk.zoho.com/portal/api/kbArticles/292101000001113049/locale/en?portalId=ae075d0de8621f986c07c1fe256e4243",
2634
+ "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
2635
+ "permalink" : "buying-a-detachable-keyboard",
2636
+ "locale" : "en"
2637
+ } ],
2638
+ "answer" : "If you're looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories.<br /><br />Here&#39;s a list of Zylker showrooms - https://www.zylker.com/storefinder<br /><br />You can drop in any time between 10:00 AM and 10:00 PM, any day, to pick out a zBoard.<br />",
2639
+ "translationId" : "292101000000200029",
2640
+ "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
2641
+ "createdTime" : "2018-09-08T06:52:36.000Z",
2642
+ "followersCount" : "1",
2643
+ "id" : "292101000001113049",
2644
+ "category" : {
2645
+ "name" : "1",
2646
+ "id" : "292101000000216021",
2647
+ "locale" : "en"
2648
+ },
2649
+ "permalink" : "buying-a-detachable-keyboard",
2650
+ "seo" : {
2651
+ "keywords" : "zPad, detachable keyboard, accessory, zBoard",
2652
+ "isEnabled" : true,
2653
+ "description" : "Follow these steps for buying a detachable keyboard.",
2654
+ "title" : "Buying a detachable keyboard"
2655
+ },
2656
+ "categoryId" : "292101000000216021"
2657
+ }
2658
+ }
2659
+ }
2660
+ }
2661
+ },
2662
+ "x-custom-response-attributes" : {
2663
+ "disable-safe-headers" : "[]"
2664
+ }
2665
+ },
2666
+ "newArticleList" : {
2667
+ "description" : "newArticleList template definitions",
2668
+ "content" : {
2669
+ "application/json" : {
2670
+ "schema" : {
2671
+ "allOf" : [ {
2672
+ "type" : "object",
2673
+ "properties" : {
2674
+ "data" : {
2675
+ "type" : "array",
2676
+ "items" : {
2677
+ "type" : "object",
2678
+ "properties" : {
2679
+ "parentCategories" : {
2680
+ "type" : [ "null", "array" ],
2681
+ "items" : {
2682
+ "type" : [ "null", "object" ],
2683
+ "additionalProperties" : false,
2684
+ "maxProperties" : 6,
2685
+ "minProperties" : 6,
2686
+ "properties" : {
2687
+ "webUrl" : {
2688
+ "type" : [ "string", "null" ],
2689
+ "maxLength" : 255,
2690
+ "minLength" : 3,
2691
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
2692
+ },
2693
+ "name" : {
2694
+ "type" : [ "string", "null" ],
2695
+ "maxLength" : 100,
2696
+ "minLength" : 0
2697
+ },
2698
+ "id" : {
2699
+ "type" : [ "string", "null", "integer" ],
2700
+ "format" : "int64",
2701
+ "pattern" : "([0-9]+)"
2702
+ },
2703
+ "translatedName" : {
2704
+ "type" : [ "string", "null" ],
2705
+ "maxLength" : 100,
2706
+ "minLength" : 0
2707
+ },
2708
+ "permalink" : {
2709
+ "type" : [ "string", "null" ],
2710
+ "maxLength" : 100,
2711
+ "minLength" : 0,
2712
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2713
+ },
2714
+ "locale" : {
2715
+ "type" : [ "string", "null" ],
2716
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2717
+ "maxLength" : 100,
2718
+ "minLength" : 0,
2719
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2720
+ }
2721
+ },
2722
+ "required" : [ "id", "locale", "name", "permalink", "translatedName", "webUrl" ]
2723
+ },
2724
+ "uniqueItems" : false
2725
+ }
2726
+ }
2727
+ }
2728
+ }
2729
+ }
2730
+ }, {
2731
+ "type" : [ "object", "null" ],
2732
+ "additionalProperties" : false,
2733
+ "properties" : {
2734
+ "data" : {
2735
+ "$ref" : "./Solution.json#/components/schemas/newArticleItems"
2736
+ }
2737
+ },
2738
+ "required" : [ "data" ]
2739
+ } ]
2740
+ },
2741
+ "examples" : {
2742
+ "Valid responses Definitions" : {
2743
+ "value" : {
2744
+ "data" : [ {
2745
+ "summary" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save time on ",
2746
+ "webUrl" : "https://desk.zoho.com/portal/yahya1608/kb/articles/answering-your-first-tickets",
2747
+ "id" : "180757000000069120",
2748
+ "title" : "Answering your first ticket.",
2749
+ "permalink" : "answering-your-first-tickets",
2750
+ "categoryId" : "180757000000604004"
2751
+ } ]
2752
+ }
2753
+ }
2754
+ }
2755
+ }
2756
+ },
2757
+ "x-custom-response-attributes" : {
2758
+ "disable-safe-headers" : "[]"
2759
+ }
2760
+ },
2761
+ "articleAnswerResponse" : {
2762
+ "description" : "articleAnswerResponse template definitions",
2763
+ "content" : {
2764
+ "application/json" : {
2765
+ "schema" : {
2766
+ "type" : [ "object", "null" ],
2767
+ "additionalProperties" : false,
2768
+ "properties" : {
2769
+ "answer" : {
2770
+ "type" : [ "string", "null" ],
2771
+ "maxLength" : 16777215,
2772
+ "minLength" : 0
2773
+ }
2774
+ },
2775
+ "required" : [ "answer" ]
2776
+ },
2777
+ "examples" : {
2778
+ "Valid responses Definitions" : {
2779
+ "value" : {
2780
+ "answer" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save time on "
2781
+ }
2782
+ }
2783
+ }
2784
+ }
2785
+ },
2786
+ "x-custom-response-attributes" : {
2787
+ "disable-safe-headers" : "[]"
2788
+ }
2789
+ },
2790
+ "searchRelatedArticlesResponse" : {
2791
+ "description" : "searchRelatedArticlesResponse template definitions",
2792
+ "content" : {
2793
+ "application/json" : {
2794
+ "schema" : {
2795
+ "anyOf" : [ {
2796
+ "type" : [ "object", "null" ],
2797
+ "additionalProperties" : false,
2798
+ "properties" : {
2799
+ "data" : {
2800
+ "$ref" : "./Solution.json#/components/schemas/relatedArticlesByTopicData"
2801
+ }
2802
+ },
2803
+ "required" : [ "data" ]
2804
+ }, {
2805
+ "type" : [ "object", "null" ],
2806
+ "additionalProperties" : false,
2807
+ "properties" : {
2808
+ "data" : {
2809
+ "$ref" : "./Solution.json#/components/schemas/articleListItems"
2810
+ }
2811
+ },
2812
+ "required" : [ "data" ]
2813
+ } ]
2814
+ },
2815
+ "examples" : {
2816
+ "Valid responses Definitions" : {
2817
+ "value" : null
2818
+ }
2819
+ }
2820
+ }
2821
+ },
2822
+ "x-custom-response-attributes" : {
2823
+ "disable-safe-headers" : "[]"
2824
+ }
2825
+ },
2826
+ "previousNextArticleWithLocale" : {
2827
+ "description" : "previousNextArticleWithLocale template definitions",
2828
+ "content" : {
2829
+ "application/json" : {
2830
+ "schema" : {
2831
+ "type" : [ "object", "null" ],
2832
+ "additionalProperties" : false,
2833
+ "properties" : {
2834
+ "previousArticles" : {
2835
+ "$ref" : "./Solution.json#/components/schemas/newArticleItems"
2836
+ },
2837
+ "nextArticles" : {
2838
+ "$ref" : "./Solution.json#/components/schemas/newArticleItems"
2839
+ }
2840
+ },
2841
+ "required" : [ "nextArticles", "previousArticles" ]
2842
+ },
2843
+ "examples" : {
2844
+ "Valid responses Definitions" : {
2845
+ "value" : null
2846
+ }
2847
+ }
2848
+ }
2849
+ },
2850
+ "x-custom-response-attributes" : {
2851
+ "disable-safe-headers" : "[]"
2852
+ }
2853
+ },
2854
+ "articleByPermalinkResponse" : {
2855
+ "description" : "articleByPermalinkResponse template definitions",
2856
+ "content" : {
2857
+ "application/json" : {
2858
+ "schema" : {
2859
+ "allOf" : [ {
2860
+ "type" : "object",
2861
+ "properties" : {
2862
+ "locales" : {
2863
+ "type" : [ "null", "array" ],
2864
+ "items" : {
2865
+ "type" : [ "null", "object" ],
2866
+ "additionalProperties" : false,
2867
+ "maxProperties" : 4,
2868
+ "minProperties" : 4,
2869
+ "properties" : {
2870
+ "apiUrl" : {
2871
+ "type" : [ "string", "null" ],
2872
+ "maxLength" : 500,
2873
+ "minLength" : 0,
2874
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
2875
+ },
2876
+ "webUrl" : {
2877
+ "type" : [ "string", "null" ],
2878
+ "maxLength" : 500,
2879
+ "minLength" : 0,
2880
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
2881
+ },
2882
+ "locale" : {
2883
+ "type" : [ "string", "null" ],
2884
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2885
+ "maxLength" : 100,
2886
+ "minLength" : 0,
2887
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2888
+ },
2889
+ "permalink" : {
2890
+ "type" : [ "string", "null" ],
2891
+ "maxLength" : 100,
2892
+ "minLength" : 0,
2893
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
2894
+ }
2895
+ },
2896
+ "required" : [ "apiUrl", "locale", "permalink", "webUrl" ]
2897
+ },
2898
+ "uniqueItems" : false
2899
+ },
2900
+ "parentCategories" : {
2901
+ "type" : [ "null", "array" ],
2902
+ "items" : {
2903
+ "type" : [ "null", "object" ],
2904
+ "additionalProperties" : false,
2905
+ "maxProperties" : 6,
2906
+ "minProperties" : 6,
2907
+ "properties" : {
2908
+ "webUrl" : {
2909
+ "type" : [ "string", "null" ],
2910
+ "maxLength" : 255,
2911
+ "minLength" : 3,
2912
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
2913
+ },
2914
+ "name" : {
2915
+ "type" : [ "string", "null" ],
2916
+ "maxLength" : 100,
2917
+ "minLength" : 0
2918
+ },
2919
+ "id" : {
2920
+ "type" : [ "string", "null", "integer" ],
2921
+ "format" : "int64",
2922
+ "pattern" : "([0-9]+)"
2923
+ },
2924
+ "translatedName" : {
2925
+ "type" : [ "string", "null" ],
2926
+ "maxLength" : 100,
2927
+ "minLength" : 0
2928
+ },
2929
+ "permalink" : {
2930
+ "type" : [ "string", "null" ],
2931
+ "maxLength" : 100,
2932
+ "minLength" : 0,
2933
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
2934
+ },
2935
+ "locale" : {
2936
+ "type" : [ "string", "null" ],
2937
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
2938
+ "maxLength" : 100,
2939
+ "minLength" : 0,
2940
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
2941
+ }
2942
+ },
2943
+ "required" : [ "id", "locale", "name", "permalink", "translatedName", "webUrl" ]
2944
+ },
2945
+ "uniqueItems" : false
2946
+ }
2947
+ }
2948
+ }, {
2949
+ "oneOf" : [ {
2950
+ "additionalProperties" : false,
2951
+ "allOf" : [ {
2952
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonJson"
2953
+ }, {
2954
+ "type" : [ "object", "null" ],
2955
+ "properties" : {
2956
+ "author" : {
2957
+ "$ref" : "./Solution.json#/components/schemas/author"
2958
+ },
2959
+ "followersCount" : {
2960
+ "type" : [ "string", "null", "integer" ],
2961
+ "format" : "int32",
2962
+ "pattern" : "([0-9]+)"
2963
+ },
2964
+ "commentCount" : {
2965
+ "type" : [ "string", "null", "integer" ],
2966
+ "format" : "int32",
2967
+ "pattern" : "([0-9]+)"
2968
+ }
2969
+ },
2970
+ "required" : [ "author", "commentCount", "followersCount" ]
2971
+ } ]
2972
+ }, {
2973
+ "type" : [ "object", "null" ],
2974
+ "additionalProperties" : false,
2975
+ "properties" : {
2976
+ "summary" : {
2977
+ "type" : [ "string", "null" ],
2978
+ "maxLength" : 65553,
2979
+ "minLength" : 0
2980
+ },
2981
+ "next" : {
2982
+ "$ref" : "./Solution.json#/components/schemas/prevNextJson"
2983
+ },
2984
+ "modifiedTime" : {
2985
+ "type" : [ "string", "null" ],
2986
+ "maxLength" : 100,
2987
+ "minLength" : 0,
2988
+ "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))"
2989
+ },
2990
+ "isFollowing" : {
2991
+ "type" : [ "boolean", "null" ]
2992
+ },
2993
+ "myVote" : {
2994
+ "type" : [ "string", "null" ],
2995
+ "maxLength" : 100,
2996
+ "minLength" : 0
2997
+ },
2998
+ "author" : {
2999
+ "$ref" : "./Solution.json#/components/schemas/authorWithStatus"
3000
+ },
3001
+ "departmentId" : {
3002
+ "type" : [ "string", "null", "integer" ],
3003
+ "format" : "int64",
3004
+ "pattern" : "([0-9]+)"
3005
+ },
3006
+ "prev" : {
3007
+ "$ref" : "./Solution.json#/components/schemas/prevNextJson"
3008
+ },
3009
+ "dislikeCount" : {
3010
+ "type" : [ "string", "null", "integer" ],
3011
+ "format" : "int64",
3012
+ "pattern" : "([0-9]+)"
3013
+ },
3014
+ "likeCount" : {
3015
+ "type" : [ "string", "null", "integer" ],
3016
+ "format" : "int64",
3017
+ "pattern" : "([0-9]+)"
3018
+ },
3019
+ "title" : {
3020
+ "type" : [ "string", "null" ],
3021
+ "maxLength" : 100,
3022
+ "minLength" : 0
3023
+ },
3024
+ "locale" : {
3025
+ "type" : [ "string", "null" ],
3026
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
3027
+ "maxLength" : 100,
3028
+ "minLength" : 0,
3029
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
3030
+ },
3031
+ "tags" : {
3032
+ "type" : [ "null", "array" ],
3033
+ "items" : {
3034
+ "type" : [ "string", "null" ],
3035
+ "maxLength" : 100,
3036
+ "minLength" : 0
3037
+ },
3038
+ "uniqueItems" : false
3039
+ },
3040
+ "rootCategoryId" : {
3041
+ "type" : [ "string", "null", "integer" ],
3042
+ "format" : "int64",
3043
+ "pattern" : "([0-9]+)"
3044
+ },
3045
+ "answer" : {
3046
+ "type" : [ "string", "null" ],
3047
+ "maxLength" : 16777215,
3048
+ "minLength" : 0
3049
+ },
3050
+ "translationId" : {
3051
+ "type" : [ "string", "null", "integer" ],
3052
+ "format" : "int64",
3053
+ "pattern" : "([0-9]+)"
3054
+ },
3055
+ "webUrl" : {
3056
+ "type" : [ "string", "null" ],
3057
+ "maxLength" : 500,
3058
+ "minLength" : 0,
3059
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3060
+ },
3061
+ "createdTime" : {
3062
+ "type" : [ "string", "null" ],
3063
+ "maxLength" : 100,
3064
+ "minLength" : 0,
3065
+ "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))"
3066
+ },
3067
+ "id" : {
3068
+ "type" : [ "string", "null", "integer" ],
3069
+ "format" : "int64",
3070
+ "pattern" : "([0-9]+)"
3071
+ },
3072
+ "followersCount" : {
3073
+ "type" : [ "string", "null", "integer" ],
3074
+ "format" : "int32",
3075
+ "pattern" : "([0-9]+)"
3076
+ },
3077
+ "seo" : {
3078
+ "$ref" : "./Solution.json#/components/schemas/seo"
3079
+ },
3080
+ "category" : {
3081
+ "$ref" : "./Solution.json#/components/schemas/categoryJson"
3082
+ },
3083
+ "permalink" : {
3084
+ "type" : [ "string", "null" ],
3085
+ "maxLength" : 100,
3086
+ "minLength" : 0,
3087
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*",
3088
+ "x-custom-parameters-attributes" : {
3089
+ "removeExif" : false,
3090
+ "replacementString" : "",
3091
+ "filterMatchedContent" : false,
3092
+ "antivirus" : false,
3093
+ "allowInvalid" : false,
3094
+ "descrption" : "String to get solution id",
3095
+ "secret" : false,
3096
+ "preserveCharsLimit" : 10,
3097
+ "trim" : false,
3098
+ "internalParam" : false,
3099
+ "preserveChars" : "0,5",
3100
+ "importUrl" : false,
3101
+ "decrypt" : false
3102
+ }
3103
+ },
3104
+ "categoryId" : {
3105
+ "type" : [ "string", "null", "integer" ],
3106
+ "format" : "int64",
3107
+ "pattern" : "([0-9]+)"
3108
+ }
3109
+ },
3110
+ "required" : [ "answer", "author", "category", "categoryId", "createdTime", "departmentId", "dislikeCount", "followersCount", "id", "isFollowing", "likeCount", "locale", "modifiedTime", "myVote", "next", "permalink", "prev", "rootCategoryId", "seo", "summary", "tags", "title", "translationId", "webUrl" ]
3111
+ } ]
3112
+ } ]
3113
+ },
3114
+ "examples" : {
3115
+ "Valid responses Definitions" : {
3116
+ "value" : {
3117
+ "next" : "https://desk.zoho.com/portal/api/kbArticles/articleByPermalink?portalId=ae075d0de8621f986c07c1fe256e4243&permalink=test",
3118
+ "modifiedTime" : "2017-06-27T09:57:15.000Z",
3119
+ "isFollowing" : true,
3120
+ "myVote" : null,
3121
+ "prev" : "https://desk.zoho.com/portal/api/kbArticles/articleByPermalink?portalId=ae075d0de8621f986c07c1fe256e4243&permalink=test",
3122
+ "departmentId" : "17883000000006907",
3123
+ "dislikeCount" : "6",
3124
+ "likeCount" : "3",
3125
+ "title" : "Answering your first ticket.",
3126
+ "tags" : [ "first ticket" ],
3127
+ "answer" : "<p>Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly.<br><br>The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save time on frequently asked questions.<br><br>Every action that you can perform with respect to a ticket has a corresponding keyboard shortcut. With these, you can optimize the time you spend on each ticket. (And the shortcut to access these shortcuts is Shift + ? ).When you need to quickly consult a colleague, you can tag them in a ticket comment without having to leave this screen. That's like a quick chat, without even leaving your place, and with the full context of the ticket.<br><br>With these, you're good to go.<br><br>Go on, save the world from bad customer service!</p>",
3128
+ "createdTime" : "2017-04-11T11:17:55.000Z",
3129
+ "followersCount" : "1",
3130
+ "id" : "17883000000087122",
3131
+ "permalink" : "answering-your-first-ticket",
3132
+ "seo" : {
3133
+ "keywords" : "zPad, detachable keyboard, accessory, zBoard",
3134
+ "isEnabled" : true,
3135
+ "description" : "Follow these steps for buying a detachable keyboard.",
3136
+ "title" : "Buying a detachable keyboard"
3137
+ },
3138
+ "categoryId" : "17883000000087119"
3139
+ }
3140
+ }
3141
+ }
3142
+ }
3143
+ },
3144
+ "x-custom-response-attributes" : {
3145
+ "disable-safe-headers" : "[]"
3146
+ }
3147
+ },
3148
+ "solutionCommonJsonWithoutLocales" : {
3149
+ "description" : "solutionCommonJsonWithoutLocales template definitions",
3150
+ "content" : {
3151
+ "application/json" : {
3152
+ "schema" : {
3153
+ "allOf" : [ {
3154
+ "type" : "object",
3155
+ "properties" : {
3156
+ "locales" : {
3157
+ "type" : [ "null", "array" ],
3158
+ "items" : {
3159
+ "type" : [ "null", "object" ],
3160
+ "additionalProperties" : false,
3161
+ "maxProperties" : 4,
3162
+ "minProperties" : 4,
3163
+ "properties" : {
3164
+ "apiUrl" : {
3165
+ "type" : [ "string", "null" ],
3166
+ "maxLength" : 500,
3167
+ "minLength" : 0,
3168
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3169
+ },
3170
+ "webUrl" : {
3171
+ "type" : [ "string", "null" ],
3172
+ "maxLength" : 500,
3173
+ "minLength" : 0,
3174
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3175
+ },
3176
+ "locale" : {
3177
+ "type" : [ "string", "null" ],
3178
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
3179
+ "maxLength" : 100,
3180
+ "minLength" : 0,
3181
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
3182
+ },
3183
+ "permalink" : {
3184
+ "type" : [ "string", "null" ],
3185
+ "maxLength" : 100,
3186
+ "minLength" : 0,
3187
+ "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
3188
+ }
3189
+ },
3190
+ "required" : [ "apiUrl", "locale", "permalink", "webUrl" ]
3191
+ },
3192
+ "uniqueItems" : false
3193
+ },
3194
+ "parentCategories" : {
3195
+ "type" : [ "null", "array" ],
3196
+ "items" : {
3197
+ "type" : [ "null", "object" ],
3198
+ "additionalProperties" : false,
3199
+ "maxProperties" : 6,
3200
+ "minProperties" : 6,
3201
+ "properties" : {
3202
+ "webUrl" : {
3203
+ "type" : [ "string", "null" ],
3204
+ "maxLength" : 255,
3205
+ "minLength" : 3,
3206
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3207
+ },
3208
+ "name" : {
3209
+ "type" : [ "string", "null" ],
3210
+ "maxLength" : 100,
3211
+ "minLength" : 0
3212
+ },
3213
+ "id" : {
3214
+ "type" : [ "string", "null", "integer" ],
3215
+ "format" : "int64",
3216
+ "pattern" : "([0-9]+)"
3217
+ },
3218
+ "translatedName" : {
3219
+ "type" : [ "string", "null" ],
3220
+ "maxLength" : 100,
3221
+ "minLength" : 0
3222
+ },
3223
+ "permalink" : {
3224
+ "type" : [ "string", "null" ],
3225
+ "maxLength" : 100,
3226
+ "minLength" : 0,
3227
+ "pattern" : "[a-z0-9\\/%\\-\\P{InBasicLatin}]+"
3228
+ },
3229
+ "locale" : {
3230
+ "type" : [ "string", "null" ],
3231
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
3232
+ "maxLength" : 100,
3233
+ "minLength" : 0,
3234
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
3235
+ }
3236
+ },
3237
+ "required" : [ "id", "locale", "name", "permalink", "translatedName", "webUrl" ]
3238
+ },
3239
+ "uniqueItems" : false
3240
+ }
3241
+ }
3242
+ }, {
3243
+ "additionalProperties" : false,
3244
+ "allOf" : [ {
3245
+ "$ref" : "./Solution.json#/components/schemas/solutionCommonResponseWithLocale"
3246
+ }, {
3247
+ "type" : [ "object", "null" ],
3248
+ "properties" : {
3249
+ "next" : {
3250
+ "$ref" : "./Solution.json#/components/schemas/prevNextJsonWithLocale"
3251
+ },
3252
+ "summary" : {
3253
+ "type" : [ "string", "null" ],
3254
+ "maxLength" : 65553,
3255
+ "minLength" : 0
3256
+ },
3257
+ "modifiedTime" : {
3258
+ "type" : [ "string", "null" ],
3259
+ "maxLength" : 100,
3260
+ "minLength" : 0,
3261
+ "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))"
3262
+ },
3263
+ "isFollowing" : {
3264
+ "type" : [ "boolean", "null" ]
3265
+ },
3266
+ "myVote" : {
3267
+ "type" : [ "string", "null" ],
3268
+ "maxLength" : 100,
3269
+ "minLength" : 0
3270
+ },
3271
+ "author" : {
3272
+ "$ref" : "./Solution.json#/components/schemas/author"
3273
+ },
3274
+ "departmentId" : {
3275
+ "type" : [ "string", "null", "integer" ],
3276
+ "format" : "int64",
3277
+ "pattern" : "([0-9]+)"
3278
+ },
3279
+ "prev" : {
3280
+ "$ref" : "./Solution.json#/components/schemas/prevNextJsonWithLocale"
3281
+ },
3282
+ "dislikeCount" : {
3283
+ "type" : [ "string", "null", "integer" ],
3284
+ "format" : "int64",
3285
+ "pattern" : "([0-9]+)"
3286
+ },
3287
+ "likeCount" : {
3288
+ "type" : [ "string", "null", "integer" ],
3289
+ "format" : "int64",
3290
+ "pattern" : "([0-9]+)"
3291
+ },
3292
+ "tags" : {
3293
+ "type" : [ "null", "array" ],
3294
+ "items" : {
3295
+ "type" : [ "string", "null" ],
3296
+ "maxLength" : 100,
3297
+ "minLength" : 0
3298
+ },
3299
+ "uniqueItems" : false
3300
+ },
3301
+ "rootCategoryId" : {
3302
+ "type" : [ "string", "null", "integer" ],
3303
+ "format" : "int64",
3304
+ "pattern" : "([0-9]+)"
3305
+ },
3306
+ "commentCount" : {
3307
+ "type" : [ "string", "null", "integer" ],
3308
+ "format" : "int32",
3309
+ "pattern" : "([0-9]+)"
3310
+ },
3311
+ "answer" : {
3312
+ "type" : [ "string", "null" ],
3313
+ "maxLength" : 16777215,
3314
+ "minLength" : 0
3315
+ },
3316
+ "translationId" : {
3317
+ "type" : [ "string", "null", "integer" ],
3318
+ "format" : "int64",
3319
+ "pattern" : "([0-9]+)"
3320
+ },
3321
+ "createdTime" : {
3322
+ "type" : [ "string", "null" ],
3323
+ "maxLength" : 100,
3324
+ "minLength" : 0,
3325
+ "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))"
3326
+ },
3327
+ "followersCount" : {
3328
+ "type" : [ "string", "null", "integer" ],
3329
+ "format" : "int32",
3330
+ "pattern" : "([0-9]+)"
3331
+ },
3332
+ "seo" : {
3333
+ "$ref" : "./Solution.json#/components/schemas/seo"
3334
+ },
3335
+ "category" : {
3336
+ "$ref" : "./Solution.json#/components/schemas/categoryJson"
3337
+ }
3338
+ },
3339
+ "required" : [ "answer", "author", "category", "commentCount", "createdTime", "departmentId", "dislikeCount", "followersCount", "isFollowing", "likeCount", "modifiedTime", "myVote", "next", "prev", "rootCategoryId", "seo", "summary", "tags", "translationId" ]
3340
+ } ]
3341
+ } ]
3342
+ },
3343
+ "examples" : {
3344
+ "Valid responses Definitions" : {
3345
+ "value" : {
3346
+ "summary" : "If you're looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories. Here's a list of Zylker showrooms - https://www.zylker.com/storefinder ",
3347
+ "modifiedTime" : "2019-11-04T05:10:46.000Z",
3348
+ "isFollowing" : true,
3349
+ "myVote" : null,
3350
+ "author" : {
3351
+ "photoURL" : "https://desk.zoho.com/api/v1/agents/292101000000088033/photo?orgId=669661594",
3352
+ "name" : "Yod Agbaria",
3353
+ "id" : "292101000000088033",
3354
+ "status" : "ACTIVE",
3355
+ "zuid" : "32435"
3356
+ },
3357
+ "departmentId" : "292101000000006907",
3358
+ "dislikeCount" : "2",
3359
+ "likeCount" : "110",
3360
+ "title" : "Buying a detachable keyboard",
3361
+ "locale" : "en",
3362
+ "tags" : [ "detachable keyboard", "zpad", "zboard", "accessory" ],
3363
+ "rootCategoryId" : "292101000000088379",
3364
+ "locales" : [ {
3365
+ "apiUrl" : "https://desk.zoho.com/portal/api/kbArticles/292101000001113049/locale/en?portalId=edbsn9f6fab66f372a985f9c6787692a0b53dda6a5e6aa52db4477786bb56a42f1775f5f6e",
3366
+ "webUrl" : "https://desk.zoho.com/portal/zylker/en/kb/articles/buying-a-detachable-keyboard",
3367
+ "permalink" : "buying-a-detachable-keyboard",
3368
+ "locale" : "en"
3369
+ } ],
3370
+ "answer" : "If you&#39;re looking for a detachable keyboard for your zPad, you can either order one online or drop in to one of our Zylker Stores. Visit https://www.zylker.com/zPad/shop for shopping for accessories.<br /><br />Here&#39;s a list of Zylker showrooms - https://www.zylker.com/storefinder<br /><br />You can drop in any time between 10:00 AM and 10:00 PM, any day, to pick out a zBoard.<br />",
3371
+ "translationId" : "292101000000200029",
3372
+ "webUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/buying-a-detachable-keyboard",
3373
+ "createdTime" : "2018-09-08T06:52:36.000Z",
3374
+ "followersCount" : "1",
3375
+ "id" : "292101000001113049",
3376
+ "category" : {
3377
+ "name" : "1",
3378
+ "id" : "292101000000216021",
3379
+ "locale" : "en"
3380
+ },
3381
+ "permalink" : "buying-a-detachable-keyboard",
3382
+ "seo" : {
3383
+ "keywords" : "zPad, detachable keyboard, accessory, zBoard",
3384
+ "isEnabled" : true,
3385
+ "description" : "Follow these steps for buying a detachable keyboard.",
3386
+ "title" : "Buying a detachable keyboard"
3387
+ },
3388
+ "categoryId" : "292101000000216021"
3389
+ }
3390
+ }
3391
+ }
3392
+ }
3393
+ },
3394
+ "x-custom-response-attributes" : {
3395
+ "disable-safe-headers" : "[]"
3396
+ }
3397
+ },
3398
+ "listAllArticleAttachments" : {
3399
+ "description" : "listAllArticleAttachments template definitions",
3400
+ "content" : {
3401
+ "application/json" : {
3402
+ "schema" : {
3403
+ "type" : [ "object", "null" ],
3404
+ "additionalProperties" : false,
3405
+ "properties" : {
3406
+ "data" : {
3407
+ "$ref" : "./Solution.json#/components/schemas/attachmentsData"
3408
+ }
3409
+ },
3410
+ "required" : [ "data" ]
3411
+ },
3412
+ "examples" : {
3413
+ "Valid responses Definitions" : {
3414
+ "value" : {
3415
+ "data" : [ {
3416
+ "contentUrl" : "https://desk.zoho.com/portal/api/kbArticles/180757000000724067/attachments/798cydff5ee6cad9600a9/content?portalId=ae075d0de8621f986c07c1fe256e4243",
3417
+ "size" : "733983",
3418
+ "name" : "DemoImage.png",
3419
+ "createdTime" : "2018-06-06T09:10:05.288Z",
3420
+ "inlineUrl" : "https://desk.zoho.com/portal/api/kbArticles/180757000000724067/attachments/798cydff5ee6cad9600a9/content?portalId=ae075d0de8621f986c07c1fe256e4243&inline=true",
3421
+ "id" : "798cydff5ee6cad9600a9"
3422
+ } ]
3423
+ }
3424
+ }
3425
+ }
3426
+ }
3427
+ },
3428
+ "x-custom-response-attributes" : {
3429
+ "disable-safe-headers" : "[]"
3430
+ }
3431
+ },
3432
+ "getTagsResponse" : {
3433
+ "description" : "get tags api response",
3434
+ "content" : {
3435
+ "application/json" : {
3436
+ "schema" : {
3437
+ "type" : "object",
3438
+ "properties" : {
3439
+ "kbTags" : {
3440
+ "type" : "array",
3441
+ "items" : {
3442
+ "type" : "string"
3443
+ }
3444
+ }
3445
+ },
3446
+ "required" : [ "kbTags" ]
3447
+ }
3448
+ }
3449
+ }
3450
+ }
3451
+ },
3452
+ "parameters" : {
3453
+ "departmentId" : {
3454
+ "name" : "departmentId",
3455
+ "in" : "query",
3456
+ "description" : "To retrieve the articles under particular department",
3457
+ "required" : false,
3458
+ "style" : "form",
3459
+ "explode" : true,
3460
+ "schema" : {
3461
+ "type" : [ "string", "null", "integer" ],
3462
+ "format" : "int64",
3463
+ "description" : "To retrieve the articles under particular department",
3464
+ "pattern" : "([0-9]+)"
3465
+ }
3466
+ },
3467
+ "articleId" : {
3468
+ "name" : "articleId",
3469
+ "in" : "path",
3470
+ "description" : "",
3471
+ "required" : true,
3472
+ "style" : "simple",
3473
+ "explode" : false,
3474
+ "schema" : {
3475
+ "type" : [ "string", "null", "integer" ],
3476
+ "format" : "int64",
3477
+ "description" : "",
3478
+ "pattern" : "([0-9]+)",
3479
+ "x-custom-parameters-attributes" : { }
3480
+ }
3481
+ },
3482
+ "entityId" : {
3483
+ "name" : "entityId",
3484
+ "in" : "path",
3485
+ "required" : true,
3486
+ "style" : "simple",
3487
+ "explode" : false,
3488
+ "schema" : {
3489
+ "type" : [ "string", "null", "integer" ],
3490
+ "format" : "int64",
3491
+ "pattern" : "([0-9]+)"
3492
+ }
3493
+ },
3494
+ "locale" : {
3495
+ "name" : "locale",
3496
+ "in" : "path",
3497
+ "description" : "Locale of the article",
3498
+ "required" : true,
3499
+ "style" : "simple",
3500
+ "explode" : false,
3501
+ "schema" : {
3502
+ "type" : [ "string", "null" ],
3503
+ "description" : "Locale of the article",
3504
+ "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ],
3505
+ "maxLength" : 100,
3506
+ "minLength" : 0,
3507
+ "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)"
3508
+ }
3509
+ },
3510
+ "rootCategoryId" : {
3511
+ "name" : "rootCategoryId",
3512
+ "in" : "query",
3513
+ "description" : "ID of the root category to which the articles must belong",
3514
+ "required" : false,
3515
+ "style" : "form",
3516
+ "explode" : true,
3517
+ "schema" : {
3518
+ "type" : [ "string", "null", "integer" ],
3519
+ "format" : "int64",
3520
+ "description" : "ID of the root category to which the articles must belong",
3521
+ "pattern" : "([0-9]+)",
3522
+ "x-custom-parameters-attributes" : {
3523
+ "split" : ","
3524
+ }
3525
+ }
3526
+ },
3527
+ "limit" : {
3528
+ "name" : "limit",
3529
+ "in" : "query",
3530
+ "description" : "tNumber of comments to list",
3531
+ "required" : false,
3532
+ "style" : "form",
3533
+ "explode" : true,
3534
+ "schema" : {
3535
+ "type" : [ "string", "null", "integer" ],
3536
+ "format" : "int32",
3537
+ "description" : "tNumber of comments to list",
3538
+ "maximum" : 99,
3539
+ "minimum" : 1,
3540
+ "pattern" : "([0-9]+)"
3541
+ }
3542
+ },
3543
+ "from" : {
3544
+ "name" : "from",
3545
+ "in" : "query",
3546
+ "description" : "Index number, starting from which the comments must be listed. Default value is 1.",
3547
+ "required" : false,
3548
+ "style" : "form",
3549
+ "explode" : true,
3550
+ "schema" : {
3551
+ "type" : [ "string", "null", "integer" ],
3552
+ "format" : "int32",
3553
+ "description" : "Index number, starting from which the comments must be listed. Default value is 1.",
3554
+ "minimum" : 0,
3555
+ "pattern" : "([0-9]+)"
3556
+ }
3557
+ },
3558
+ "includeCount" : {
3559
+ "name" : "includeCount",
3560
+ "in" : "query",
3561
+ "description" : "Display count in articles response",
3562
+ "required" : false,
3563
+ "style" : "form",
3564
+ "explode" : true,
3565
+ "schema" : {
3566
+ "type" : [ "boolean", "null" ],
3567
+ "description" : "Display count in articles response"
3568
+ }
3569
+ },
3570
+ "id" : {
3571
+ "name" : "id",
3572
+ "in" : "path",
3573
+ "required" : true,
3574
+ "style" : "simple",
3575
+ "explode" : false,
3576
+ "schema" : {
3577
+ "type" : [ "string", "null", "integer" ],
3578
+ "format" : "int64",
3579
+ "pattern" : "([0-9]+)"
3580
+ }
3581
+ },
3582
+ "solutionId" : {
3583
+ "name" : "solutionId",
3584
+ "in" : "query",
3585
+ "description" : "To retrieve the related article",
3586
+ "required" : true,
3587
+ "style" : "form",
3588
+ "explode" : true,
3589
+ "schema" : {
3590
+ "type" : [ "string", "null", "integer" ],
3591
+ "format" : "int64",
3592
+ "description" : "To retrieve the related article",
3593
+ "pattern" : "([0-9]+)"
3594
+ }
3595
+ },
3596
+ "tag" : {
3597
+ "name" : "tag",
3598
+ "in" : "query",
3599
+ "required" : false,
3600
+ "style" : "form",
3601
+ "explode" : true,
3602
+ "schema" : {
3603
+ "type" : [ "string", "null" ],
3604
+ "maxLength" : 100,
3605
+ "minLength" : 0,
3606
+ "pattern" : "[a-z0-9\\_\\-\\+\\%\\P{InBasicLatin}\\s]+",
3607
+ "x-custom-parameters-attributes" : {
3608
+ "removeExif" : false,
3609
+ "replacementString" : "",
3610
+ "filterMatchedContent" : false,
3611
+ "antivirus" : false,
3612
+ "allowInvalid" : false,
3613
+ "descrption" : "Key that filters articles, based on tags",
3614
+ "secret" : false,
3615
+ "preserveCharsLimit" : 10,
3616
+ "trim" : false,
3617
+ "internalParam" : false,
3618
+ "preserveChars" : "0,5",
3619
+ "importUrl" : false,
3620
+ "decrypt" : false
3621
+ }
3622
+ }
3623
+ },
3624
+ "attachmentId" : {
3625
+ "name" : "attachmentId",
3626
+ "in" : "path",
3627
+ "description" : "",
3628
+ "required" : true,
3629
+ "style" : "simple",
3630
+ "explode" : false,
3631
+ "schema" : {
3632
+ "type" : [ "string", "null", "integer" ],
3633
+ "format" : "int64",
3634
+ "description" : "",
3635
+ "pattern" : "([0-9]+)",
3636
+ "x-custom-parameters-attributes" : { }
3637
+ }
3638
+ },
3639
+ "categoryId" : {
3640
+ "name" : "categoryId",
3641
+ "in" : "query",
3642
+ "description" : "ID of the category to which the articles must belong",
3643
+ "required" : false,
3644
+ "style" : "form",
3645
+ "explode" : true,
3646
+ "schema" : {
3647
+ "type" : [ "string", "null", "integer" ],
3648
+ "format" : "int64",
3649
+ "description" : "ID of the category to which the articles must belong",
3650
+ "pattern" : "([0-9]+)"
3651
+ }
3652
+ },
3653
+ "searchKeyWordMatch" : {
3654
+ "name" : "searchKeyWordMatch",
3655
+ "in" : "query",
3656
+ "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).",
3657
+ "required" : false,
3658
+ "style" : "form",
3659
+ "explode" : true,
3660
+ "schema" : {
3661
+ "type" : [ "string", "null" ],
3662
+ "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).",
3663
+ "enum" : [ "ANY", "ALL" ],
3664
+ "maxLength" : 100,
3665
+ "minLength" : 0
3666
+ }
3667
+ }
3668
+ },
3669
+ "requestBodies" : {
3670
+ "feedback_portal" : {
3671
+ "content" : {
3672
+ "application/json" : {
3673
+ "schema" : {
3674
+ "type" : [ "object", "null" ],
3675
+ "additionalProperties" : false,
3676
+ "properties" : {
3677
+ "feedback" : {
3678
+ "type" : [ "string", "null" ],
3679
+ "description" : "Content of the feedback",
3680
+ "maxLength" : 255,
3681
+ "minLength" : 0,
3682
+ "x-custom-parameters-attributes" : {
3683
+ "xss" : "antisamyfilter_custom"
3684
+ }
3685
+ },
3686
+ "email" : {
3687
+ "type" : [ "string", "null" ],
3688
+ "description" : "Email ID in the feedback",
3689
+ "maxLength" : 100,
3690
+ "minLength" : 0,
3691
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
3692
+ }
3693
+ },
3694
+ "required" : [ "feedback" ]
3695
+ },
3696
+ "examples" : {
3697
+ "Valid requestBody Definitions" : {
3698
+ "value" : null
3699
+ }
3700
+ }
3701
+ }
3702
+ },
3703
+ "x-custom-request-body-attributes" : {
3704
+ "non-empty" : false,
3705
+ "allow-invalid" : false
3706
+ }
3707
+ },
3708
+ "createArticleTranslationFeedback_feedback_portal" : {
3709
+ "content" : {
3710
+ "application/json" : {
3711
+ "schema" : {
3712
+ "type" : [ "object", "null" ],
3713
+ "additionalProperties" : false,
3714
+ "properties" : {
3715
+ "feedback" : {
3716
+ "type" : [ "string", "null" ],
3717
+ "description" : "Content of the feedback",
3718
+ "maxLength" : 255,
3719
+ "minLength" : 0,
3720
+ "x-custom-parameters-attributes" : {
3721
+ "xss" : "antisamyfilter_custom"
3722
+ }
3723
+ },
3724
+ "email" : {
3725
+ "type" : [ "string", "null" ],
3726
+ "description" : "Email ID in the feedback",
3727
+ "maxLength" : 100,
3728
+ "minLength" : 0,
3729
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
3730
+ }
3731
+ },
3732
+ "required" : [ "feedback" ]
3733
+ },
3734
+ "examples" : {
3735
+ "Valid requestBody Definitions" : {
3736
+ "value" : {
3737
+ "feedback" : "The Article is considering these constraints 1. 2. 3 . 4 ",
3738
+ "email" : "example@zylker.com"
3739
+ }
3740
+ }
3741
+ }
3742
+ }
3743
+ },
3744
+ "x-custom-request-body-attributes" : {
3745
+ "non-empty" : false,
3746
+ "allow-invalid" : false
3747
+ }
3748
+ }
3749
+ },
3750
+ "securitySchemes" : {
3751
+ "cookie-auth" : {
3752
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
3753
+ },
3754
+ "org-oauth" : {
3755
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
3756
+ },
3757
+ "jwt-oauth" : {
3758
+ "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
3759
+ },
3760
+ "iam-oauth2-schema" : {
3761
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
3762
+ }
3763
+ }
3764
+ },
3765
+ "x-entity" : "Solution"
3766
+ }