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