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,3478 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "CustomView",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "common",
7
+ "x-module-group" : "views"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/lastAccessedView/{cvId}" : {
11
+ "put" : {
12
+ "tags" : [ "CustomView" ],
13
+ "summary" : "Update Last Accessed View",
14
+ "description" : "This API updates the view last accessed by the user in the module and department specified in the request.",
15
+ "operationId" : "updateRecentView",
16
+ "parameters" : [ {
17
+ "$ref" : "#/components/parameters/departmentId"
18
+ }, {
19
+ "$ref" : "#/components/parameters/cvId"
20
+ }, {
21
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
22
+ } ],
23
+ "responses" : {
24
+ "204" : {
25
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
26
+ },
27
+ "422" : {
28
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
29
+ }
30
+ },
31
+ "security" : [ {
32
+ "org-oauth" : [ "accessAll.ALL" ]
33
+ }, {
34
+ "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ]
35
+ } ],
36
+ "x-audience" : [ "external-public" ],
37
+ "x-custom-url-attribute" : {
38
+ "security" : {
39
+ "throttle" : {
40
+ "inline" : [ {
41
+ "scope" : "APPSERVER",
42
+ "rules" : [ {
43
+ "duration" : 60000,
44
+ "lock-period" : 300000,
45
+ "threshold" : 50,
46
+ "hip" : false
47
+ }, {
48
+ "duration" : 3600000,
49
+ "lock-period" : 600000,
50
+ "threshold" : 1000,
51
+ "hip" : false
52
+ } ],
53
+ "window" : "ROLLING",
54
+ "key" : "url.path+user.remoteip"
55
+ } ]
56
+ },
57
+ "extraparams" : {
58
+ "disable" : true,
59
+ "ignore" : false
60
+ },
61
+ "authentication" : { }
62
+ },
63
+ "clan-group" : "common",
64
+ "apihash" : "7e053b1001161a79777f7f4366c4f1d7",
65
+ "module-group" : "views",
66
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.setRecentViews"
67
+ }
68
+ }
69
+ },
70
+ "/api/v1/views/{cvId}/star" : {
71
+ "post" : {
72
+ "tags" : [ "CustomView" ],
73
+ "summary" : "Add Starred View",
74
+ "description" : "This API stars a view, enabling quick access to the view.",
75
+ "operationId" : "addStarredView",
76
+ "parameters" : [ {
77
+ "$ref" : "#/components/parameters/departmentId"
78
+ }, {
79
+ "$ref" : "#/components/parameters/cvId"
80
+ }, {
81
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
82
+ } ],
83
+ "responses" : {
84
+ "204" : {
85
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
86
+ },
87
+ "403" : {
88
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
89
+ },
90
+ "422" : {
91
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
92
+ }
93
+ },
94
+ "security" : [ {
95
+ "org-oauth" : [ "accessAll.ALL" ]
96
+ }, {
97
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
98
+ } ],
99
+ "x-audience" : [ "external-public" ],
100
+ "x-custom-url-attribute" : {
101
+ "security" : {
102
+ "throttle" : {
103
+ "inline" : [ {
104
+ "scope" : "APPSERVER",
105
+ "rules" : [ {
106
+ "duration" : 60000,
107
+ "lock-period" : 180000,
108
+ "threshold" : 20,
109
+ "hip" : false
110
+ } ],
111
+ "window" : "ROLLING",
112
+ "key" : "url.path+user.zuid"
113
+ } ]
114
+ },
115
+ "extraparams" : {
116
+ "disable" : true,
117
+ "ignore" : false
118
+ },
119
+ "authentication" : { }
120
+ },
121
+ "clan-group" : "common",
122
+ "apihash" : "f724c522ec870485522215c97526f458",
123
+ "module-group" : "views",
124
+ "apimethod" : "com.zoho.desk.views.restapi.StarredViewService.addStarredView"
125
+ }
126
+ }
127
+ },
128
+ "/api/v1/views/archivedEntities/myPreference" : {
129
+ "get" : {
130
+ "tags" : [ "CustomView" ],
131
+ "summary" : "Get My preference for archived view",
132
+ "description" : "This API gets my preference for provided view.",
133
+ "operationId" : "getArchivedViewPreference",
134
+ "parameters" : [ {
135
+ "name" : "departmentId",
136
+ "in" : "query",
137
+ "description" : "ID of the department from which the view's preference should be fetched.",
138
+ "required" : true,
139
+ "style" : "form",
140
+ "explode" : true,
141
+ "schema" : {
142
+ "type" : [ "string", "null", "integer" ],
143
+ "format" : "int64",
144
+ "description" : "ID of the department from which the view's preference should be fetched.",
145
+ "pattern" : "([0-9]+)"
146
+ }
147
+ }, {
148
+ "$ref" : "#/components/parameters/module"
149
+ }, {
150
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
151
+ } ],
152
+ "responses" : {
153
+ "200" : {
154
+ "$ref" : "#/components/responses/archivedViewPreference"
155
+ },
156
+ "403" : {
157
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
158
+ },
159
+ "422" : {
160
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
161
+ }
162
+ },
163
+ "security" : [ {
164
+ "org-oauth" : [ "accessAll.ALL" ]
165
+ }, {
166
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
167
+ } ],
168
+ "x-audience" : [ "company-internal" ],
169
+ "x-custom-url-attribute" : {
170
+ "security" : {
171
+ "throttle" : {
172
+ "inline" : [ {
173
+ "scope" : "APPSERVER",
174
+ "rules" : [ {
175
+ "duration" : 60000,
176
+ "lock-period" : 120000,
177
+ "threshold" : 30,
178
+ "hip" : false
179
+ }, {
180
+ "duration" : 3600000,
181
+ "lock-period" : 420000,
182
+ "threshold" : 100,
183
+ "hip" : false
184
+ } ],
185
+ "window" : "ROLLING",
186
+ "key" : "url.path+user.zuid"
187
+ } ]
188
+ },
189
+ "extraparams" : {
190
+ "disable" : true,
191
+ "ignore" : false
192
+ },
193
+ "authentication" : { }
194
+ },
195
+ "clan-group" : "common",
196
+ "apihash" : "bb2dd0ec917511b9a7007ea7929ee81d",
197
+ "module-group" : "views",
198
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getArchivedViewPreference"
199
+ }
200
+ },
201
+ "patch" : {
202
+ "tags" : [ "CustomView" ],
203
+ "summary" : "Update Archived Tickets preference",
204
+ "description" : "This API updates my preference for Archived Ticket view. Only createdTime, modifiedTime fields supported in Sort Field.",
205
+ "operationId" : "updateArchivedViewPreference",
206
+ "parameters" : [ {
207
+ "name" : "departmentId",
208
+ "in" : "query",
209
+ "required" : true,
210
+ "style" : "form",
211
+ "explode" : true,
212
+ "schema" : {
213
+ "type" : [ "string", "null", "integer" ],
214
+ "format" : "int64",
215
+ "pattern" : "([0-9]+)"
216
+ }
217
+ }, {
218
+ "$ref" : "#/components/parameters/module"
219
+ }, {
220
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
221
+ } ],
222
+ "requestBody" : {
223
+ "$ref" : "#/components/requestBodies/archivedViewPreferenceKeys"
224
+ },
225
+ "responses" : {
226
+ "204" : {
227
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
228
+ },
229
+ "403" : {
230
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
231
+ },
232
+ "422" : {
233
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
234
+ }
235
+ },
236
+ "security" : [ {
237
+ "org-oauth" : [ "accessAll.ALL" ]
238
+ }, {
239
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
240
+ } ],
241
+ "x-audience" : [ "company-internal" ],
242
+ "x-custom-url-attribute" : {
243
+ "security" : {
244
+ "throttle" : {
245
+ "inline" : [ {
246
+ "scope" : "APPSERVER",
247
+ "rules" : [ {
248
+ "duration" : 60000,
249
+ "lock-period" : 300000,
250
+ "threshold" : 10,
251
+ "hip" : false
252
+ }, {
253
+ "duration" : 3600000,
254
+ "lock-period" : 600000,
255
+ "threshold" : 30,
256
+ "hip" : false
257
+ } ],
258
+ "window" : "ROLLING",
259
+ "key" : "url.path+user.zuid"
260
+ } ]
261
+ },
262
+ "extraparams" : {
263
+ "disable" : true,
264
+ "ignore" : false
265
+ },
266
+ "authentication" : { }
267
+ },
268
+ "clan-group" : "common",
269
+ "apihash" : "35fc431d243b7eaef7a1dd08461a9697",
270
+ "module-group" : "views",
271
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.updateArchivedViewPreference"
272
+ }
273
+ }
274
+ },
275
+ "/api/v1/views/availableFields" : {
276
+ "get" : {
277
+ "tags" : [ "CustomView" ],
278
+ "summary" : "List Available Select Fields",
279
+ "description" : "This API fetches the available select fields for specified module.",
280
+ "operationId" : "getAvailableSelectFields",
281
+ "parameters" : [ {
282
+ "$ref" : "#/components/parameters/module"
283
+ }, {
284
+ "$ref" : "#/components/parameters/departmentId"
285
+ }, {
286
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
287
+ } ],
288
+ "responses" : {
289
+ "200" : {
290
+ "$ref" : "#/components/responses/getAvailableFieldsResponse"
291
+ },
292
+ "422" : {
293
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
294
+ }
295
+ },
296
+ "security" : [ {
297
+ "org-oauth" : [ "accessAll.ALL" ]
298
+ }, {
299
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
300
+ } ],
301
+ "x-audience" : [ "company-internal" ],
302
+ "x-custom-url-attribute" : {
303
+ "security" : {
304
+ "throttle" : {
305
+ "inline" : [ {
306
+ "scope" : "APPSERVER",
307
+ "rules" : [ {
308
+ "duration" : 60000,
309
+ "lock-period" : 60000,
310
+ "threshold" : 20,
311
+ "hip" : false
312
+ } ],
313
+ "window" : "ROLLING",
314
+ "key" : "url.path+user.zuid"
315
+ } ]
316
+ },
317
+ "extraparams" : {
318
+ "disable" : true,
319
+ "ignore" : false
320
+ },
321
+ "authentication" : {
322
+ "iscscope" : [ "SupCrmAPI" ]
323
+ }
324
+ },
325
+ "clan-group" : "common",
326
+ "apihash" : "741a45101de8a7359680d30079baab8b",
327
+ "module-group" : "views",
328
+ "apimethod" : "com.zoho.support.restapi.FeatureFieldService.getAvailableFields"
329
+ }
330
+ }
331
+ },
332
+ "/api/v1/views/{cvId}" : {
333
+ "get" : {
334
+ "tags" : [ "CustomView" ],
335
+ "summary" : "Get Custom View",
336
+ "description" : "This API fetches the details of a particular custom view.",
337
+ "operationId" : "getCustomView",
338
+ "parameters" : [ {
339
+ "$ref" : "#/components/parameters/featureFlags"
340
+ }, {
341
+ "$ref" : "#/components/parameters/cvId"
342
+ }, {
343
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
344
+ } ],
345
+ "responses" : {
346
+ "200" : {
347
+ "$ref" : "#/components/responses/customViewResponse"
348
+ },
349
+ "204" : {
350
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
351
+ },
352
+ "403" : {
353
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
354
+ },
355
+ "422" : {
356
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
357
+ }
358
+ },
359
+ "security" : [ {
360
+ "org-oauth" : [ "accessAll.ALL" ]
361
+ }, {
362
+ "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
363
+ } ],
364
+ "x-audience" : [ "company-internal" ],
365
+ "x-custom-url-attribute" : {
366
+ "security" : {
367
+ "throttle" : {
368
+ "inline" : [ {
369
+ "scope" : "APPSERVER",
370
+ "rules" : [ {
371
+ "duration" : 60000,
372
+ "lock-period" : 600000,
373
+ "threshold" : 30,
374
+ "hip" : false
375
+ } ],
376
+ "window" : "ROLLING",
377
+ "key" : "url.path+user.zuid"
378
+ } ]
379
+ },
380
+ "extraparams" : {
381
+ "disable" : true,
382
+ "ignore" : false
383
+ },
384
+ "authentication" : { }
385
+ },
386
+ "clan-group" : "common",
387
+ "apihash" : "ec409d76c6df6e424f556f62345be0ff",
388
+ "module-group" : "views",
389
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getCustomView"
390
+ }
391
+ },
392
+ "delete" : {
393
+ "tags" : [ "CustomView" ],
394
+ "summary" : "Delete Custom View",
395
+ "description" : "This API deletes the custom view specified.",
396
+ "operationId" : "deleteCustomView",
397
+ "parameters" : [ {
398
+ "$ref" : "#/components/parameters/cvId"
399
+ }, {
400
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
401
+ } ],
402
+ "responses" : {
403
+ "204" : {
404
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
405
+ },
406
+ "403" : {
407
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
408
+ },
409
+ "422" : {
410
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
411
+ }
412
+ },
413
+ "security" : [ {
414
+ "org-oauth" : [ "accessAll.ALL" ]
415
+ }, {
416
+ "iam-oauth2-schema" : [ "Desk.settings.DELETE" ]
417
+ } ],
418
+ "x-audience" : [ "company-internal" ],
419
+ "x-custom-url-attribute" : {
420
+ "security" : {
421
+ "throttle" : {
422
+ "inline" : [ {
423
+ "scope" : "APPSERVER",
424
+ "rules" : [ {
425
+ "duration" : 60000,
426
+ "lock-period" : 600000,
427
+ "threshold" : 30,
428
+ "hip" : false
429
+ } ],
430
+ "window" : "ROLLING",
431
+ "key" : "url.path+user.zuid"
432
+ } ]
433
+ },
434
+ "extraparams" : {
435
+ "disable" : true,
436
+ "ignore" : false
437
+ },
438
+ "authentication" : { }
439
+ },
440
+ "clan-group" : "common",
441
+ "apihash" : "6a2c0734506d162ce83e2de82785ae1d",
442
+ "module-group" : "views",
443
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.deleteCustomView"
444
+ }
445
+ },
446
+ "patch" : {
447
+ "tags" : [ "CustomView" ],
448
+ "summary" : "Update Custom View",
449
+ "description" : "This API updates the details of an existing custom view. The value of the department attribute can be a valid department ID or allDepartments. Similarly, the value of agents can be a valid agent ID or allAgents. If you want the custom view to be visible only to you, do not pass any attribute values in the API request. Either module or moduleMapping is mandatory (For old format: module should be given, for new format: moduleMapping should be given)",
450
+ "operationId" : "updateCustomView",
451
+ "parameters" : [ {
452
+ "name" : "featureFlags",
453
+ "in" : "header",
454
+ "description" : "Feature flags for special cases",
455
+ "required" : false,
456
+ "style" : "simple",
457
+ "explode" : false,
458
+ "schema" : {
459
+ "type" : "string",
460
+ "enum" : [ "requestNewResponse", "showI18NFields", "sanitizedName" ]
461
+ }
462
+ }, {
463
+ "$ref" : "#/components/parameters/cvId"
464
+ }, {
465
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
466
+ } ],
467
+ "requestBody" : {
468
+ "$ref" : "#/components/requestBodies/updateCustomViewJson"
469
+ },
470
+ "responses" : {
471
+ "200" : {
472
+ "$ref" : "#/components/responses/customViewResponse"
473
+ },
474
+ "422" : {
475
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
476
+ },
477
+ "500" : {
478
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
479
+ }
480
+ },
481
+ "security" : [ {
482
+ "org-oauth" : [ "accessAll.ALL" ]
483
+ }, {
484
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
485
+ } ],
486
+ "x-audience" : [ "company-internal" ],
487
+ "x-custom-url-attribute" : {
488
+ "security" : {
489
+ "throttle" : {
490
+ "inline" : [ {
491
+ "scope" : "APPSERVER",
492
+ "rules" : [ {
493
+ "duration" : 60000,
494
+ "lock-period" : 600000,
495
+ "threshold" : 30,
496
+ "hip" : false
497
+ } ],
498
+ "window" : "ROLLING",
499
+ "key" : "url.path+user.zuid"
500
+ } ]
501
+ },
502
+ "extraparams" : {
503
+ "disable" : true,
504
+ "ignore" : false
505
+ },
506
+ "authentication" : { }
507
+ },
508
+ "clan-group" : "common",
509
+ "apihash" : "4589e76be863e8e843ca0a7c346e3f10",
510
+ "module-group" : "views",
511
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.updateCustomView"
512
+ }
513
+ }
514
+ },
515
+ "/api/v1/lastAccessedView" : {
516
+ "get" : {
517
+ "tags" : [ "CustomView" ],
518
+ "summary" : "Get Last Accessed View",
519
+ "description" : "This API fetches the view last accessed by the user in the module and department specified in the request.",
520
+ "operationId" : "getRecentView",
521
+ "parameters" : [ {
522
+ "$ref" : "#/components/parameters/departmentId"
523
+ }, {
524
+ "$ref" : "#/components/parameters/module"
525
+ }, {
526
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
527
+ } ],
528
+ "responses" : {
529
+ "200" : {
530
+ "$ref" : "#/components/responses/getRecentViewJson"
531
+ },
532
+ "403" : {
533
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
534
+ },
535
+ "422" : {
536
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
537
+ }
538
+ },
539
+ "security" : [ {
540
+ "org-oauth" : [ "accessAll.ALL" ]
541
+ }, {
542
+ "iam-oauth2-schema" : [ "Desk.basic.READ" ]
543
+ } ],
544
+ "x-audience" : [ "external-public" ],
545
+ "x-custom-url-attribute" : {
546
+ "security" : {
547
+ "throttle" : {
548
+ "inline" : [ {
549
+ "scope" : "APPSERVER",
550
+ "rules" : [ {
551
+ "duration" : 60000,
552
+ "lock-period" : 300000,
553
+ "threshold" : 50,
554
+ "hip" : false
555
+ } ],
556
+ "window" : "ROLLING",
557
+ "key" : "url.path+user.remoteip"
558
+ } ]
559
+ },
560
+ "extraparams" : {
561
+ "disable" : true,
562
+ "ignore" : false
563
+ },
564
+ "authentication" : { }
565
+ },
566
+ "clan-group" : "common",
567
+ "apihash" : "60e4030358c074d5b49e0e3dc3514b70",
568
+ "module-group" : "views",
569
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getRecentView"
570
+ }
571
+ }
572
+ },
573
+ "/api/v1/starredViews/{cvId}/unstar" : {
574
+ "post" : {
575
+ "tags" : [ "CustomView" ],
576
+ "summary" : "Remove Starred View",
577
+ "description" : "This API unstars a view, disabling quick access to the view.",
578
+ "operationId" : "removeStarredView",
579
+ "parameters" : [ {
580
+ "$ref" : "#/components/parameters/departmentId"
581
+ }, {
582
+ "$ref" : "#/components/parameters/cvId"
583
+ }, {
584
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
585
+ } ],
586
+ "responses" : {
587
+ "204" : {
588
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
589
+ },
590
+ "403" : {
591
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
592
+ },
593
+ "422" : {
594
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
595
+ }
596
+ },
597
+ "security" : [ {
598
+ "org-oauth" : [ "accessAll.ALL" ]
599
+ }, {
600
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
601
+ } ],
602
+ "x-audience" : [ "external-public" ],
603
+ "x-custom-url-attribute" : {
604
+ "security" : {
605
+ "throttle" : {
606
+ "inline" : [ {
607
+ "scope" : "APPSERVER",
608
+ "rules" : [ {
609
+ "duration" : 60000,
610
+ "lock-period" : 180000,
611
+ "threshold" : 20,
612
+ "hip" : false
613
+ } ],
614
+ "window" : "ROLLING",
615
+ "key" : "url.path+user.zuid"
616
+ } ]
617
+ },
618
+ "extraparams" : {
619
+ "disable" : true,
620
+ "ignore" : false
621
+ },
622
+ "authentication" : { }
623
+ },
624
+ "clan-group" : "common",
625
+ "apihash" : "31db61d39bda2b5a6227e3615ec1a68b",
626
+ "module-group" : "views",
627
+ "apimethod" : "com.zoho.desk.views.restapi.StarredViewService.removeStarredView"
628
+ }
629
+ }
630
+ },
631
+ "/api/v1/starredViews/order" : {
632
+ "put" : {
633
+ "tags" : [ "CustomView" ],
634
+ "summary" : "Update Starred View order - Reorder",
635
+ "description" : "This API helps reorder the starred views in a module.",
636
+ "operationId" : "updateStarredViewOrder",
637
+ "parameters" : [ {
638
+ "$ref" : "#/components/parameters/module"
639
+ }, {
640
+ "$ref" : "#/components/parameters/departmentId"
641
+ }, {
642
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
643
+ } ],
644
+ "requestBody" : {
645
+ "$ref" : "#/components/requestBodies/starredViewJsonOrder"
646
+ },
647
+ "responses" : {
648
+ "204" : {
649
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
650
+ },
651
+ "422" : {
652
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
653
+ }
654
+ },
655
+ "security" : [ {
656
+ "org-oauth" : [ "accessAll.ALL" ]
657
+ }, {
658
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
659
+ } ],
660
+ "x-audience" : [ "external-public" ],
661
+ "x-custom-url-attribute" : {
662
+ "security" : {
663
+ "throttle" : {
664
+ "inline" : [ {
665
+ "scope" : "APPSERVER",
666
+ "rules" : [ {
667
+ "duration" : 60000,
668
+ "lock-period" : 180000,
669
+ "threshold" : 20,
670
+ "hip" : false
671
+ } ],
672
+ "window" : "ROLLING",
673
+ "key" : "url.path+user.zuid"
674
+ } ]
675
+ },
676
+ "extraparams" : {
677
+ "disable" : true,
678
+ "ignore" : false
679
+ },
680
+ "authentication" : { }
681
+ },
682
+ "clan-group" : "common",
683
+ "apihash" : "a7abc76f51b1ba2c2374d52ec210380b",
684
+ "module-group" : "views",
685
+ "apimethod" : "com.zoho.desk.views.restapi.StarredViewService.updateStarredViewOrder"
686
+ }
687
+ }
688
+ },
689
+ "/api/v1/views/{cvId}/myPreference" : {
690
+ "get" : {
691
+ "tags" : [ "CustomView" ],
692
+ "summary" : "Get My preference for given view",
693
+ "description" : "This API gets my preference for provided view.",
694
+ "operationId" : "getViewPreference",
695
+ "parameters" : [ {
696
+ "$ref" : "#/components/parameters/departmentId"
697
+ }, {
698
+ "$ref" : "#/components/parameters/cvId"
699
+ }, {
700
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
701
+ } ],
702
+ "responses" : {
703
+ "200" : {
704
+ "$ref" : "#/components/responses/getViewPreferenceResponse"
705
+ }
706
+ },
707
+ "security" : [ {
708
+ "org-oauth" : [ "accessAll.ALL" ]
709
+ }, {
710
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
711
+ } ],
712
+ "x-audience" : [ "company-internal" ],
713
+ "x-custom-url-attribute" : {
714
+ "security" : {
715
+ "throttle" : {
716
+ "inline" : [ {
717
+ "scope" : "APPSERVER",
718
+ "rules" : [ {
719
+ "duration" : 60000,
720
+ "lock-period" : 120000,
721
+ "threshold" : 30,
722
+ "hip" : false
723
+ }, {
724
+ "duration" : 3600000,
725
+ "lock-period" : 420000,
726
+ "threshold" : 100,
727
+ "hip" : false
728
+ } ],
729
+ "window" : "ROLLING",
730
+ "key" : "url.path+user.zuid"
731
+ } ]
732
+ },
733
+ "extraparams" : {
734
+ "disable" : true,
735
+ "ignore" : false
736
+ },
737
+ "authentication" : { }
738
+ },
739
+ "clan-group" : "common",
740
+ "apihash" : "e8f6c0f9befa49332387fa08459d7039",
741
+ "module-group" : "views",
742
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getViewPreference"
743
+ }
744
+ },
745
+ "patch" : {
746
+ "tags" : [ "CustomView" ],
747
+ "summary" : "Update My preference for given view",
748
+ "description" : "This API updates my preference for provided view.ReceivedIn update is supported for only Tickets Module.Sort Field update is not supported for @Accounts@,@Contacts@ module.",
749
+ "operationId" : "updateViewPreference",
750
+ "parameters" : [ {
751
+ "$ref" : "#/components/parameters/departmentId"
752
+ }, {
753
+ "$ref" : "#/components/parameters/cvId"
754
+ }, {
755
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
756
+ } ],
757
+ "requestBody" : {
758
+ "$ref" : "#/components/requestBodies/updateMyViewPreferenceKeys"
759
+ },
760
+ "responses" : {
761
+ "200" : {
762
+ "$ref" : "#/components/responses/getViewPreferenceResponse"
763
+ },
764
+ "422" : {
765
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
766
+ }
767
+ },
768
+ "security" : [ {
769
+ "org-oauth" : [ "accessAll.ALL" ]
770
+ }, {
771
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
772
+ } ],
773
+ "x-audience" : [ "company-internal" ],
774
+ "x-custom-url-attribute" : {
775
+ "security" : {
776
+ "throttle" : {
777
+ "inline" : [ {
778
+ "scope" : "APPSERVER",
779
+ "rules" : [ {
780
+ "duration" : 60000,
781
+ "lock-period" : 300000,
782
+ "threshold" : 10,
783
+ "hip" : false
784
+ }, {
785
+ "duration" : 3600000,
786
+ "lock-period" : 600000,
787
+ "threshold" : 30,
788
+ "hip" : false
789
+ } ],
790
+ "window" : "ROLLING",
791
+ "key" : "url.path+user.zuid"
792
+ } ]
793
+ },
794
+ "extraparams" : {
795
+ "disable" : true,
796
+ "ignore" : false
797
+ },
798
+ "authentication" : { }
799
+ },
800
+ "clan-group" : "common",
801
+ "apihash" : "5939d4dcef1ead1f6c2eee8be5aeab52",
802
+ "module-group" : "views",
803
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.updateViewPreference"
804
+ }
805
+ }
806
+ },
807
+ "/api/v1/views" : {
808
+ "get" : {
809
+ "tags" : [ "CustomView" ],
810
+ "summary" : "List Views",
811
+ "description" : "This API lists the different views configured for a specific module or for all modules in your help desk portal.",
812
+ "operationId" : "getViews",
813
+ "parameters" : [ {
814
+ "name" : "module",
815
+ "in" : "query",
816
+ "description" : "Module Name (for which the view configured and need to be fetched)",
817
+ "required" : true,
818
+ "style" : "form",
819
+ "explode" : true,
820
+ "schema" : {
821
+ "type" : [ "string", "null" ],
822
+ "description" : "Module Name (for which the view configured and need to be fetched)",
823
+ "enum" : [ "tickets", "contacts", "events", "activities", "tasks", "contracts", "accounts", "calls" ],
824
+ "maxLength" : 100,
825
+ "minLength" : 0,
826
+ "x-custom-parameters-attributes" : {
827
+ "entity" : "Views"
828
+ }
829
+ }
830
+ }, {
831
+ "$ref" : "#/components/parameters/departmentId"
832
+ }, {
833
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
834
+ }, {
835
+ "name" : "featureFlags",
836
+ "in" : "header",
837
+ "required" : false,
838
+ "style" : "simple",
839
+ "explode" : false,
840
+ "schema" : {
841
+ "type" : [ "string", "null" ],
842
+ "enum" : [ "createdBy" ],
843
+ "maxLength" : 100,
844
+ "minLength" : 0
845
+ }
846
+ } ],
847
+ "responses" : {
848
+ "200" : {
849
+ "$ref" : "#/components/responses/getViewsResponse"
850
+ },
851
+ "403" : {
852
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
853
+ },
854
+ "422" : {
855
+ "$ref" : "../common/Common.json#/components/responses/unprocessableEntityErrorResponse"
856
+ }
857
+ },
858
+ "security" : [ {
859
+ "org-oauth" : [ "accessAll.ALL" ]
860
+ }, {
861
+ "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
862
+ } ],
863
+ "x-audience" : [ "external-public" ],
864
+ "x-custom-url-attribute" : {
865
+ "security" : {
866
+ "throttle" : {
867
+ "inline" : [ {
868
+ "scope" : "APPSERVER",
869
+ "rules" : [ {
870
+ "duration" : 60000,
871
+ "lock-period" : 600000,
872
+ "threshold" : 30,
873
+ "hip" : false
874
+ } ],
875
+ "window" : "ROLLING",
876
+ "key" : "url.path+user.zuid"
877
+ } ]
878
+ },
879
+ "extraparams" : {
880
+ "disable" : true,
881
+ "ignore" : false
882
+ },
883
+ "authentication" : {
884
+ "iscscope" : [ "SupCrmAPI" ]
885
+ }
886
+ },
887
+ "clan-group" : "common",
888
+ "apihash" : "2e9ea5e8f979014bd9d8fda5306996f0",
889
+ "module-group" : "views",
890
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getViews"
891
+ }
892
+ },
893
+ "post" : {
894
+ "tags" : [ "CustomView" ],
895
+ "summary" : "Create Custom View",
896
+ "description" : "This API creates a custom view based on the attribute values passed in the API request. The value of the department attribute can be a valid department ID or allDepartments. Similarly, the value of agents can be a valid agent ID or allAgents. If you want the custom view to be visible only to you, do not pass any attribute values in the API request. Either module or moduleMapping is mandatory (For old format: module should be given, for new format: moduleMapping should be given)",
897
+ "operationId" : "addCustomView",
898
+ "parameters" : [ {
899
+ "$ref" : "#/components/parameters/featureFlags"
900
+ }, {
901
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
902
+ } ],
903
+ "requestBody" : {
904
+ "$ref" : "#/components/requestBodies/addCustomViewJson"
905
+ },
906
+ "responses" : {
907
+ "200" : {
908
+ "$ref" : "#/components/responses/customViewResponse"
909
+ },
910
+ "400" : {
911
+ "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
912
+ },
913
+ "422" : {
914
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
915
+ }
916
+ },
917
+ "security" : [ {
918
+ "org-oauth" : [ "accessAll.ALL" ]
919
+ }, {
920
+ "iam-oauth2-schema" : [ "Desk.settings.CREATE" ]
921
+ } ],
922
+ "x-audience" : [ "company-internal" ],
923
+ "x-custom-url-attribute" : {
924
+ "security" : {
925
+ "throttle" : {
926
+ "policy" : "WriteAPI_Standard_UserPolicy"
927
+ },
928
+ "extraparams" : {
929
+ "disable" : true,
930
+ "ignore" : false
931
+ },
932
+ "authentication" : { }
933
+ },
934
+ "clan-group" : "common",
935
+ "apihash" : "94408ae7ad7d4f88fb9766d18d616094",
936
+ "module-group" : "views",
937
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.createCustomView"
938
+ }
939
+ }
940
+ },
941
+ "/api/v1/me/queueSlots" : {
942
+ "get" : {
943
+ "tags" : [ "CustomView" ],
944
+ "summary" : "Get Selected Slots Of The User For Specified Queue Mode",
945
+ "description" : "This API fetches the selected slots of the user for specified queue mode configured in your helpdesk.",
946
+ "operationId" : "getMyQueueSlots",
947
+ "parameters" : [ {
948
+ "$ref" : "#/components/parameters/mode"
949
+ }, {
950
+ "$ref" : "#/components/parameters/departmentId"
951
+ }, {
952
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
953
+ } ],
954
+ "responses" : {
955
+ "200" : {
956
+ "$ref" : "#/components/responses/getQueueSlotsResponse"
957
+ },
958
+ "422" : {
959
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
960
+ }
961
+ },
962
+ "security" : [ {
963
+ "org-oauth" : [ "accessAll.ALL" ]
964
+ }, {
965
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
966
+ } ],
967
+ "x-audience" : [ "company-internal" ],
968
+ "x-custom-url-attribute" : {
969
+ "security" : {
970
+ "throttle" : {
971
+ "inline" : [ {
972
+ "scope" : "APPSERVER",
973
+ "rules" : [ {
974
+ "duration" : 60000,
975
+ "lock-period" : 600000,
976
+ "threshold" : 60,
977
+ "hip" : false
978
+ } ],
979
+ "window" : "ROLLING",
980
+ "key" : "url.path+user.zuid"
981
+ } ]
982
+ },
983
+ "extraparams" : {
984
+ "disable" : true,
985
+ "ignore" : false
986
+ },
987
+ "authentication" : { }
988
+ },
989
+ "clan-group" : "common",
990
+ "apihash" : "eb1d3f795b9be255ef1650638b52731d",
991
+ "module-group" : "views",
992
+ "apimethod" : "com.zoho.support.restapi.QueueSlotsService.getMyQueueSlots"
993
+ }
994
+ },
995
+ "put" : {
996
+ "tags" : [ "CustomView" ],
997
+ "summary" : "Update Slots To Be Listed For Specified Queue Mode",
998
+ "description" : "This API updates the selected slots of the user for specified queue mode configured in your helpdesk.",
999
+ "operationId" : "updateMyQueueSlots",
1000
+ "parameters" : [ {
1001
+ "$ref" : "#/components/parameters/mode"
1002
+ }, {
1003
+ "$ref" : "#/components/parameters/departmentId"
1004
+ }, {
1005
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1006
+ } ],
1007
+ "requestBody" : {
1008
+ "$ref" : "#/components/requestBodies/queueSlotsJson"
1009
+ },
1010
+ "responses" : {
1011
+ "200" : {
1012
+ "$ref" : "#/components/responses/getQueueSlotsResponse"
1013
+ },
1014
+ "400" : {
1015
+ "$ref" : "../common/Common.json#/components/responses/badRequestErrorResponse"
1016
+ },
1017
+ "422" : {
1018
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1019
+ }
1020
+ },
1021
+ "security" : [ {
1022
+ "org-oauth" : [ "accessAll.ALL" ]
1023
+ }, {
1024
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
1025
+ } ],
1026
+ "x-audience" : [ "company-internal" ],
1027
+ "x-custom-url-attribute" : {
1028
+ "security" : {
1029
+ "throttle" : {
1030
+ "inline" : [ {
1031
+ "scope" : "APPSERVER",
1032
+ "rules" : [ {
1033
+ "duration" : 60000,
1034
+ "lock-period" : 600000,
1035
+ "threshold" : 30,
1036
+ "hip" : false
1037
+ } ],
1038
+ "window" : "ROLLING",
1039
+ "key" : "url.path+user.zuid"
1040
+ } ]
1041
+ },
1042
+ "extraparams" : {
1043
+ "disable" : true,
1044
+ "ignore" : false
1045
+ },
1046
+ "authentication" : { }
1047
+ },
1048
+ "clan-group" : "common",
1049
+ "apihash" : "1bc52100352593cfb70a47d6fc7183c9",
1050
+ "module-group" : "views",
1051
+ "apimethod" : "com.zoho.support.restapi.QueueSlotsService.updateMyQueueSlots"
1052
+ }
1053
+ }
1054
+ },
1055
+ "/api/v1/views/{cvId}/selectedFields" : {
1056
+ "get" : {
1057
+ "tags" : [ "CustomView" ],
1058
+ "summary" : "List views selected fields",
1059
+ "description" : "This API fetches the available select field for given view in given department.",
1060
+ "operationId" : "getSelectedFields",
1061
+ "parameters" : [ {
1062
+ "$ref" : "#/components/parameters/departmentId"
1063
+ }, {
1064
+ "$ref" : "#/components/parameters/cvId"
1065
+ }, {
1066
+ "name" : "featureFlags",
1067
+ "in" : "header",
1068
+ "required" : false,
1069
+ "style" : "simple",
1070
+ "explode" : false,
1071
+ "schema" : {
1072
+ "type" : [ "string", "null" ],
1073
+ "enum" : [ "getSelectedFieldsNewMetaResponse" ],
1074
+ "maxLength" : 100,
1075
+ "minLength" : 0
1076
+ }
1077
+ }, {
1078
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1079
+ } ],
1080
+ "responses" : {
1081
+ "200" : {
1082
+ "$ref" : "#/components/responses/getSelectedFieldsResponse"
1083
+ },
1084
+ "403" : {
1085
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1086
+ },
1087
+ "422" : {
1088
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1089
+ }
1090
+ },
1091
+ "security" : [ {
1092
+ "org-oauth" : [ "accessAll.ALL" ]
1093
+ }, {
1094
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
1095
+ } ],
1096
+ "x-audience" : [ "company-internal" ],
1097
+ "x-custom-url-attribute" : {
1098
+ "security" : {
1099
+ "throttle" : {
1100
+ "inline" : [ {
1101
+ "scope" : "APPSERVER",
1102
+ "rules" : [ {
1103
+ "duration" : 60000,
1104
+ "lock-period" : 120000,
1105
+ "threshold" : 30,
1106
+ "hip" : false
1107
+ }, {
1108
+ "duration" : 3600000,
1109
+ "lock-period" : 420000,
1110
+ "threshold" : 100,
1111
+ "hip" : false
1112
+ }, {
1113
+ "duration" : 86400000,
1114
+ "lock-period" : 1200000,
1115
+ "threshold" : 1000,
1116
+ "hip" : false
1117
+ } ],
1118
+ "window" : "ROLLING",
1119
+ "key" : "url.path+user.zuid"
1120
+ } ]
1121
+ },
1122
+ "extraparams" : {
1123
+ "disable" : true,
1124
+ "ignore" : false
1125
+ },
1126
+ "authentication" : { }
1127
+ },
1128
+ "clan-group" : "common",
1129
+ "apihash" : "48e340f8f700ec2beb9c267402bcc908",
1130
+ "module-group" : "views",
1131
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.getSelectedFields"
1132
+ }
1133
+ },
1134
+ "put" : {
1135
+ "tags" : [ "CustomView" ],
1136
+ "summary" : "Update views selected fields",
1137
+ "description" : "This API updates the selected fields for given view in given department.Mandatory Columns For module is always required @tickets@ : @ticketNumber@, @contacts@ : @fullName@ ,@accounts@ : @accountName@, @products@ : @productName@, @contracts@ : @contractName@",
1138
+ "operationId" : "updateSelectedFields",
1139
+ "parameters" : [ {
1140
+ "$ref" : "#/components/parameters/departmentId"
1141
+ }, {
1142
+ "$ref" : "#/components/parameters/cvId"
1143
+ }, {
1144
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1145
+ } ],
1146
+ "requestBody" : {
1147
+ "$ref" : "#/components/requestBodies/getSelectedFieldsResponse"
1148
+ },
1149
+ "responses" : {
1150
+ "204" : {
1151
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1152
+ },
1153
+ "422" : {
1154
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1155
+ }
1156
+ },
1157
+ "security" : [ {
1158
+ "org-oauth" : [ "accessAll.ALL" ]
1159
+ }, {
1160
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
1161
+ } ],
1162
+ "x-audience" : [ "company-internal" ],
1163
+ "x-custom-url-attribute" : {
1164
+ "security" : {
1165
+ "throttle" : {
1166
+ "inline" : [ {
1167
+ "scope" : "APPSERVER",
1168
+ "rules" : [ {
1169
+ "duration" : 60000,
1170
+ "lock-period" : 300000,
1171
+ "threshold" : 10,
1172
+ "hip" : false
1173
+ }, {
1174
+ "duration" : 3600000,
1175
+ "lock-period" : 600000,
1176
+ "threshold" : 30,
1177
+ "hip" : false
1178
+ }, {
1179
+ "duration" : 86400000,
1180
+ "lock-period" : 1800000,
1181
+ "threshold" : 50,
1182
+ "hip" : false
1183
+ } ],
1184
+ "window" : "ROLLING",
1185
+ "key" : "url.path+user.zuid"
1186
+ } ]
1187
+ },
1188
+ "extraparams" : {
1189
+ "disable" : true,
1190
+ "ignore" : false
1191
+ },
1192
+ "authentication" : { }
1193
+ },
1194
+ "clan-group" : "common",
1195
+ "apihash" : "75621b948b7d5761e6db818a317a792c",
1196
+ "module-group" : "views",
1197
+ "apimethod" : "com.zoho.desk.views.restapi.ViewService.updateSelectFields"
1198
+ }
1199
+ }
1200
+ },
1201
+ "/api/v1/queueSlots" : {
1202
+ "get" : {
1203
+ "tags" : [ "CustomView" ],
1204
+ "summary" : "Get Slots For Specified Queue Mode",
1205
+ "description" : "This API fetches the slots for specified queue mode configured in your helpdesk.",
1206
+ "operationId" : "getQueueSlots",
1207
+ "parameters" : [ {
1208
+ "$ref" : "#/components/parameters/mode"
1209
+ }, {
1210
+ "$ref" : "#/components/parameters/departmentId"
1211
+ }, {
1212
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1213
+ } ],
1214
+ "responses" : {
1215
+ "200" : {
1216
+ "$ref" : "#/components/responses/getQueueSlotsResponse"
1217
+ },
1218
+ "422" : {
1219
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1220
+ }
1221
+ },
1222
+ "security" : [ {
1223
+ "org-oauth" : [ "accessAll.ALL" ]
1224
+ }, {
1225
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
1226
+ } ],
1227
+ "x-audience" : [ "company-internal" ],
1228
+ "x-custom-url-attribute" : {
1229
+ "security" : {
1230
+ "throttle" : {
1231
+ "inline" : [ {
1232
+ "scope" : "APPSERVER",
1233
+ "rules" : [ {
1234
+ "duration" : 60000,
1235
+ "lock-period" : 180000,
1236
+ "threshold" : 30,
1237
+ "hip" : false
1238
+ } ],
1239
+ "window" : "ROLLING",
1240
+ "key" : "url.path+user.zuid"
1241
+ } ]
1242
+ },
1243
+ "extraparams" : {
1244
+ "disable" : true,
1245
+ "ignore" : false
1246
+ },
1247
+ "authentication" : { }
1248
+ },
1249
+ "clan-group" : "common",
1250
+ "apihash" : "ed279bf6a162f55b949e8bcd5299dfb2",
1251
+ "module-group" : "views",
1252
+ "apimethod" : "com.zoho.support.restapi.QueueSlotsService.getQueueSlots"
1253
+ }
1254
+ }
1255
+ },
1256
+ "/api/v1/starredViews" : {
1257
+ "get" : {
1258
+ "tags" : [ "CustomView" ],
1259
+ "summary" : "List Starred Views",
1260
+ "description" : "This API lists the starred views in a module. Number of resources in the starred view is displayed only for the Tickets module.",
1261
+ "operationId" : "getStarredViews",
1262
+ "parameters" : [ {
1263
+ "$ref" : "#/components/parameters/module"
1264
+ }, {
1265
+ "$ref" : "#/components/parameters/departmentId"
1266
+ }, {
1267
+ "name" : "featureFlags",
1268
+ "in" : "header",
1269
+ "required" : false,
1270
+ "style" : "simple",
1271
+ "explode" : false,
1272
+ "schema" : {
1273
+ "type" : [ "string", "null" ],
1274
+ "enum" : [ "createdBy" ],
1275
+ "maxLength" : 100,
1276
+ "minLength" : 0
1277
+ }
1278
+ }, {
1279
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1280
+ } ],
1281
+ "responses" : {
1282
+ "200" : {
1283
+ "$ref" : "#/components/responses/getStarredViewsResponse"
1284
+ },
1285
+ "422" : {
1286
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1287
+ }
1288
+ },
1289
+ "security" : [ {
1290
+ "org-oauth" : [ "accessAll.ALL" ]
1291
+ }, {
1292
+ "iam-oauth2-schema" : [ "Desk.settings.READ" ]
1293
+ } ],
1294
+ "x-audience" : [ "external-public" ],
1295
+ "x-custom-url-attribute" : {
1296
+ "security" : {
1297
+ "throttle" : {
1298
+ "inline" : [ {
1299
+ "scope" : "APPSERVER",
1300
+ "rules" : [ {
1301
+ "duration" : 60000,
1302
+ "lock-period" : 120000,
1303
+ "threshold" : 50,
1304
+ "hip" : false
1305
+ }, {
1306
+ "duration" : 3600000,
1307
+ "lock-period" : 420000,
1308
+ "threshold" : 1000,
1309
+ "hip" : false
1310
+ } ],
1311
+ "window" : "ROLLING",
1312
+ "key" : "url.path+user.zuid"
1313
+ } ]
1314
+ },
1315
+ "extraparams" : {
1316
+ "disable" : true,
1317
+ "ignore" : false
1318
+ },
1319
+ "authentication" : {
1320
+ "iscscope" : [ "SupCrmAPI" ]
1321
+ }
1322
+ },
1323
+ "clan-group" : "common",
1324
+ "apihash" : "555cc4fa218c3da33c9025405fb3c996",
1325
+ "module-group" : "views",
1326
+ "apimethod" : "com.zoho.desk.views.restapi.StarredViewService.getStarredViews"
1327
+ }
1328
+ }
1329
+ },
1330
+ "/api/v1/queryStore" : {
1331
+ "get" : {
1332
+ "tags" : [ "CustomView" ],
1333
+ "operationId" : "getQueryStore",
1334
+ "parameters" : [ {
1335
+ "name" : "feature",
1336
+ "in" : "query",
1337
+ "description" : "Allowed values are : @viewQuery@",
1338
+ "required" : true,
1339
+ "style" : "form",
1340
+ "explode" : true,
1341
+ "schema" : {
1342
+ "type" : [ "string", "null" ],
1343
+ "description" : "Allowed values are : @viewQuery@",
1344
+ "enum" : [ "viewQuery" ],
1345
+ "maxLength" : 100,
1346
+ "minLength" : 0,
1347
+ "x-audience" : [ "company-internal" ]
1348
+ }
1349
+ }, {
1350
+ "name" : "type",
1351
+ "in" : "query",
1352
+ "description" : "Allowed values are : @execution@, @display@",
1353
+ "required" : true,
1354
+ "style" : "form",
1355
+ "explode" : true,
1356
+ "schema" : {
1357
+ "type" : [ "string", "null" ],
1358
+ "description" : "Allowed values are : @execution@, @display@",
1359
+ "enum" : [ "display", "execution" ],
1360
+ "maxLength" : 100,
1361
+ "minLength" : 0,
1362
+ "x-audience" : [ "company-internal" ]
1363
+ }
1364
+ }, {
1365
+ "name" : "userId",
1366
+ "in" : "query",
1367
+ "description" : "userId",
1368
+ "required" : true,
1369
+ "style" : "form",
1370
+ "explode" : true,
1371
+ "schema" : {
1372
+ "type" : [ "string", "null", "integer" ],
1373
+ "format" : "int64",
1374
+ "description" : "userId",
1375
+ "maximum" : 1,
1376
+ "pattern" : "([0-9]+)",
1377
+ "x-custom-parameters-attributes" : {
1378
+ "entity" : "Criteria"
1379
+ }
1380
+ }
1381
+ }, {
1382
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1383
+ } ],
1384
+ "responses" : {
1385
+ "200" : {
1386
+ "$ref" : "#/components/responses/getQueryStoreResponse"
1387
+ },
1388
+ "403" : {
1389
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1390
+ },
1391
+ "422" : {
1392
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1393
+ }
1394
+ },
1395
+ "security" : [ {
1396
+ "org-oauth" : [ "accessAll.ALL" ]
1397
+ }, {
1398
+ "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.basic.READ" ]
1399
+ } ],
1400
+ "x-audience" : [ "company-internal" ],
1401
+ "x-custom-url-attribute" : {
1402
+ "security" : {
1403
+ "throttle" : {
1404
+ "inline" : [ {
1405
+ "scope" : "APPSERVER",
1406
+ "rules" : [ {
1407
+ "duration" : 60000,
1408
+ "lock-period" : 600000,
1409
+ "threshold" : 30,
1410
+ "hip" : false
1411
+ } ],
1412
+ "window" : "ROLLING",
1413
+ "key" : "url.path+user.zuid"
1414
+ } ]
1415
+ },
1416
+ "extraparams" : {
1417
+ "disable" : true,
1418
+ "ignore" : false
1419
+ },
1420
+ "authentication" : { }
1421
+ },
1422
+ "clan-group" : "common",
1423
+ "apihash" : "8562389a6f8a7c425cece6407fe5e7c3123",
1424
+ "module-group" : "views",
1425
+ "apimethod" : "com.zoho.desk.framework.query.store.refactor.QueryStoreService.getQueryStore"
1426
+ }
1427
+ }
1428
+ }
1429
+ },
1430
+ "components" : {
1431
+ "schemas" : {
1432
+ "field" : {
1433
+ "type" : [ "null", "object" ],
1434
+ "additionalProperties" : false,
1435
+ "properties" : {
1436
+ "module" : {
1437
+ "type" : [ "string", "null" ],
1438
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "products", "calls", "events", "activities" ],
1439
+ "maxLength" : 100,
1440
+ "minLength" : 0
1441
+ },
1442
+ "apiName" : {
1443
+ "type" : "string"
1444
+ },
1445
+ "fieldLabel" : {
1446
+ "type" : "string"
1447
+ }
1448
+ },
1449
+ "required" : [ "apiName", "fieldLabel", "module" ]
1450
+ },
1451
+ "primitive" : {
1452
+ "type" : [ "null", "object" ],
1453
+ "additionalProperties" : false,
1454
+ "properites" : {
1455
+ "key" : {
1456
+ "type" : [ "null", "string", "integer" ]
1457
+ },
1458
+ "displaykey" : {
1459
+ "type" : [ "null", "string", "integer" ]
1460
+ }
1461
+ }
1462
+ },
1463
+ "value" : {
1464
+ "type" : [ "null", "object" ],
1465
+ "additionalProperties" : false,
1466
+ "properties" : {
1467
+ "type" : {
1468
+ "type" : "string",
1469
+ "enum" : [ "primitive" ]
1470
+ },
1471
+ "primitive" : {
1472
+ "$ref" : "#/components/schemas/primitive"
1473
+ }
1474
+ },
1475
+ "required" : [ "type" ]
1476
+ },
1477
+ "criteriaNewFields" : {
1478
+ "type" : [ "null", "array" ],
1479
+ "additionalProperties" : false,
1480
+ "properties" : {
1481
+ "field" : {
1482
+ "$ref" : "#/components/schemas/field"
1483
+ },
1484
+ "condition" : {
1485
+ "type" : "string"
1486
+ },
1487
+ "value" : {
1488
+ "$ref" : "#/components/schemas/value"
1489
+ }
1490
+ },
1491
+ "required" : [ "condition", "field", "value" ]
1492
+ },
1493
+ "criteriaNewResponseJson" : {
1494
+ "type" : [ "null", "object" ],
1495
+ "additionalProperties" : false,
1496
+ "properties" : {
1497
+ "criteriaFields" : {
1498
+ "$ref" : "#/components/schemas/criteriaNewFields"
1499
+ },
1500
+ "criteriaPattern" : {
1501
+ "type" : [ "string", "null" ],
1502
+ "maxLength" : 100,
1503
+ "minLength" : 0
1504
+ }
1505
+ },
1506
+ "required" : [ "criteriaFields", "criteriaPattern" ]
1507
+ },
1508
+ "criteriaRequestJson" : {
1509
+ "type" : [ "null", "object" ],
1510
+ "additionalProperties" : false,
1511
+ "properties" : {
1512
+ "condition" : {
1513
+ "type" : [ "string", "null" ],
1514
+ "maxLength" : 100,
1515
+ "minLength" : 0,
1516
+ "pattern" : "(.*|null|undefined)"
1517
+ },
1518
+ "fieldName" : {
1519
+ "type" : [ "string", "null" ],
1520
+ "maxLength" : 100,
1521
+ "minLength" : 0,
1522
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1523
+ },
1524
+ "fieldModule" : {
1525
+ "type" : [ "string", "null" ],
1526
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "products", "calls", "events", "activities" ],
1527
+ "maxLength" : 100,
1528
+ "minLength" : 0
1529
+ },
1530
+ "value" : {
1531
+ "type" : [ "null", "array" ],
1532
+ "items" : {
1533
+ "oneOf" : [ {
1534
+ "type" : [ "string", "null" ],
1535
+ "maxLength" : 100,
1536
+ "minLength" : 0,
1537
+ "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1538
+ }, {
1539
+ "type" : [ "null", "array" ],
1540
+ "items" : {
1541
+ "type" : [ "string", "null" ],
1542
+ "maxLength" : 100,
1543
+ "minLength" : 0,
1544
+ "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1545
+ },
1546
+ "uniqueItems" : false
1547
+ } ]
1548
+ },
1549
+ "uniqueItems" : false
1550
+ }
1551
+ },
1552
+ "required" : [ "condition", "fieldModule", "fieldName", "value" ]
1553
+ },
1554
+ "criteriaResponseJson" : {
1555
+ "additionalProperties" : false,
1556
+ "allOf" : [ {
1557
+ "$ref" : "#/components/schemas/criteriaRequestJson"
1558
+ }, {
1559
+ "type" : [ "null", "object" ],
1560
+ "properties" : {
1561
+ "displayValue" : {
1562
+ "type" : [ "null", "array" ],
1563
+ "items" : {
1564
+ "type" : [ "string", "null" ],
1565
+ "maxLength" : 100,
1566
+ "minLength" : 0
1567
+ },
1568
+ "uniqueItems" : false
1569
+ },
1570
+ "criteriaValues" : {
1571
+ "$ref" : "./CriteriaValue.json#/components/schemas/criteriaValueArr"
1572
+ }
1573
+ },
1574
+ "required" : [ "criteriaValues", "displayValue" ]
1575
+ } ]
1576
+ },
1577
+ "criteriaResponse" : {
1578
+ "type" : [ "null", "array" ],
1579
+ "items" : {
1580
+ "$ref" : "#/components/schemas/criteriaResponseJson"
1581
+ }
1582
+ },
1583
+ "criteriaDetailsResponse" : {
1584
+ "type" : [ "null", "object" ],
1585
+ "additionalProperties" : false,
1586
+ "properties" : {
1587
+ "fieldConditions" : {
1588
+ "$ref" : "#/components/schemas/criteriaResponse"
1589
+ },
1590
+ "pattern" : {
1591
+ "type" : [ "string", "null" ],
1592
+ "maxLength" : 100,
1593
+ "minLength" : 0,
1594
+ "pattern" : "[andor()0-9\\s]*"
1595
+ }
1596
+ },
1597
+ "required" : [ "fieldConditions", "pattern" ]
1598
+ },
1599
+ "criteriaRequest" : {
1600
+ "type" : [ "null", "array" ],
1601
+ "items" : {
1602
+ "$ref" : "#/components/schemas/criteriaRequestJson"
1603
+ }
1604
+ },
1605
+ "criteriaDetailsRequest" : {
1606
+ "type" : [ "null", "object" ],
1607
+ "additionalProperties" : false,
1608
+ "properties" : {
1609
+ "fieldConditions" : {
1610
+ "$ref" : "#/components/schemas/criteriaRequest"
1611
+ },
1612
+ "pattern" : {
1613
+ "type" : [ "string", "null" ],
1614
+ "maxLength" : 100,
1615
+ "minLength" : 0,
1616
+ "pattern" : "[andor()0-9\\s]*"
1617
+ }
1618
+ },
1619
+ "required" : [ "fieldConditions", "pattern" ]
1620
+ },
1621
+ "moduleMappingRequest" : {
1622
+ "type" : "object",
1623
+ "additionalProperties" : false,
1624
+ "properties" : {
1625
+ "primaryModule" : {
1626
+ "$ref" : "#/components/schemas/primaryModuleRequest"
1627
+ }
1628
+ },
1629
+ "required" : [ "primaryModule" ]
1630
+ },
1631
+ "primaryModuleRequest" : {
1632
+ "type" : "object",
1633
+ "additionalProperties" : false,
1634
+ "properties" : {
1635
+ "apiName" : {
1636
+ "type" : [ "string", "null" ],
1637
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "calls", "events", "activities" ],
1638
+ "maxLength" : 100,
1639
+ "minLength" : 0
1640
+ }
1641
+ },
1642
+ "required" : [ "apiName" ]
1643
+ },
1644
+ "accessibilityFormatForRequest" : {
1645
+ "oneOf" : [ {
1646
+ "type" : "object",
1647
+ "properties" : {
1648
+ "type" : {
1649
+ "type" : "string",
1650
+ "enum" : [ "onlyMe", "allAgents" ]
1651
+ }
1652
+ },
1653
+ "required" : [ "type" ]
1654
+ }, {
1655
+ "type" : "object",
1656
+ "properties" : {
1657
+ "type" : {
1658
+ "type" : "string",
1659
+ "enum" : [ "restrictedAccess" ]
1660
+ },
1661
+ "agents" : {
1662
+ "type" : "array",
1663
+ "items" : {
1664
+ "type" : "integer",
1665
+ "format" : "int64"
1666
+ }
1667
+ }
1668
+ },
1669
+ "required" : [ "agents", "type" ]
1670
+ } ]
1671
+ },
1672
+ "accessibilityFormatForResponse" : {
1673
+ "type" : "object",
1674
+ "properties" : {
1675
+ "type" : {
1676
+ "type" : "string",
1677
+ "enum" : [ "onlyMe", "allAgents", "restrictedAccess" ]
1678
+ },
1679
+ "agents" : {
1680
+ "type" : [ "null", "array" ],
1681
+ "items" : {
1682
+ "type" : [ "integer", "string" ],
1683
+ "format" : "int64"
1684
+ }
1685
+ },
1686
+ "rolesAndSubordinates" : {
1687
+ "type" : [ "null", "array" ],
1688
+ "items" : {
1689
+ "type" : [ "integer", "string" ],
1690
+ "format" : "int64"
1691
+ }
1692
+ },
1693
+ "teams" : {
1694
+ "type" : [ "null", "array" ],
1695
+ "items" : {
1696
+ "type" : [ "integer", "string" ],
1697
+ "format" : "int64"
1698
+ }
1699
+ },
1700
+ "roles" : {
1701
+ "type" : [ "null", "array" ],
1702
+ "items" : {
1703
+ "type" : [ "integer", "string" ],
1704
+ "format" : "int64"
1705
+ }
1706
+ }
1707
+ },
1708
+ "required" : [ "agents", "roles", "rolesAndSubordinates", "teams", "type" ]
1709
+ },
1710
+ "updateCustomViewJson" : {
1711
+ "type" : [ "null", "object" ],
1712
+ "additionalProperties" : false,
1713
+ "properties" : {
1714
+ "accessibility" : {
1715
+ "$ref" : "#/components/schemas/accessibilityFormatForRequest"
1716
+ },
1717
+ "criteria" : {
1718
+ "$ref" : "#/components/schemas/criteriaDetailsRequest"
1719
+ },
1720
+ "name" : {
1721
+ "type" : [ "string", "null" ],
1722
+ "maxLength" : 50,
1723
+ "minLength" : 0,
1724
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&<>\\+=]+"
1725
+ },
1726
+ "department" : {
1727
+ "type" : [ "string", "null", "integer" ],
1728
+ "format" : "int64",
1729
+ "pattern" : "([0-9]+|allDepartment)"
1730
+ }
1731
+ }
1732
+ },
1733
+ "getArchivedCustomViewJson" : {
1734
+ "type" : [ "null", "object" ],
1735
+ "additionalProperties" : false,
1736
+ "properties" : {
1737
+ "accessibility" : {
1738
+ "$ref" : "#/components/schemas/accessibilityFormatForResponse"
1739
+ },
1740
+ "criteria" : {
1741
+ "$ref" : "#/components/schemas/criteriaDetailsRequest"
1742
+ },
1743
+ "moduleMapping" : {
1744
+ "$ref" : "#/components/schemas/moduleMappingRequest"
1745
+ },
1746
+ "name" : {
1747
+ "type" : [ "string", "null" ],
1748
+ "maxLength" : 50,
1749
+ "minLength" : 0,
1750
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&<>\\+=]+"
1751
+ },
1752
+ "department" : {
1753
+ "type" : [ "string", "null", "integer" ],
1754
+ "format" : "int64",
1755
+ "pattern" : "([0-9]+|allDepartment)"
1756
+ },
1757
+ "module" : {
1758
+ "type" : [ "string", "null" ],
1759
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "calls", "events", "activities" ],
1760
+ "maxLength" : 100,
1761
+ "minLength" : 0
1762
+ }
1763
+ },
1764
+ "required" : [ "accessibility", "criteria", "department", "module", "name" ]
1765
+ },
1766
+ "addCustomViewJson" : {
1767
+ "type" : [ "null", "object" ],
1768
+ "additionalProperties" : false,
1769
+ "properties" : {
1770
+ "accessibility" : {
1771
+ "$ref" : "#/components/schemas/accessibilityFormatForRequest"
1772
+ },
1773
+ "criteria" : {
1774
+ "$ref" : "#/components/schemas/criteriaDetailsRequest"
1775
+ },
1776
+ "moduleMapping" : {
1777
+ "$ref" : "#/components/schemas/moduleMappingRequest"
1778
+ },
1779
+ "name" : {
1780
+ "type" : [ "string", "null" ],
1781
+ "maxLength" : 50,
1782
+ "minLength" : 0,
1783
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&<>\\+=]+"
1784
+ },
1785
+ "department" : {
1786
+ "type" : [ "string", "null", "integer" ],
1787
+ "format" : "int64",
1788
+ "pattern" : "([0-9]+|allDepartment)"
1789
+ },
1790
+ "module" : {
1791
+ "type" : [ "string", "null" ],
1792
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "calls", "events", "activities" ],
1793
+ "maxLength" : 100,
1794
+ "minLength" : 0
1795
+ }
1796
+ },
1797
+ "required" : [ "accessibility", "criteria", "department", "module", "moduleMapping", "name" ]
1798
+ },
1799
+ "getArchivedCustomViewResponse" : {
1800
+ "additionalProperties" : false,
1801
+ "allOf" : [ {
1802
+ "$ref" : "./CustomView.json#/components/schemas/getArchivedCustomViewJson"
1803
+ }, {
1804
+ "type" : [ "null", "object" ],
1805
+ "properties" : {
1806
+ "criteria" : {
1807
+ "$ref" : "./CustomView.json#/components/schemas/criteriaDetailsResponse"
1808
+ },
1809
+ "id" : {
1810
+ "type" : [ "string", "null", "integer" ],
1811
+ "format" : "int64",
1812
+ "pattern" : "([0-9]+)"
1813
+ }
1814
+ },
1815
+ "required" : [ "criteria", "id" ]
1816
+ } ]
1817
+ },
1818
+ "customViewNewResponse" : {
1819
+ "type" : [ "null", "object" ],
1820
+ "additionalProperties" : false,
1821
+ "properties" : {
1822
+ "accessibility" : {
1823
+ "$ref" : "#/components/schemas/accessibilityFormatForResponse"
1824
+ },
1825
+ "criteria" : {
1826
+ "$ref" : "#/components/schemas/criteriaNewResponseJson"
1827
+ },
1828
+ "moduleMapping" : {
1829
+ "$ref" : "#/components/schemas/moduleMappingRequest"
1830
+ },
1831
+ "name" : {
1832
+ "type" : [ "string", "null" ],
1833
+ "maxLength" : 50,
1834
+ "minLength" : 0,
1835
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
1836
+ },
1837
+ "displayLabel" : {
1838
+ "type" : [ "string", "null" ],
1839
+ "maxLength" : 50,
1840
+ "minLength" : 0,
1841
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
1842
+ },
1843
+ "sanitizedName" : {
1844
+ "type" : [ "string", "null" ],
1845
+ "maxLength" : 50,
1846
+ "minLength" : 0,
1847
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}&amp;&lt;&gt;\\+=]+"
1848
+ },
1849
+ "department" : {
1850
+ "type" : [ "string", "null", "integer" ],
1851
+ "format" : "int64",
1852
+ "pattern" : "([0-9]+|allDepartment)"
1853
+ },
1854
+ "id" : {
1855
+ "type" : [ "string", "null", "integer" ],
1856
+ "format" : "int64",
1857
+ "pattern" : "([0-9]+)"
1858
+ }
1859
+ },
1860
+ "required" : [ "accessibility", "criteria", "department", "id", "moduleMapping", "name" ]
1861
+ },
1862
+ "archivedViewSortField" : {
1863
+ "type" : [ "null", "object" ],
1864
+ "additionalProperties" : false,
1865
+ "properties" : {
1866
+ "name" : {
1867
+ "type" : [ "string", "null" ],
1868
+ "description" : "",
1869
+ "enum" : [ "createdTime", "modifiedTime" ],
1870
+ "maxLength" : 100,
1871
+ "minLength" : 0,
1872
+ "x-custom-parameters-attributes" : { }
1873
+ },
1874
+ "order" : {
1875
+ "type" : [ "string", "null" ],
1876
+ "description" : "",
1877
+ "enum" : [ "ascending", "descending" ],
1878
+ "maxLength" : 100,
1879
+ "minLength" : 0,
1880
+ "x-custom-parameters-attributes" : { }
1881
+ }
1882
+ },
1883
+ "required" : [ "name", "order" ]
1884
+ },
1885
+ "getArchivedSelectFields" : {
1886
+ "type" : [ "null", "object" ],
1887
+ "additionalProperties" : false,
1888
+ "properties" : {
1889
+ "fields" : {
1890
+ "type" : [ "null", "array" ],
1891
+ "description" : "",
1892
+ "items" : {
1893
+ "type" : [ "string", "null" ],
1894
+ "description" : "",
1895
+ "maxLength" : 100,
1896
+ "minLength" : 0,
1897
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1898
+ "x-custom-parameters-attributes" : { }
1899
+ },
1900
+ "maxItems" : 15,
1901
+ "minItems" : 1,
1902
+ "uniqueItems" : true,
1903
+ "x-custom-parameters-attributes" : { }
1904
+ }
1905
+ }
1906
+ },
1907
+ "archivedViewPreferenceKeys" : {
1908
+ "additionalProperties" : false,
1909
+ "allOf" : [ {
1910
+ "$ref" : "./CustomView.json#/components/schemas/getArchivedSelectFields"
1911
+ }, {
1912
+ "type" : [ "null", "object" ],
1913
+ "properties" : {
1914
+ "sortField" : {
1915
+ "$ref" : "./CustomView.json#/components/schemas/archivedViewSortField"
1916
+ },
1917
+ "fields" : {
1918
+ "type" : [ "null", "array" ],
1919
+ "description" : "",
1920
+ "items" : {
1921
+ "type" : [ "string", "null" ],
1922
+ "description" : "",
1923
+ "maxLength" : 100,
1924
+ "minLength" : 0,
1925
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1926
+ "x-custom-parameters-attributes" : { }
1927
+ },
1928
+ "maxItems" : 15,
1929
+ "minItems" : 1,
1930
+ "uniqueItems" : true,
1931
+ "x-custom-parameters-attributes" : { }
1932
+ }
1933
+ },
1934
+ "required" : [ "fields", "sortField" ]
1935
+ } ]
1936
+ },
1937
+ "formulaFieldResponse" : {
1938
+ "type" : [ "null", "object" ],
1939
+ "additionalProperties" : false,
1940
+ "properties" : {
1941
+ "displayLabel" : {
1942
+ "type" : [ "string", "null" ],
1943
+ "maxLength" : 100,
1944
+ "minLength" : 0
1945
+ },
1946
+ "isCustomField" : {
1947
+ "type" : [ "boolean", "null" ]
1948
+ },
1949
+ "i18NLabel" : {
1950
+ "type" : [ "string", "null" ],
1951
+ "maxLength" : 100,
1952
+ "minLength" : 0
1953
+ },
1954
+ "isSortable" : {
1955
+ "type" : [ "boolean", "null" ]
1956
+ },
1957
+ "isVisible" : {
1958
+ "type" : [ "boolean", "null" ]
1959
+ },
1960
+ "type" : {
1961
+ "type" : [ "string", "null" ],
1962
+ "enum" : [ "Text", "Number", "Percent", "Decimal", "Currency", "Date", "DateTime", "Email", "Phone", "Picklist", "URL", "Textarea", "Boolean", "Multiselect", "AutoNumber", "LookUp", "Fax", "Formula" ],
1963
+ "maxLength" : 100,
1964
+ "minLength" : 0
1965
+ },
1966
+ "isReadOnly" : {
1967
+ "type" : [ "boolean", "null" ]
1968
+ },
1969
+ "name" : {
1970
+ "type" : [ "string", "null" ],
1971
+ "maxLength" : 100,
1972
+ "minLength" : 0,
1973
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
1974
+ },
1975
+ "isEncryptedField" : {
1976
+ "type" : [ "boolean", "null" ]
1977
+ },
1978
+ "isPHI" : {
1979
+ "type" : [ "boolean", "null" ]
1980
+ },
1981
+ "id" : {
1982
+ "type" : [ "string", "null", "integer" ],
1983
+ "format" : "int64",
1984
+ "pattern" : "([0-9]+)"
1985
+ },
1986
+ "isMandatory" : {
1987
+ "type" : [ "boolean", "null" ]
1988
+ },
1989
+ "maxLength" : {
1990
+ "type" : [ "string", "null", "integer" ],
1991
+ "format" : "int32",
1992
+ "pattern" : "([0-9]+)"
1993
+ },
1994
+ "returnType" : {
1995
+ "type" : [ "string", "null" ],
1996
+ "maxLength" : 100,
1997
+ "minLength" : 0
1998
+ },
1999
+ "scope" : {
2000
+ "type" : [ "string", "null" ],
2001
+ "enum" : [ "Organization", "Department"],
2002
+ "maxLength" : 100,
2003
+ "minLength" : 0
2004
+ }
2005
+ },
2006
+ "required" : [ "displayLabel", "i18NLabel", "id", "isCustomField", "isEncryptedField", "isMandatory", "isPHI", "isReadOnly", "isSortable", "isVisible", "maxLength", "name", "returnType", "type" ]
2007
+ },
2008
+ "selectColumnMetaJson" : {
2009
+ "type" : [ "null", "object" ],
2010
+ "additionalProperties" : false,
2011
+ "properties" : {
2012
+ "displayLabel" : {
2013
+ "type" : [ "string", "null" ],
2014
+ "maxLength" : 100,
2015
+ "minLength" : 0
2016
+ },
2017
+ "isCustomField" : {
2018
+ "type" : [ "boolean", "null" ]
2019
+ },
2020
+ "i18NLabel" : {
2021
+ "type" : [ "string", "null" ],
2022
+ "maxLength" : 100,
2023
+ "minLength" : 0
2024
+ },
2025
+ "isSortable" : {
2026
+ "type" : [ "boolean", "null" ]
2027
+ },
2028
+ "isVisible" : {
2029
+ "type" : [ "boolean", "null" ]
2030
+ },
2031
+ "type" : {
2032
+ "type" : [ "string", "null" ],
2033
+ "enum" : [ "Text", "Number", "Percent", "Decimal", "Currency", "Date", "DateTime", "Email", "Phone", "Picklist", "URL", "Textarea", "Boolean", "Multiselect", "AutoNumber", "LookUp", "Fax", "Formula" ],
2034
+ "maxLength" : 100,
2035
+ "minLength" : 0
2036
+ },
2037
+ "isReadOnly" : {
2038
+ "type" : [ "boolean", "null" ]
2039
+ },
2040
+ "name" : {
2041
+ "type" : [ "string", "null" ],
2042
+ "maxLength" : 100,
2043
+ "minLength" : 0,
2044
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2045
+ },
2046
+ "isEncryptedField" : {
2047
+ "type" : [ "boolean", "null" ]
2048
+ },
2049
+ "isPHI" : {
2050
+ "type" : [ "boolean", "null" ]
2051
+ },
2052
+ "id" : {
2053
+ "type" : [ "string", "null", "integer" ],
2054
+ "format" : "int64",
2055
+ "pattern" : "([0-9]+)"
2056
+ },
2057
+ "isMandatory" : {
2058
+ "type" : [ "boolean", "null" ]
2059
+ },
2060
+ "maxLength" : {
2061
+ "type" : [ "string", "null", "integer" ],
2062
+ "format" : "int32",
2063
+ "pattern" : "([0-9]+)"
2064
+ },
2065
+ "scope" : {
2066
+ "type" : [ "string", "null" ],
2067
+ "enum" : [ "Organization", "Department"],
2068
+ "maxLength" : 100,
2069
+ "minLength" : 0
2070
+ }
2071
+ },
2072
+ "required" : [ "displayLabel", "i18NLabel", "id", "isCustomField", "isEncryptedField", "isMandatory", "isPHI", "isReadOnly", "isSortable", "isVisible", "maxLength", "name", "type" ]
2073
+ },
2074
+ "selectColumnJson" : {
2075
+ "type" : [ "null", "object" ],
2076
+ "additionalProperties" : false,
2077
+ "properties" : {
2078
+ "displayLabel" : {
2079
+ "type" : [ "string", "null" ],
2080
+ "maxLength" : 100,
2081
+ "minLength" : 0
2082
+ },
2083
+ "isReadOnly" : {
2084
+ "type" : [ "boolean", "null" ]
2085
+ },
2086
+ "isCustomField" : {
2087
+ "type" : [ "boolean", "null" ]
2088
+ },
2089
+ "name" : {
2090
+ "type" : [ "string", "null" ],
2091
+ "maxLength" : 100,
2092
+ "minLength" : 0,
2093
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2094
+ },
2095
+ "isEncryptedField" : {
2096
+ "type" : [ "boolean", "null" ]
2097
+ },
2098
+ "i18NLabel" : {
2099
+ "type" : [ "string", "null" ],
2100
+ "maxLength" : 100,
2101
+ "minLength" : 0
2102
+ },
2103
+ "isPHI" : {
2104
+ "type" : [ "boolean", "null" ]
2105
+ },
2106
+ "id" : {
2107
+ "type" : [ "string", "null", "integer" ],
2108
+ "format" : "int64",
2109
+ "pattern" : "([0-9]+)"
2110
+ },
2111
+ "isVisible" : {
2112
+ "type" : [ "boolean", "null" ]
2113
+ },
2114
+ "type" : {
2115
+ "type" : [ "string", "null" ],
2116
+ "enum" : [ "Text", "Number", "Percent", "Decimal", "Currency", "Date", "DateTime", "Email", "Phone", "Picklist", "URL", "Textarea", "Boolean", "Multiselect", "AutoNumber", "LookUp", "Fax", "Formula" ],
2117
+ "maxLength" : 100,
2118
+ "minLength" : 0
2119
+ },
2120
+ "isMandatory" : {
2121
+ "type" : [ "boolean", "null" ]
2122
+ },
2123
+ "maxLength" : {
2124
+ "type" : [ "string", "null", "integer" ],
2125
+ "format" : "int32",
2126
+ "pattern" : "([0-9]+)"
2127
+ },
2128
+ "scope" : {
2129
+ "type" : [ "string", "null" ],
2130
+ "enum" : [ "Organization", "Department"],
2131
+ "maxLength" : 100,
2132
+ "minLength" : 0
2133
+ }
2134
+ },
2135
+ "required" : [ "displayLabel", "i18NLabel", "id", "isCustomField", "isEncryptedField", "isMandatory", "isPHI", "isReadOnly", "isVisible", "maxLength", "name", "type" ]
2136
+ },
2137
+ "availableFieldsData" : {
2138
+ "type" : [ "null", "array" ],
2139
+ "items" : {
2140
+ "oneOf" : [ {
2141
+ "$ref" : "#/components/schemas/formulaFieldResponse"
2142
+ }, {
2143
+ "$ref" : "#/components/schemas/selectColumnMetaJson"
2144
+ }, {
2145
+ "$ref" : "#/components/schemas/selectColumnJson"
2146
+ } ]
2147
+ }
2148
+ },
2149
+ "customView_array" : {
2150
+ "type" : [ "null", "array" ],
2151
+ "items" : {
2152
+ "type" : [ "string", "null", "integer" ],
2153
+ "format" : "int64",
2154
+ "pattern" : "([0-9]+)"
2155
+ }
2156
+ },
2157
+ "sortField" : {
2158
+ "type" : [ "null", "object" ],
2159
+ "additionalProperties" : false,
2160
+ "properties" : {
2161
+ "name" : {
2162
+ "type" : [ "string", "null" ],
2163
+ "maxLength" : 200,
2164
+ "minLength" : 0,
2165
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2166
+ },
2167
+ "order" : {
2168
+ "type" : [ "string", "null" ],
2169
+ "enum" : [ "ascending", "descending" ],
2170
+ "maxLength" : 100,
2171
+ "minLength" : 0
2172
+ }
2173
+ },
2174
+ "required" : [ "name", "order" ]
2175
+ },
2176
+ "starredViewsJson" : {
2177
+ "type" : [ "null", "object" ],
2178
+ "additionalProperties" : false,
2179
+ "properties" : {
2180
+ "createdBy" : {
2181
+ "type" : [ "string", "null", "integer" ],
2182
+ "format" : "int64",
2183
+ "pattern" : "([0-9]+)",
2184
+ "properties" : { }
2185
+ },
2186
+ "isCustomView" : {
2187
+ "type" : [ "boolean", "null" ]
2188
+ },
2189
+ "name" : {
2190
+ "type" : [ "string", "null" ],
2191
+ "maxLength" : 50,
2192
+ "minLength" : 0,
2193
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
2194
+ },
2195
+ "id" : {
2196
+ "type" : [ "string", "null", "integer" ],
2197
+ "format" : "int64",
2198
+ "pattern" : "([0-9]+)"
2199
+ },
2200
+ "count" : {
2201
+ "type" : [ "string", "null", "integer" ],
2202
+ "format" : "int64",
2203
+ "pattern" : "([0-9]+)"
2204
+ },
2205
+ "deprecatedViewId" : {
2206
+ "type" : [ "string", "null", "integer" ],
2207
+ "format" : "int64",
2208
+ "pattern" : "([0-9]+)"
2209
+ },
2210
+ "viewName" : {
2211
+ "type" : [ "string", "null" ],
2212
+ "maxLength" : 50,
2213
+ "minLength" : 0
2214
+ }
2215
+ },
2216
+ "required" : [ "deprecatedViewId", "id", "isCustomView", "name", "viewName" ]
2217
+ },
2218
+ "viewsJson" : {
2219
+ "type" : [ "null", "object" ],
2220
+ "additionalProperties" : false,
2221
+ "properties" : {
2222
+ "isCustomView" : {
2223
+ "type" : [ "boolean", "null" ]
2224
+ },
2225
+ "name" : {
2226
+ "type" : [ "string", "null" ],
2227
+ "maxLength" : 50,
2228
+ "minLength" : 0,
2229
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
2230
+ },
2231
+ "id" : {
2232
+ "type" : [ "string", "null", "integer" ],
2233
+ "format" : "int64",
2234
+ "pattern" : "([0-9]+)"
2235
+ },
2236
+ "createdBy" : {
2237
+ "type" : [ "string", "null", "integer" ],
2238
+ "format" : "int64",
2239
+ "pattern" : "([0-9]+)"
2240
+ },
2241
+ "deprecatedViewId" : {
2242
+ "type" : [ "string", "null", "integer" ],
2243
+ "format" : "int64",
2244
+ "pattern" : "([0-9]+)"
2245
+ },
2246
+ "viewName" : {
2247
+ "type" : [ "string", "null" ],
2248
+ "maxLength" : 50,
2249
+ "minLength" : 0
2250
+ }
2251
+ },
2252
+ "required" : [ "isCustomView", "name", "id", "viewName" ]
2253
+ },
2254
+ "viewsData" : {
2255
+ "type" : [ "null", "array" ],
2256
+ "items" : {
2257
+ "$ref" : "#/components/schemas/viewsJson"
2258
+ }
2259
+ },
2260
+ "queueSlotsResponseArray" : {
2261
+ "type" : [ "null", "array" ],
2262
+ "items" : {
2263
+ "type" : [ "string", "null" ],
2264
+ "maxLength" : 100,
2265
+ "minLength" : 0,
2266
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2267
+ }
2268
+ },
2269
+ "queueSlotsArray" : {
2270
+ "type" : [ "null", "array" ],
2271
+ "items" : {
2272
+ "type" : [ "string", "null" ],
2273
+ "maxLength" : 3000,
2274
+ "minLength" : 0,
2275
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
2276
+ },
2277
+ "maxItems" : 10,
2278
+ "minItems" : 1
2279
+ },
2280
+ "starredViewResponseArray" : {
2281
+ "type" : [ "null", "array" ],
2282
+ "items" : {
2283
+ "$ref" : "#/components/schemas/starredViewsJson"
2284
+ }
2285
+ },
2286
+ "updateMyPreferenceSortField" : {
2287
+ "type" : [ "null", "object" ],
2288
+ "additionalProperties" : false,
2289
+ "properties" : {
2290
+ "name" : {
2291
+ "type" : [ "string", "null" ],
2292
+ "enum" : [ "createdTime", "modifiedTime" ],
2293
+ "maxLength" : 100,
2294
+ "minLength" : 0
2295
+ },
2296
+ "order" : {
2297
+ "type" : [ "string", "null" ],
2298
+ "enum" : [ "ascending", "descending" ],
2299
+ "maxLength" : 100,
2300
+ "minLength" : 0
2301
+ }
2302
+ },
2303
+ "required" : [ "name", "order" ]
2304
+ },
2305
+ "recentViewPreference" : {
2306
+ "type" : [ "null", "object" ],
2307
+ "additionalProperties" : false,
2308
+ "properties" : {
2309
+ "sortField" : {
2310
+ "$ref" : "#/components/schemas/sortField"
2311
+ },
2312
+ "records" : {
2313
+ "type" : [ "string", "null", "integer" ],
2314
+ "format" : "int32",
2315
+ "pattern" : "([0-9]+)"
2316
+ },
2317
+ "receivedIn" : {
2318
+ "type" : [ "string", "null" ],
2319
+ "enum" : [ "last15Days", "last30Days", "last90Days", "allDays" ],
2320
+ "maxLength" : 100,
2321
+ "minLength" : 0,
2322
+ "x-custom-parameters-attributes" : {
2323
+ "removeExif" : false,
2324
+ "filterMatchedContent" : false,
2325
+ "antivirus" : false,
2326
+ "replacementString" : "",
2327
+ "allowInvalid" : false,
2328
+ "descrption" : "Records received in.Allowed values are @last15Days@,@last30Days@,@last90Days@,@allDays@",
2329
+ "secret" : false,
2330
+ "preserveCharsLimit" : 10,
2331
+ "trim" : false,
2332
+ "internalParam" : false,
2333
+ "preserveChars" : "0,5",
2334
+ "importUrl" : false,
2335
+ "decrypt" : false
2336
+ }
2337
+ }
2338
+ },
2339
+ "required" : [ "receivedIn", "records", "sortField" ]
2340
+ }
2341
+ },
2342
+ "responses" : {
2343
+ "archivedViewPreference" : {
2344
+ "description" : "archivedViewPreference template definitions",
2345
+ "content" : {
2346
+ "application/json" : {
2347
+ "schema" : {
2348
+ "type" : [ "null", "object" ],
2349
+ "additionalProperties" : false,
2350
+ "properties" : {
2351
+ "data" : {
2352
+ "$ref" : "./CustomView.json#/components/schemas/archivedViewPreferenceKeys"
2353
+ }
2354
+ },
2355
+ "required" : [ "data" ]
2356
+ },
2357
+ "examples" : {
2358
+ "Valid responses Definitions" : {
2359
+ "value" : {
2360
+ "data" : {
2361
+ "fields" : [ "customerResponseTime", "assigneeId", "contactId", "subject", "channel", "dueDate", "ticketNumber" ],
2362
+ "sortField" : {
2363
+ "name" : "createdTime",
2364
+ "order" : "descending"
2365
+ }
2366
+ }
2367
+ }
2368
+ }
2369
+ }
2370
+ }
2371
+ },
2372
+ "x-custom-response-attributes" : { }
2373
+ },
2374
+ "getAvailableFieldsResponse" : {
2375
+ "description" : "getAvailableFieldsResponse template definitions",
2376
+ "content" : {
2377
+ "application/json" : {
2378
+ "schema" : {
2379
+ "type" : [ "null", "object" ],
2380
+ "additionalProperties" : false,
2381
+ "properties" : {
2382
+ "fields" : {
2383
+ "$ref" : "#/components/schemas/availableFieldsData"
2384
+ }
2385
+ },
2386
+ "required" : [ "fields" ]
2387
+ },
2388
+ "examples" : {
2389
+ "Valid responses Definitions" : {
2390
+ "value" : {
2391
+ "fields" : [ {
2392
+ "displayLabel" : "Account Name",
2393
+ "isReadOnly" : "false",
2394
+ "name" : "accountName",
2395
+ "id" : "5000000000369",
2396
+ "isVisible" : "true",
2397
+ "type" : "Text"
2398
+ }, {
2399
+ "displayLabel" : "Email",
2400
+ "isReadOnly" : "false",
2401
+ "name" : "email",
2402
+ "id" : "5000000000373",
2403
+ "isVisible" : "true",
2404
+ "type" : "Email"
2405
+ }, {
2406
+ "displayLabel" : "Phone",
2407
+ "isReadOnly" : "false",
2408
+ "name" : "phone",
2409
+ "id" : "5000000000371",
2410
+ "isVisible" : "true",
2411
+ "type" : "Phone"
2412
+ }, {
2413
+ "displayLabel" : "Website",
2414
+ "isReadOnly" : "false",
2415
+ "name" : "website",
2416
+ "id" : "5000000000375",
2417
+ "isVisible" : "true",
2418
+ "type" : "URL"
2419
+ }, {
2420
+ "displayLabel" : "Country",
2421
+ "isReadOnly" : "false",
2422
+ "name" : "country",
2423
+ "id" : "5000000000403",
2424
+ "isVisible" : "true",
2425
+ "type" : "Text"
2426
+ }, {
2427
+ "displayLabel" : "Category",
2428
+ "isReadOnly" : "true",
2429
+ "name" : "cf_category",
2430
+ "id" : "5000000000446",
2431
+ "isVisible" : "true",
2432
+ "type" : "Text"
2433
+ }, {
2434
+ "displayLabel" : "Account Owner",
2435
+ "isReadOnly" : "false",
2436
+ "name" : "ownerId",
2437
+ "id" : "5000000000377",
2438
+ "isVisible" : "true",
2439
+ "type" : "LookUp"
2440
+ } ]
2441
+ }
2442
+ }
2443
+ }
2444
+ }
2445
+ },
2446
+ "x-custom-response-attributes" : {
2447
+ "disable-safe-headers" : "[]"
2448
+ }
2449
+ },
2450
+ "customViewResponse" : {
2451
+ "description" : "customViewResponse template definitions",
2452
+ "content" : {
2453
+ "application/json" : {
2454
+ "schema" : {
2455
+ "$ref" : "#/components/schemas/customViewNewResponse"
2456
+ },
2457
+ "examples" : {
2458
+ "Valid responses Definitions" : {
2459
+ "value" : {
2460
+ "oldFormat" : {
2461
+ "accessibility" : {
2462
+ "roles" : null,
2463
+ "groups" : null,
2464
+ "type" : "restrictedAccess",
2465
+ "rolesAndSubordinates" : null,
2466
+ "agents" : [ "20998000000101010" ]
2467
+ },
2468
+ "criteria" : {
2469
+ "fieldConditions" : [ {
2470
+ "displayValue" : [ "${OPEN}" ],
2471
+ "criteriaValues" : [ {
2472
+ "displayValue" : "${OPEN}",
2473
+ "value" : "${OPEN}"
2474
+ } ],
2475
+ "condition" : "is OPEN",
2476
+ "fieldName" : "Status",
2477
+ "value" : [ "${OPEN}" ]
2478
+ }, {
2479
+ "displayValue" : [ "${CURRENTTIME}" ],
2480
+ "criteriaValues" : [ {
2481
+ "displayValue" : "${CURRENTTIME}",
2482
+ "value" : "${CURRENTTIME}"
2483
+ } ],
2484
+ "condition" : "is",
2485
+ "fieldName" : "Due Date",
2486
+ "value" : [ "${CURRENTTIME}" ]
2487
+ }, {
2488
+ "displayValue" : [ "Johnson" ],
2489
+ "criteriaValues" : [ {
2490
+ "displayValue" : "Johnson",
2491
+ "value" : "20998000000101010"
2492
+ } ],
2493
+ "condition" : "is",
2494
+ "fieldName" : "Case Owner",
2495
+ "value" : [ "20998000000101010" ]
2496
+ } ],
2497
+ "pattern" : "(1and2)or3"
2498
+ },
2499
+ "module" : "tickets",
2500
+ "name" : "my customview",
2501
+ "id" : "20998000000101016",
2502
+ "department" : "allDepartment"
2503
+ },
2504
+ "newFormat" : {
2505
+ "moduleMapping" : {
2506
+ "primaryModule" : {
2507
+ "apiName" : "tickets"
2508
+ }
2509
+ },
2510
+ "accessibility" : {
2511
+ "teams" : null,
2512
+ "roles" : null,
2513
+ "type" : "restrictedAccess",
2514
+ "rolesAndSubordinates" : null,
2515
+ "agents" : [ "20998000000101010" ]
2516
+ },
2517
+ "criteria" : {
2518
+ "criteriaFields" : [ {
2519
+ "condition" : "is OPEN",
2520
+ "field" : {
2521
+ "apiName" : "status",
2522
+ "module" : "tickets"
2523
+ },
2524
+ "value" : {
2525
+ "type" : "primitive"
2526
+ }
2527
+ }, {
2528
+ "condition" : "is",
2529
+ "field" : {
2530
+ "apiName" : "dueDate",
2531
+ "module" : "tickets"
2532
+ },
2533
+ "value" : {
2534
+ "primitive" : [ {
2535
+ "displayKey" : "${CURRENTTIME}",
2536
+ "key" : "${CURRENTTIME}"
2537
+ } ],
2538
+ "type" : "primitive"
2539
+ }
2540
+ }, {
2541
+ "condition" : "is",
2542
+ "field" : {
2543
+ "apiName" : "assigneeId",
2544
+ "module" : "tickets"
2545
+ },
2546
+ "value" : {
2547
+ "primitive" : [ {
2548
+ "displayKey" : "Johnson",
2549
+ "key" : "20998000000101010"
2550
+ } ],
2551
+ "type" : "primitive"
2552
+ }
2553
+ } ],
2554
+ "criteriaPattern" : "(1and2)or3"
2555
+ },
2556
+ "name" : "my customview",
2557
+ "id" : "20998000000101016",
2558
+ "department" : "allDepartment"
2559
+ }
2560
+ }
2561
+ }
2562
+ }
2563
+ }
2564
+ },
2565
+ "x-custom-response-attributes" : {
2566
+ "disable-safe-headers" : "[]"
2567
+ }
2568
+ },
2569
+ "getRecentViewJson" : {
2570
+ "description" : "getRecentViewJson template definitions",
2571
+ "content" : {
2572
+ "application/json" : {
2573
+ "schema" : {
2574
+ "type" : [ "null", "object" ],
2575
+ "additionalProperties" : false,
2576
+ "properties" : {
2577
+ "name" : {
2578
+ "type" : [ "string", "null" ],
2579
+ "maxLength" : 50,
2580
+ "minLength" : 0,
2581
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
2582
+ },
2583
+ "id" : {
2584
+ "type" : [ "string", "null", "integer" ],
2585
+ "format" : "int64",
2586
+ "pattern" : "([0-9]+)"
2587
+ },
2588
+ "preference" : {
2589
+ "ref" : "./CustomView.json#/components/schemas/recentViewPreference"
2590
+ },
2591
+ "sanitizedName" : {
2592
+ "type" : [ "string", "null" ],
2593
+ "maxLength" : 50,
2594
+ "minLength" : 0,
2595
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}&amp;&lt;&gt;\\+=]+"
2596
+ },
2597
+ "displayLabel" : {
2598
+ "type" : [ "string", "null" ],
2599
+ "maxLength" : 50,
2600
+ "minLength" : 0,
2601
+ "pattern" : "[0-9a-zA-Z_\\-\\.\\$@%\\?\\,\\:\\'\\P{InBasicLatin}\\s&amp;&lt;&gt;\\+=]+"
2602
+ }
2603
+ },
2604
+ "required" : [ "displayLabel", "id", "name", "preference", "sanitizedName" ]
2605
+ },
2606
+ "examples" : {
2607
+ "Valid responses Definitions" : {
2608
+ "value" : {
2609
+ "data" : {
2610
+ "name" : "My Records",
2611
+ "id" : "4000000008143"
2612
+ }
2613
+ }
2614
+ }
2615
+ }
2616
+ }
2617
+ },
2618
+ "x-custom-response-attributes" : {
2619
+ "disable-safe-headers" : "[]"
2620
+ }
2621
+ },
2622
+ "getViewPreferenceResponse" : {
2623
+ "description" : "getViewPreferenceResponse template definitions",
2624
+ "content" : {
2625
+ "application/json" : {
2626
+ "schema" : {
2627
+ "type" : [ "null", "object" ],
2628
+ "additionalProperties" : false,
2629
+ "properties" : {
2630
+ "records" : {
2631
+ "type" : [ "string", "null", "integer" ],
2632
+ "format" : "int64",
2633
+ "pattern" : "([0-9]+)"
2634
+ },
2635
+ "sortField" : {
2636
+ "$ref" : "#/components/schemas/sortField"
2637
+ },
2638
+ "receivedIn" : {
2639
+ "type" : [ "string", "null" ],
2640
+ "enum" : [ "last15Days", "last30Days", "last90Days", "allDays" ],
2641
+ "maxLength" : 100,
2642
+ "minLength" : 0,
2643
+ "x-custom-parameters-attributes" : {
2644
+ "removeExif" : false,
2645
+ "filterMatchedContent" : false,
2646
+ "antivirus" : false,
2647
+ "replacementString" : "",
2648
+ "allowInvalid" : false,
2649
+ "descrption" : "Records received in.Allowed values are @last15Days@,@last30Days@,@last90Days@,@allDays@",
2650
+ "secret" : false,
2651
+ "preserveCharsLimit" : 10,
2652
+ "trim" : false,
2653
+ "internalParam" : false,
2654
+ "preserveChars" : "0,5",
2655
+ "importUrl" : false,
2656
+ "decrypt" : false
2657
+ }
2658
+ }
2659
+ },
2660
+ "required" : [ "receivedIn", "records", "sortField" ]
2661
+ },
2662
+ "examples" : {
2663
+ "Valid responses Definitions" : {
2664
+ "value" : {
2665
+ "records" : "20",
2666
+ "sortField" : {
2667
+ "name" : "createdTime",
2668
+ "order" : "descending"
2669
+ },
2670
+ "receivedIn" : "last15Days"
2671
+ }
2672
+ }
2673
+ }
2674
+ }
2675
+ },
2676
+ "x-custom-response-attributes" : {
2677
+ "disable-safe-headers" : "[]"
2678
+ }
2679
+ },
2680
+ "getViewsResponse" : {
2681
+ "description" : "getViewsResponse template definitions",
2682
+ "content" : {
2683
+ "application/json" : {
2684
+ "schema" : {
2685
+ "type" : [ "null", "object" ],
2686
+ "additionalProperties" : false,
2687
+ "properties" : {
2688
+ "data" : {
2689
+ "$ref" : "#/components/schemas/viewsData"
2690
+ }
2691
+ },
2692
+ "required" : [ "data" ]
2693
+ },
2694
+ "examples" : {
2695
+ "Valid responses Definitions" : {
2696
+ "value" : {
2697
+ "data" : [ {
2698
+ "isCustomView" : false,
2699
+ "name" : "All Tasks",
2700
+ "id" : "4000000007834"
2701
+ }, {
2702
+ "isCustomView" : false,
2703
+ "name" : "My Tasks",
2704
+ "id" : "4000000007836"
2705
+ }, {
2706
+ "isCustomView" : false,
2707
+ "name" : "My Open Tasks",
2708
+ "id" : "4000000007838"
2709
+ }, {
2710
+ "isCustomView" : false,
2711
+ "name" : "Completed Tasks",
2712
+ "id" : "4000000007840"
2713
+ }, {
2714
+ "isCustomView" : false,
2715
+ "name" : "Open Tasks",
2716
+ "id" : "4000000007842"
2717
+ }, {
2718
+ "isCustomView" : false,
2719
+ "name" : "Overdue Tasks",
2720
+ "id" : "4000000007844"
2721
+ }, {
2722
+ "isCustomView" : false,
2723
+ "name" : "Todays Tasks",
2724
+ "id" : "4000000007846"
2725
+ }, {
2726
+ "isCustomView" : false,
2727
+ "name" : "Tomorrows Tasks",
2728
+ "id" : "4000000007848"
2729
+ }, {
2730
+ "isCustomView" : false,
2731
+ "name" : "Today+Overdue Tasks",
2732
+ "id" : "4000000007850"
2733
+ }, {
2734
+ "isCustomView" : false,
2735
+ "name" : "Next7days+Overdue Tasks",
2736
+ "id" : "4000000007852"
2737
+ } ]
2738
+ }
2739
+ }
2740
+ }
2741
+ }
2742
+ },
2743
+ "x-custom-response-attributes" : {
2744
+ "disable-safe-headers" : "[]"
2745
+ }
2746
+ },
2747
+ "getQueueSlotsResponse" : {
2748
+ "description" : "getQueueSlotsResponse template definitions",
2749
+ "content" : {
2750
+ "application/json" : {
2751
+ "schema" : {
2752
+ "type" : [ "null", "object" ],
2753
+ "additionalProperties" : false,
2754
+ "properties" : {
2755
+ "queueSlots" : {
2756
+ "$ref" : "#/components/schemas/queueSlotsResponseArray"
2757
+ }
2758
+ },
2759
+ "required" : [ "queueSlots" ]
2760
+ },
2761
+ "examples" : {
2762
+ "Valid responses Definitions" : {
2763
+ "value" : {
2764
+ "queueSlots" : [ "Open", "On Hold", "Escalated" ]
2765
+ }
2766
+ }
2767
+ }
2768
+ }
2769
+ },
2770
+ "x-custom-response-attributes" : {
2771
+ "disable-safe-headers" : "[]"
2772
+ }
2773
+ },
2774
+ "getSelectedFieldsResponse" : {
2775
+ "description" : "getSelectedFieldsResponse template definitions",
2776
+ "content" : {
2777
+ "application/json" : {
2778
+ "schema" : {
2779
+ "oneOf" : [ {
2780
+ "type" : [ "null", "object" ],
2781
+ "additionalProperties" : false,
2782
+ "properties" : {
2783
+ "fields" : {
2784
+ "type" : [ "null", "array" ],
2785
+ "items" : {
2786
+ "type" : [ "string", "null" ],
2787
+ "maxLength" : 100,
2788
+ "minLength" : 0,
2789
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2790
+ },
2791
+ "maxItems" : 15,
2792
+ "minItems" : 1,
2793
+ "uniqueItems" : true
2794
+ }
2795
+ },
2796
+ "required" : [ "fields" ]
2797
+ }, {
2798
+ "type" : [ "null", "object" ],
2799
+ "additionalProperties" : false,
2800
+ "properties" : {
2801
+ "fields" : {
2802
+ "$ref" : "#/components/schemas/availableFieldsData"
2803
+ }
2804
+ },
2805
+ "required" : [ "fields" ]
2806
+ } ]
2807
+ },
2808
+ "examples" : {
2809
+ "Valid responses Definitions" : {
2810
+ "value" : {
2811
+ "fields" : [ "ticketNumber", "subject", "contactId", "accountId", "customerResponseTime", "dueDate", "status", "channel" ]
2812
+ }
2813
+ }
2814
+ }
2815
+ }
2816
+ },
2817
+ "x-custom-response-attributes" : {
2818
+ "disable-safe-headers" : "[]"
2819
+ }
2820
+ },
2821
+ "getStarredViewsResponse" : {
2822
+ "description" : "getStarredViewsResponse template definitions",
2823
+ "content" : {
2824
+ "application/json" : {
2825
+ "schema" : {
2826
+ "type" : [ "null", "object" ],
2827
+ "additionalProperties" : false,
2828
+ "properties" : {
2829
+ "starredViews" : {
2830
+ "$ref" : "#/components/schemas/starredViewResponseArray"
2831
+ },
2832
+ "module" : {
2833
+ "type" : [ "string", "null" ],
2834
+ "enum" : [ "tickets", "tasks", "contracts", "accounts", "contacts", "calls", "events", "activities" ],
2835
+ "maxLength" : 100,
2836
+ "minLength" : 0,
2837
+ "x-custom-parameters-attributes" : {
2838
+ "removeExif" : false,
2839
+ "filterMatchedContent" : false,
2840
+ "antivirus" : false,
2841
+ "replacementString" : "",
2842
+ "allowInvalid" : false,
2843
+ "descrption" : "Module associated with the view. Values allowed are:@tickets@, @tasks@, @contacts@, @accounts@, @activities@, @calls@, @events@ or @contracts@.",
2844
+ "secret" : false,
2845
+ "preserveCharsLimit" : 10,
2846
+ "trim" : false,
2847
+ "internalParam" : false,
2848
+ "preserveChars" : "0,5",
2849
+ "importUrl" : false,
2850
+ "decrypt" : false,
2851
+ "entity" : "Views"
2852
+ }
2853
+ }
2854
+ },
2855
+ "required" : [ "module", "starredViews" ]
2856
+ },
2857
+ "examples" : {
2858
+ "Valid responses Definitions" : {
2859
+ "value" : {
2860
+ "starredViews" : [ {
2861
+ "isCustomView" : false,
2862
+ "name" : "All Tickets",
2863
+ "count" : "40",
2864
+ "id" : "4000000007834"
2865
+ }, {
2866
+ "isCustomView" : false,
2867
+ "name" : "Open Tickets",
2868
+ "count" : "22",
2869
+ "id" : "4000000007844"
2870
+ } ],
2871
+ "module" : "tickets"
2872
+ }
2873
+ }
2874
+ }
2875
+ }
2876
+ },
2877
+ "x-custom-response-attributes" : {
2878
+ "disable-safe-headers" : "[]"
2879
+ }
2880
+ },
2881
+ "getQueryStoreResponse" : {
2882
+ "description" : "getQueryStoreResponse template definitions",
2883
+ "content" : {
2884
+ "application/json" : {
2885
+ "schema" : {
2886
+ "type" : [ "null", "object" ],
2887
+ "additionalProperties" : false,
2888
+ "properties" : {
2889
+ "selectFields" : {
2890
+ "type" : [ "null", "array" ],
2891
+ "items" : {
2892
+ "type" : [ "null", "object" ],
2893
+ "additionalProperties" : false,
2894
+ "maxProperties" : 2,
2895
+ "minProperties" : 2,
2896
+ "properties" : {
2897
+ "apiName" : {
2898
+ "type" : [ "string", "null" ],
2899
+ "maxLength" : 100,
2900
+ "minLength" : 0,
2901
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2902
+ },
2903
+ "module" : {
2904
+ "type" : [ "string", "null" ],
2905
+ "maxLength" : 100,
2906
+ "minLength" : 0
2907
+ }
2908
+ },
2909
+ "required" : [ "apiName", "module" ]
2910
+ },
2911
+ "uniqueItems" : false
2912
+ },
2913
+ "moduleMapping" : {
2914
+ "type" : [ "null", "object" ],
2915
+ "additionalProperties" : false,
2916
+ "maxProperties" : 1,
2917
+ "minProperties" : 1,
2918
+ "properties" : {
2919
+ "primaryModule" : {
2920
+ "type" : [ "null", "object" ],
2921
+ "additionalProperties" : false,
2922
+ "maxProperties" : 1,
2923
+ "minProperties" : 1,
2924
+ "properties" : {
2925
+ "apiName" : {
2926
+ "type" : [ "string", "null" ],
2927
+ "maxLength" : 100,
2928
+ "minLength" : 0
2929
+ }
2930
+ },
2931
+ "required" : [ "apiName" ]
2932
+ }
2933
+ },
2934
+ "required" : [ "primaryModule" ]
2935
+ },
2936
+ "sortKey" : {
2937
+ "type" : [ "string", "null" ],
2938
+ "maxLength" : 100,
2939
+ "minLength" : 0,
2940
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2941
+ },
2942
+ "criteria" : {
2943
+ "type" : [ "null", "object" ],
2944
+ "additionalProperties" : false,
2945
+ "maxProperties" : 2,
2946
+ "minProperties" : 2,
2947
+ "properties" : {
2948
+ "criteriaFields" : {
2949
+ "type" : [ "null", "array" ],
2950
+ "items" : {
2951
+ "type" : [ "null", "object" ],
2952
+ "additionalProperties" : false,
2953
+ "maxProperties" : 3,
2954
+ "minProperties" : 3,
2955
+ "properties" : {
2956
+ "condition" : {
2957
+ "type" : [ "string", "null" ],
2958
+ "maxLength" : 100,
2959
+ "minLength" : 0
2960
+ },
2961
+ "field" : {
2962
+ "type" : [ "null", "object" ],
2963
+ "additionalProperties" : false,
2964
+ "maxProperties" : 2,
2965
+ "minProperties" : 2,
2966
+ "properties" : {
2967
+ "apiName" : {
2968
+ "type" : [ "string", "null" ],
2969
+ "maxLength" : 100,
2970
+ "minLength" : 0,
2971
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2972
+ },
2973
+ "module" : {
2974
+ "type" : [ "string", "null" ],
2975
+ "maxLength" : 100,
2976
+ "minLength" : 0
2977
+ }
2978
+ },
2979
+ "required" : [ "apiName", "module" ]
2980
+ },
2981
+ "value" : {
2982
+ "type" : [ "null", "object" ],
2983
+ "additionalProperties" : false,
2984
+ "maxProperties" : 1,
2985
+ "minProperties" : 1,
2986
+ "properties" : {
2987
+ "type" : {
2988
+ "type" : [ "string", "null" ],
2989
+ "maxLength" : 100,
2990
+ "minLength" : 0
2991
+ }
2992
+ },
2993
+ "required" : [ "type" ]
2994
+ }
2995
+ },
2996
+ "required" : [ "condition", "field", "value" ]
2997
+ },
2998
+ "uniqueItems" : false
2999
+ },
3000
+ "criteriaPattern" : {
3001
+ "type" : [ "string", "null" ],
3002
+ "maxLength" : 100,
3003
+ "minLength" : 0
3004
+ }
3005
+ },
3006
+ "required" : [ "criteriaFields", "criteriaPattern" ]
3007
+ }
3008
+ },
3009
+ "required" : [ "criteria", "moduleMapping", "selectFields", "sortKey" ]
3010
+ },
3011
+ "examples" : {
3012
+ "Valid responses Definitions" : {
3013
+ "value" : null
3014
+ }
3015
+ }
3016
+ }
3017
+ },
3018
+ "x-custom-response-attributes" : {
3019
+ "disable-safe-headers" : "[]"
3020
+ }
3021
+ }
3022
+ },
3023
+ "parameters" : {
3024
+ "featureFlags" : {
3025
+ "name" : "featureFlags",
3026
+ "in" : "header",
3027
+ "description" : "Feature flags for special cases",
3028
+ "required" : true,
3029
+ "style" : "simple",
3030
+ "explode" : false,
3031
+ "schema" : {
3032
+ "type" : "string",
3033
+ "enum" : [ "requestNewResponse", "showI18NFields", "sanitizedName" ]
3034
+ }
3035
+ },
3036
+ "cvId" : {
3037
+ "name" : "cvId",
3038
+ "in" : "path",
3039
+ "required" : true,
3040
+ "style" : "simple",
3041
+ "explode" : false,
3042
+ "schema" : {
3043
+ "type" : [ "string", "null", "integer" ],
3044
+ "format" : "int64",
3045
+ "pattern" : "([0-9]+)"
3046
+ }
3047
+ },
3048
+ "mode" : {
3049
+ "name" : "mode",
3050
+ "in" : "query",
3051
+ "description" : "Queue mode for which the ticket should be fetched.Values allowed are: @status@, @priority@, @crmContactType@, @dueInMinutes@.",
3052
+ "required" : true,
3053
+ "style" : "form",
3054
+ "explode" : true,
3055
+ "schema" : {
3056
+ "type" : [ "string", "null" ],
3057
+ "description" : "Queue mode for which the ticket should be fetched.Values allowed are: @status@, @priority@, @crmContactType@, @dueInMinutes@.",
3058
+ "enum" : [ "status", "priority", "dueInMinutes", "crmContactType" ],
3059
+ "maxLength" : 100,
3060
+ "minLength" : 0
3061
+ }
3062
+ },
3063
+ "departmentId" : {
3064
+ "name" : "departmentId",
3065
+ "in" : "query",
3066
+ "description" : "ID of the department in which the view(s) is (are) configured.",
3067
+ "required" : false,
3068
+ "style" : "form",
3069
+ "explode" : true,
3070
+ "schema" : {
3071
+ "type" : [ "string", "null", "integer" ],
3072
+ "format" : "int64",
3073
+ "description" : "ID of the department in which the view(s) is (are) configured.",
3074
+ "pattern" : "([0-9]+)"
3075
+ }
3076
+ },
3077
+ "module" : {
3078
+ "name" : "module",
3079
+ "in" : "query",
3080
+ "description" : "Allowed values are : @tickets@, @tasks@,@contacts@, @accounts@,@contacts@, @products@ ,@activities@,@calls@,@events@.",
3081
+ "required" : true,
3082
+ "style" : "form",
3083
+ "explode" : true,
3084
+ "schema" : {
3085
+ "type" : [ "string", "null" ],
3086
+ "description" : "Allowed values are : @tickets@, @tasks@,@contacts@, @accounts@,@contacts@, @products@ ,@activities@,@calls@,@events@.",
3087
+ "enum" : [ "tickets" ],
3088
+ "maxLength" : 100,
3089
+ "minLength" : 0,
3090
+ "x-custom-parameters-attributes" : {
3091
+ "entity" : "Views"
3092
+ }
3093
+ }
3094
+ }
3095
+ },
3096
+ "requestBodies" : {
3097
+ "archivedViewPreferenceKeys" : {
3098
+ "content" : {
3099
+ "application/json" : {
3100
+ "schema" : {
3101
+ "additionalProperties" : false,
3102
+ "allOf" : [ {
3103
+ "$ref" : "./CustomView.json#/components/schemas/getArchivedSelectFields"
3104
+ }, {
3105
+ "type" : [ "null", "object" ],
3106
+ "properties" : {
3107
+ "sortField" : {
3108
+ "$ref" : "./CustomView.json#/components/schemas/archivedViewSortField"
3109
+ },
3110
+ "fields" : {
3111
+ "type" : [ "null", "array" ],
3112
+ "items" : {
3113
+ "type" : [ "string", "null" ],
3114
+ "maxLength" : 100,
3115
+ "minLength" : 0,
3116
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
3117
+ "x-custom-parameters-attributes" : [ { } ]
3118
+ },
3119
+ "maxItems" : 15,
3120
+ "minItems" : 1,
3121
+ "uniqueItems" : true
3122
+ }
3123
+ }
3124
+ }, {
3125
+ "type" : "object"
3126
+ } ]
3127
+ },
3128
+ "examples" : {
3129
+ "Valid requestBody Definitions" : {
3130
+ "value" : {
3131
+ "sortField" : {
3132
+ "name" : "createdTime",
3133
+ "order" : "descending"
3134
+ },
3135
+ "fields" : [ "ticketNumber", "subject", "contactId", "accountId", "customerResponseTime", "dueDate", "status", "channel" ]
3136
+ }
3137
+ }
3138
+ }
3139
+ }
3140
+ },
3141
+ "x-custom-request-body-attributes" : {
3142
+ "non-empty" : false,
3143
+ "allow-invalid" : false
3144
+ }
3145
+ },
3146
+ "updateCustomViewJson" : {
3147
+ "content" : {
3148
+ "application/json" : {
3149
+ "schema" : {
3150
+ "$ref" : "#/components/schemas/updateCustomViewJson",
3151
+ "additionalProperties" : false
3152
+ },
3153
+ "examples" : {
3154
+ "Valid requestBody Definitions" : {
3155
+ "value" : {
3156
+ "oldFormat" : {
3157
+ "accessibility" : {
3158
+ "type" : "allAgents"
3159
+ },
3160
+ "criteria" : {
3161
+ "fieldConditions" : [ {
3162
+ "condition" : "is OPEN",
3163
+ "fieldName" : "Status",
3164
+ "value" : [ "${OPEN}" ]
3165
+ }, {
3166
+ "condition" : "is",
3167
+ "fieldName" : "Due Date",
3168
+ "value" : [ "${CURRENTTIME}" ]
3169
+ }, {
3170
+ "condition" : "is",
3171
+ "fieldName" : "Case Owner",
3172
+ "value" : [ "20998000000101010" ]
3173
+ } ],
3174
+ "pattern" : "(1and2)or3"
3175
+ },
3176
+ "name" : "my customview",
3177
+ "department" : "allDepartment"
3178
+ },
3179
+ "newFormat" : {
3180
+ "accessibility" : {
3181
+ "type" : "allAgents"
3182
+ },
3183
+ "criteria" : {
3184
+ "criteriaFields" : [ {
3185
+ "condition" : "is OPEN",
3186
+ "field" : {
3187
+ "apiName" : "status",
3188
+ "module" : "tickets"
3189
+ },
3190
+ "value" : {
3191
+ "type" : "primitive"
3192
+ }
3193
+ }, {
3194
+ "condition" : "is",
3195
+ "field" : {
3196
+ "apiName" : "dueDate",
3197
+ "module" : "tickets"
3198
+ },
3199
+ "value" : {
3200
+ "primitive" : [ {
3201
+ "key" : "${CURRENTTIME}"
3202
+ } ],
3203
+ "type" : "primitive"
3204
+ }
3205
+ }, {
3206
+ "condition" : "is",
3207
+ "field" : {
3208
+ "apiName" : "assigneeId",
3209
+ "module" : "tickets"
3210
+ },
3211
+ "value" : {
3212
+ "primitive" : [ {
3213
+ "key" : "20998000000101010"
3214
+ } ],
3215
+ "type" : "primitive"
3216
+ }
3217
+ } ],
3218
+ "criteriaPattern" : "(1and2)or3"
3219
+ },
3220
+ "name" : "my customview",
3221
+ "department" : "allDepartment"
3222
+ }
3223
+ }
3224
+ }
3225
+ }
3226
+ }
3227
+ },
3228
+ "x-custom-request-body-attributes" : {
3229
+ "non-empty" : false,
3230
+ "allow-invalid" : false
3231
+ }
3232
+ },
3233
+ "starredViewJsonOrder" : {
3234
+ "content" : {
3235
+ "application/json" : {
3236
+ "schema" : {
3237
+ "type" : [ "null", "object" ],
3238
+ "additionalProperties" : false,
3239
+ "properties" : {
3240
+ "starredViewIds" : {
3241
+ "$ref" : "#/components/schemas/customView_array"
3242
+ }
3243
+ },
3244
+ "required" : [ "starredViewIds" ]
3245
+ },
3246
+ "examples" : {
3247
+ "Valid requestBody Definitions" : {
3248
+ "value" : {
3249
+ "starredViewIds" : [ "4000000007808", "4000000007810", "4000000007818", "4000000007820", "4000000007828", "4000000007830", "4000000007848", "4000000007850" ]
3250
+ }
3251
+ }
3252
+ }
3253
+ }
3254
+ },
3255
+ "x-custom-request-body-attributes" : {
3256
+ "non-empty" : false,
3257
+ "allow-invalid" : false
3258
+ }
3259
+ },
3260
+ "getSelectedFieldsResponse" : {
3261
+ "content" : {
3262
+ "application/json" : {
3263
+ "schema" : {
3264
+ "type" : [ "null", "object" ],
3265
+ "additionalProperties" : false,
3266
+ "properties" : {
3267
+ "fields" : {
3268
+ "type" : [ "null", "array" ],
3269
+ "items" : {
3270
+ "type" : [ "string", "null" ],
3271
+ "maxLength" : 100,
3272
+ "minLength" : 0,
3273
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
3274
+ "x-custom-parameters-attributes" : [ { } ]
3275
+ },
3276
+ "maxItems" : 15,
3277
+ "minItems" : 1,
3278
+ "uniqueItems" : true
3279
+ }
3280
+ },
3281
+ "required" : [ "fields" ]
3282
+ },
3283
+ "examples" : {
3284
+ "Valid requestBody Definitions" : {
3285
+ "value" : {
3286
+ "fields" : [ "ticketNumber", "subject", "contactId", "accountId", "customerResponseTime", "dueDate", "status", "channel" ]
3287
+ }
3288
+ }
3289
+ }
3290
+ }
3291
+ },
3292
+ "x-custom-request-body-attributes" : {
3293
+ "non-empty" : false,
3294
+ "allow-invalid" : false
3295
+ }
3296
+ },
3297
+ "addCustomViewJson" : {
3298
+ "content" : {
3299
+ "application/json" : {
3300
+ "schema" : {
3301
+ "$ref" : "#/components/schemas/addCustomViewJson",
3302
+ "additionalProperties" : false
3303
+ },
3304
+ "examples" : {
3305
+ "Valid requestBody Definitions" : {
3306
+ "value" : {
3307
+ "oldFormat" : {
3308
+ "accessibility" : {
3309
+ "type" : "restrictedAccess",
3310
+ "agents" : [ "20998000000101010" ]
3311
+ },
3312
+ "criteria" : {
3313
+ "fieldConditions" : [ {
3314
+ "condition" : "is OPEN",
3315
+ "fieldName" : "Status",
3316
+ "value" : [ "${OPEN}" ]
3317
+ }, {
3318
+ "condition" : "is",
3319
+ "fieldName" : "Due Date",
3320
+ "value" : [ "${CURRENTTIME}" ]
3321
+ }, {
3322
+ "condition" : "is",
3323
+ "fieldName" : "Case Owner",
3324
+ "value" : [ "20998000000101010" ]
3325
+ } ],
3326
+ "pattern" : "(1and2)or3"
3327
+ },
3328
+ "module" : "tickets",
3329
+ "name" : "my customview",
3330
+ "department" : "allDepartment"
3331
+ },
3332
+ "newFormat" : {
3333
+ "moduleMapping" : {
3334
+ "primaryModule" : {
3335
+ "apiName" : "tickets"
3336
+ }
3337
+ },
3338
+ "accessibility" : {
3339
+ "type" : "restrictedAccess",
3340
+ "agents" : [ "20998000000101010" ]
3341
+ },
3342
+ "criteria" : {
3343
+ "criteriaFields" : [ {
3344
+ "condition" : "is OPEN",
3345
+ "field" : {
3346
+ "apiName" : "status",
3347
+ "module" : "tickets"
3348
+ },
3349
+ "value" : {
3350
+ "type" : "primitive"
3351
+ }
3352
+ }, {
3353
+ "condition" : "is",
3354
+ "field" : {
3355
+ "apiName" : "dueDate",
3356
+ "module" : "tickets"
3357
+ },
3358
+ "value" : {
3359
+ "primitive" : [ {
3360
+ "key" : "${CURRENTTIME}"
3361
+ } ],
3362
+ "type" : "primitive"
3363
+ }
3364
+ }, {
3365
+ "condition" : "is",
3366
+ "field" : {
3367
+ "apiName" : "assigneeId",
3368
+ "module" : "tickets"
3369
+ },
3370
+ "value" : {
3371
+ "primitive" : [ {
3372
+ "key" : "20998000000101010"
3373
+ } ],
3374
+ "type" : "primitive"
3375
+ }
3376
+ } ],
3377
+ "criteriaPattern" : "(1and2)or3"
3378
+ },
3379
+ "name" : "my customview",
3380
+ "department" : "allDepartment"
3381
+ }
3382
+ }
3383
+ }
3384
+ }
3385
+ }
3386
+ },
3387
+ "x-custom-request-body-attributes" : {
3388
+ "non-empty" : false,
3389
+ "allow-invalid" : false
3390
+ }
3391
+ },
3392
+ "queueSlotsJson" : {
3393
+ "content" : {
3394
+ "application/json" : {
3395
+ "schema" : {
3396
+ "type" : [ "null", "object" ],
3397
+ "additionalProperties" : false,
3398
+ "properties" : {
3399
+ "queueSlots" : {
3400
+ "$ref" : "#/components/schemas/queueSlotsArray"
3401
+ }
3402
+ },
3403
+ "required" : [ "queueSlots" ]
3404
+ },
3405
+ "examples" : {
3406
+ "Valid requestBody Definitions" : {
3407
+ "value" : {
3408
+ "queueSlots" : [ "Open", "On Hold", "Escalated" ]
3409
+ }
3410
+ }
3411
+ }
3412
+ }
3413
+ },
3414
+ "x-custom-request-body-attributes" : {
3415
+ "non-empty" : false,
3416
+ "allow-invalid" : false
3417
+ }
3418
+ },
3419
+ "updateMyViewPreferenceKeys" : {
3420
+ "content" : {
3421
+ "application/json" : {
3422
+ "schema" : {
3423
+ "type" : [ "null", "object" ],
3424
+ "additionalProperties" : false,
3425
+ "properties" : {
3426
+ "records" : {
3427
+ "type" : [ "string", "null" ],
3428
+ "enum" : [ "10", "20", "30", "40", "50" ],
3429
+ "maxLength" : 100,
3430
+ "minLength" : 0,
3431
+ "pattern" : "(10|20|30|40|50)"
3432
+ },
3433
+ "sortField" : {
3434
+ "$ref" : "#/components/schemas/updateMyPreferenceSortField"
3435
+ },
3436
+ "receivedIn" : {
3437
+ "type" : [ "string", "null" ],
3438
+ "enum" : [ "last15Days", "last30Days", "last90Days", "allDays" ],
3439
+ "maxLength" : 100,
3440
+ "minLength" : 0,
3441
+ "pattern" : "(last15Days|last30Days|last90Days|allDays)"
3442
+ }
3443
+ }
3444
+ },
3445
+ "examples" : {
3446
+ "Valid requestBody Definitions" : {
3447
+ "value" : {
3448
+ "records" : "20",
3449
+ "sortField" : {
3450
+ "name" : "createdTime",
3451
+ "order" : "descending"
3452
+ },
3453
+ "receivedIn" : "last15Days"
3454
+ }
3455
+ }
3456
+ }
3457
+ }
3458
+ },
3459
+ "x-custom-request-body-attributes" : {
3460
+ "non-empty" : false,
3461
+ "allow-invalid" : false
3462
+ }
3463
+ }
3464
+ },
3465
+ "securitySchemes" : {
3466
+ "cookie-auth" : {
3467
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
3468
+ },
3469
+ "org-oauth" : {
3470
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
3471
+ },
3472
+ "iam-oauth2-schema" : {
3473
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
3474
+ }
3475
+ }
3476
+ },
3477
+ "x-entity" : "CustomView"
3478
+ }