agent-generator 1.0.3 → 1.0.5

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