@epilot/sdk 2.0.0-beta.4 → 2.0.3

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 (290) hide show
  1. package/LICENSE +21 -0
  2. package/dist/{access-token.d-BuXO-21p.d.cts → access-token.d-CnmUTOlq.d.cts} +1 -1
  3. package/dist/{access-token.d-BuXO-21p.d.ts → access-token.d-CnmUTOlq.d.ts} +1 -1
  4. package/dist/{address-suggestions.d-Cay0qOfA.d.cts → address-suggestions.d-_YwTOR-9.d.cts} +1 -1
  5. package/dist/{address-suggestions.d-Cay0qOfA.d.ts → address-suggestions.d-_YwTOR-9.d.ts} +1 -1
  6. package/dist/{address.d-D-oZY0rk.d.cts → address.d-CwAPOVxa.d.cts} +1 -1
  7. package/dist/{address.d-D-oZY0rk.d.ts → address.d-CwAPOVxa.d.ts} +1 -1
  8. package/dist/{ai-agents.d-B4_CZTCP.d.cts → ai-agents.d-OkXfr2bz.d.cts} +1 -1
  9. package/dist/{ai-agents.d-B4_CZTCP.d.ts → ai-agents.d-OkXfr2bz.d.ts} +1 -1
  10. package/dist/apis/access-token.d.cts +3 -3
  11. package/dist/apis/access-token.d.ts +3 -3
  12. package/dist/apis/address-suggestions.d.cts +3 -3
  13. package/dist/apis/address-suggestions.d.ts +3 -3
  14. package/dist/apis/address.d.cts +3 -3
  15. package/dist/apis/address.d.ts +3 -3
  16. package/dist/apis/ai-agents.d.cts +3 -3
  17. package/dist/apis/ai-agents.d.ts +3 -3
  18. package/dist/apis/app.d.cts +3 -3
  19. package/dist/apis/app.d.ts +3 -3
  20. package/dist/apis/audit-logs.d.cts +3 -3
  21. package/dist/apis/audit-logs.d.ts +3 -3
  22. package/dist/apis/automation.d.cts +3 -3
  23. package/dist/apis/automation.d.ts +3 -3
  24. package/dist/apis/billing.d.cts +3 -3
  25. package/dist/apis/billing.d.ts +3 -3
  26. package/dist/apis/blueprint-manifest.d.cts +3 -3
  27. package/dist/apis/blueprint-manifest.d.ts +3 -3
  28. package/dist/apis/consent.d.cts +3 -3
  29. package/dist/apis/consent.d.ts +3 -3
  30. package/dist/apis/customer-portal.cjs +1 -1
  31. package/dist/apis/customer-portal.d.cts +3 -3
  32. package/dist/apis/customer-portal.d.ts +3 -3
  33. package/dist/apis/customer-portal.js +1 -1
  34. package/dist/apis/dashboard.d.cts +3 -3
  35. package/dist/apis/dashboard.d.ts +3 -3
  36. package/dist/apis/data-management.d.cts +3 -3
  37. package/dist/apis/data-management.d.ts +3 -3
  38. package/dist/apis/deduplication.d.cts +3 -3
  39. package/dist/apis/deduplication.d.ts +3 -3
  40. package/dist/apis/design.d.cts +3 -3
  41. package/dist/apis/design.d.ts +3 -3
  42. package/dist/apis/document.d.cts +3 -3
  43. package/dist/apis/document.d.ts +3 -3
  44. package/dist/apis/email-settings.d.cts +3 -3
  45. package/dist/apis/email-settings.d.ts +3 -3
  46. package/dist/apis/email-template.d.cts +3 -3
  47. package/dist/apis/email-template.d.ts +3 -3
  48. package/dist/apis/entity-mapping.d.cts +3 -3
  49. package/dist/apis/entity-mapping.d.ts +3 -3
  50. package/dist/apis/entity.d.cts +3 -3
  51. package/dist/apis/entity.d.ts +3 -3
  52. package/dist/apis/environments.d.cts +3 -3
  53. package/dist/apis/environments.d.ts +3 -3
  54. package/dist/apis/erp-integration.cjs +1 -1
  55. package/dist/apis/erp-integration.d.cts +3 -3
  56. package/dist/apis/erp-integration.d.ts +3 -3
  57. package/dist/apis/erp-integration.js +1 -1
  58. package/dist/apis/event-catalog.d.cts +3 -3
  59. package/dist/apis/event-catalog.d.ts +3 -3
  60. package/dist/apis/file.d.cts +3 -3
  61. package/dist/apis/file.d.ts +3 -3
  62. package/dist/apis/iban.d.cts +3 -3
  63. package/dist/apis/iban.d.ts +3 -3
  64. package/dist/apis/journey.d.cts +3 -3
  65. package/dist/apis/journey.d.ts +3 -3
  66. package/dist/apis/kanban.d.cts +3 -3
  67. package/dist/apis/kanban.d.ts +3 -3
  68. package/dist/apis/message.d.cts +3 -3
  69. package/dist/apis/message.d.ts +3 -3
  70. package/dist/apis/metering.d.cts +3 -3
  71. package/dist/apis/metering.d.ts +3 -3
  72. package/dist/apis/notes.d.cts +3 -3
  73. package/dist/apis/notes.d.ts +3 -3
  74. package/dist/apis/notification.d.cts +3 -3
  75. package/dist/apis/notification.d.ts +3 -3
  76. package/dist/apis/organization.cjs +1 -1
  77. package/dist/apis/organization.d.cts +3 -3
  78. package/dist/apis/organization.d.ts +3 -3
  79. package/dist/apis/organization.js +1 -1
  80. package/dist/apis/partner-directory.d.cts +3 -3
  81. package/dist/apis/partner-directory.d.ts +3 -3
  82. package/dist/apis/permissions.d.cts +3 -3
  83. package/dist/apis/permissions.d.ts +3 -3
  84. package/dist/apis/pricing-tier.d.cts +3 -3
  85. package/dist/apis/pricing-tier.d.ts +3 -3
  86. package/dist/apis/pricing.d.cts +3 -3
  87. package/dist/apis/pricing.d.ts +3 -3
  88. package/dist/apis/purpose.d.cts +3 -3
  89. package/dist/apis/purpose.d.ts +3 -3
  90. package/dist/apis/sandbox.d.cts +3 -3
  91. package/dist/apis/sandbox.d.ts +3 -3
  92. package/dist/apis/submission.d.cts +3 -3
  93. package/dist/apis/submission.d.ts +3 -3
  94. package/dist/apis/targeting.d.cts +3 -3
  95. package/dist/apis/targeting.d.ts +3 -3
  96. package/dist/apis/template-variables.d.cts +3 -3
  97. package/dist/apis/template-variables.d.ts +3 -3
  98. package/dist/apis/user.d.cts +3 -3
  99. package/dist/apis/user.d.ts +3 -3
  100. package/dist/apis/validation-rules.d.cts +3 -3
  101. package/dist/apis/validation-rules.d.ts +3 -3
  102. package/dist/apis/webhooks.d.cts +3 -3
  103. package/dist/apis/webhooks.d.ts +3 -3
  104. package/dist/apis/workflow-definition.d.cts +3 -3
  105. package/dist/apis/workflow-definition.d.ts +3 -3
  106. package/dist/apis/workflow.d.cts +3 -3
  107. package/dist/apis/workflow.d.ts +3 -3
  108. package/dist/{app.d-BKyfin-q.d.cts → app.d-Dr03n4J4.d.cts} +1 -1
  109. package/dist/{app.d-BKyfin-q.d.ts → app.d-Dr03n4J4.d.ts} +1 -1
  110. package/dist/{audit-logs.d-19BKb-ur.d.cts → audit-logs.d-BRToFqeX.d.cts} +1 -1
  111. package/dist/{audit-logs.d-19BKb-ur.d.ts → audit-logs.d-BRToFqeX.d.ts} +1 -1
  112. package/dist/{automation.d-DKl2VtnW.d.ts → automation.d-KOiZ6ru5.d.cts} +2 -24
  113. package/dist/{automation.d-DKl2VtnW.d.cts → automation.d-KOiZ6ru5.d.ts} +2 -24
  114. package/dist/{billing.d-58fUMBqj.d.cts → billing.d-Bs8Ku9qE.d.cts} +1 -1
  115. package/dist/{billing.d-58fUMBqj.d.ts → billing.d-Bs8Ku9qE.d.ts} +1 -1
  116. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.cts → blueprint-manifest.d-CEWRdF3i.d.cts} +1 -1
  117. package/dist/{blueprint-manifest.d-Bu1GyXFW.d.ts → blueprint-manifest.d-CEWRdF3i.d.ts} +1 -1
  118. package/dist/{consent.d-CQ88IEj0.d.cts → consent.d-C2PROHhX.d.cts} +1 -1
  119. package/dist/{consent.d-CQ88IEj0.d.ts → consent.d-C2PROHhX.d.ts} +1 -1
  120. package/dist/{customer-portal.d-EyndRWh6.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  121. package/dist/{customer-portal.d-EyndRWh6.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  122. package/dist/{dashboard.d-AE3RQ6zo.d.cts → dashboard.d-CsGcA74I.d.cts} +1 -1
  123. package/dist/{dashboard.d-AE3RQ6zo.d.ts → dashboard.d-CsGcA74I.d.ts} +1 -1
  124. package/dist/{data-management.d-CNExsqJQ.d.cts → data-management.d-pnuiRU2h.d.cts} +1 -1
  125. package/dist/{data-management.d-CNExsqJQ.d.ts → data-management.d-pnuiRU2h.d.ts} +1 -1
  126. package/dist/{deduplication.d-DCeJzdbM.d.ts → deduplication.d-w_2aJD5f.d.cts} +1 -1
  127. package/dist/{deduplication.d-DCeJzdbM.d.cts → deduplication.d-w_2aJD5f.d.ts} +1 -1
  128. package/dist/{design.d-CkwgJ78Z.d.cts → design.d-eA-irKEX.d.cts} +1 -1
  129. package/dist/{design.d-CkwgJ78Z.d.ts → design.d-eA-irKEX.d.ts} +1 -1
  130. package/dist/{document.d-Y8i32qNV.d.cts → document.d-DN37pjdx.d.cts} +1 -1
  131. package/dist/{document.d-Y8i32qNV.d.ts → document.d-DN37pjdx.d.ts} +1 -1
  132. package/dist/{email-settings.d-CPAsRFWN.d.cts → email-settings.d-BXxYjVDr.d.cts} +1 -1
  133. package/dist/{email-settings.d-CPAsRFWN.d.ts → email-settings.d-BXxYjVDr.d.ts} +1 -1
  134. package/dist/{email-template.d-CQqiCN0N.d.cts → email-template.d-BeqkDHtk.d.cts} +1 -1
  135. package/dist/{email-template.d-CQqiCN0N.d.ts → email-template.d-BeqkDHtk.d.ts} +1 -1
  136. package/dist/{entity-mapping.d-DiqXqJWb.d.cts → entity-mapping.d-DKSW3sfy.d.cts} +1 -1
  137. package/dist/{entity-mapping.d-DiqXqJWb.d.ts → entity-mapping.d-DKSW3sfy.d.ts} +1 -1
  138. package/dist/{entity.d-BtT4mdq4.d.ts → entity.d-CrtZaZr8.d.cts} +1 -1
  139. package/dist/{entity.d-BtT4mdq4.d.cts → entity.d-CrtZaZr8.d.ts} +1 -1
  140. package/dist/{environments.d-C1xIs8N2.d.cts → environments.d-H3LK_KuH.d.cts} +1 -1
  141. package/dist/{environments.d-C1xIs8N2.d.ts → environments.d-H3LK_KuH.d.ts} +1 -1
  142. package/dist/{erp-integration.d-CNLzgl4L.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  143. package/dist/{erp-integration.d-CNLzgl4L.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  144. package/dist/{event-catalog.d-DW1dOyVh.d.cts → event-catalog.d-ENw6HO-w.d.cts} +1 -1
  145. package/dist/{event-catalog.d-DW1dOyVh.d.ts → event-catalog.d-ENw6HO-w.d.ts} +1 -1
  146. package/dist/{file.d-Bpdt2ORN.d.cts → file.d-DcTJxjp7.d.cts} +1 -1
  147. package/dist/{file.d-Bpdt2ORN.d.ts → file.d-DcTJxjp7.d.ts} +1 -1
  148. package/dist/{iban.d-3_7FEsbx.d.ts → iban.d-BwdiGbxi.d.cts} +1 -1
  149. package/dist/{iban.d-3_7FEsbx.d.cts → iban.d-BwdiGbxi.d.ts} +1 -1
  150. package/dist/index.d.cts +46 -46
  151. package/dist/index.d.ts +46 -46
  152. package/dist/{journey.d-C2lgynUF.d.cts → journey.d-C4N4t1Rh.d.cts} +122 -4
  153. package/dist/{journey.d-C2lgynUF.d.ts → journey.d-C4N4t1Rh.d.ts} +122 -4
  154. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  155. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  156. package/dist/{message.d-TAVDRlDJ.d.cts → message.d-YEv1kmQd.d.cts} +1 -1
  157. package/dist/{message.d-TAVDRlDJ.d.ts → message.d-YEv1kmQd.d.ts} +1 -1
  158. package/dist/{metering.d-qyYaAU-O.d.cts → metering.d-DvtPv7wk.d.cts} +1 -1
  159. package/dist/{metering.d-qyYaAU-O.d.ts → metering.d-DvtPv7wk.d.ts} +1 -1
  160. package/dist/{notes.d-CDyIbegf.d.cts → notes.d-BC-scR42.d.cts} +1 -1
  161. package/dist/{notes.d-CDyIbegf.d.ts → notes.d-BC-scR42.d.ts} +1 -1
  162. package/dist/{notification.d-B7ccbaPr.d.cts → notification.d-BfBL3lga.d.cts} +1 -1
  163. package/dist/{notification.d-B7ccbaPr.d.ts → notification.d-BfBL3lga.d.ts} +1 -1
  164. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  165. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  166. package/dist/{partner-directory.d-CzKV3WfP.d.cts → partner-directory.d-CRNkDF8q.d.cts} +1 -1
  167. package/dist/{partner-directory.d-CzKV3WfP.d.ts → partner-directory.d-CRNkDF8q.d.ts} +1 -1
  168. package/dist/{permissions.d-lVoPAfl3.d.cts → permissions.d-BHB1FFS5.d.cts} +1 -1
  169. package/dist/{permissions.d-lVoPAfl3.d.ts → permissions.d-BHB1FFS5.d.ts} +1 -1
  170. package/dist/{pricing-tier.d-BW2cZt1w.d.cts → pricing-tier.d-Cg0jl6n_.d.cts} +1 -1
  171. package/dist/{pricing-tier.d-BW2cZt1w.d.ts → pricing-tier.d-Cg0jl6n_.d.ts} +1 -1
  172. package/dist/{pricing.d-Ehb2JuKY.d.cts → pricing.d-Cv39plGm.d.cts} +1 -1
  173. package/dist/{pricing.d-Ehb2JuKY.d.ts → pricing.d-Cv39plGm.d.ts} +1 -1
  174. package/dist/{purpose.d-BVxst611.d.cts → purpose.d-CbIYfTua.d.cts} +1 -1
  175. package/dist/{purpose.d-BVxst611.d.ts → purpose.d-CbIYfTua.d.ts} +1 -1
  176. package/dist/{sandbox.d-tRO2movo.d.cts → sandbox.d-BdbOFzDu.d.cts} +1 -1
  177. package/dist/{sandbox.d-tRO2movo.d.ts → sandbox.d-BdbOFzDu.d.ts} +1 -1
  178. package/dist/{submission.d-CSll5Km9.d.cts → submission.d-BamwfhXw.d.cts} +1 -1
  179. package/dist/{submission.d-CSll5Km9.d.ts → submission.d-BamwfhXw.d.ts} +1 -1
  180. package/dist/{targeting.d-CDxIsOWy.d.cts → targeting.d-BNmcVsNS.d.cts} +1 -1
  181. package/dist/{targeting.d-CDxIsOWy.d.ts → targeting.d-BNmcVsNS.d.ts} +1 -1
  182. package/dist/{template-variables.d-PwA27Ocv.d.cts → template-variables.d-Ch3H3zYf.d.cts} +1 -1
  183. package/dist/{template-variables.d-PwA27Ocv.d.ts → template-variables.d-Ch3H3zYf.d.ts} +1 -1
  184. package/dist/{user.d-DJBp6aX5.d.cts → user.d-CXqM751M.d.cts} +1 -1
  185. package/dist/{user.d-DJBp6aX5.d.ts → user.d-CXqM751M.d.ts} +1 -1
  186. package/dist/{validation-rules.d-CScjNdxD.d.cts → validation-rules.d-Db5c5zTf.d.cts} +1 -1
  187. package/dist/{validation-rules.d-CScjNdxD.d.ts → validation-rules.d-Db5c5zTf.d.ts} +1 -1
  188. package/dist/{webhooks.d-C_MQSJEB.d.cts → webhooks.d-CUNJrltY.d.cts} +1 -1
  189. package/dist/{webhooks.d-C_MQSJEB.d.ts → webhooks.d-CUNJrltY.d.ts} +1 -1
  190. package/dist/{workflow-definition.d-CFXrp2Hg.d.cts → workflow-definition.d-CE3kk9gl.d.cts} +1 -1
  191. package/dist/{workflow-definition.d-CFXrp2Hg.d.ts → workflow-definition.d-CE3kk9gl.d.ts} +1 -1
  192. package/dist/{workflow.d-BIWtgMyP.d.cts → workflow.d-DvhTpEtU.d.cts} +46 -4
  193. package/dist/{workflow.d-BIWtgMyP.d.ts → workflow.d-DvhTpEtU.d.ts} +46 -4
  194. package/package.json +152 -11
  195. package/definitions/access-token-runtime.json +0 -1
  196. package/definitions/access-token.json +0 -663
  197. package/definitions/address-runtime.json +0 -1
  198. package/definitions/address-suggestions-runtime.json +0 -1
  199. package/definitions/address-suggestions.json +0 -582
  200. package/definitions/address.json +0 -578
  201. package/definitions/ai-agents-runtime.json +0 -1
  202. package/definitions/ai-agents.json +0 -1711
  203. package/definitions/app-runtime.json +0 -1
  204. package/definitions/app.json +0 -4443
  205. package/definitions/audit-logs-runtime.json +0 -1
  206. package/definitions/audit-logs.json +0 -305
  207. package/definitions/automation-runtime.json +0 -1
  208. package/definitions/automation.json +0 -4850
  209. package/definitions/billing-runtime.json +0 -1
  210. package/definitions/billing.json +0 -837
  211. package/definitions/blueprint-manifest-runtime.json +0 -1
  212. package/definitions/blueprint-manifest.json +0 -3376
  213. package/definitions/consent-runtime.json +0 -1
  214. package/definitions/consent.json +0 -344
  215. package/definitions/customer-portal-runtime.json +0 -1
  216. package/definitions/customer-portal.json +0 -15000
  217. package/definitions/dashboard-runtime.json +0 -1
  218. package/definitions/dashboard.json +0 -484
  219. package/definitions/data-management-runtime.json +0 -1
  220. package/definitions/data-management.json +0 -962
  221. package/definitions/deduplication-runtime.json +0 -1
  222. package/definitions/deduplication.json +0 -183
  223. package/definitions/design-runtime.json +0 -1
  224. package/definitions/design.json +0 -1423
  225. package/definitions/document-runtime.json +0 -1
  226. package/definitions/document.json +0 -758
  227. package/definitions/email-settings-runtime.json +0 -1
  228. package/definitions/email-settings.json +0 -2627
  229. package/definitions/email-template-runtime.json +0 -1
  230. package/definitions/email-template.json +0 -1419
  231. package/definitions/entity-mapping-runtime.json +0 -1
  232. package/definitions/entity-mapping.json +0 -1642
  233. package/definitions/entity-runtime.json +0 -1
  234. package/definitions/entity.json +0 -10074
  235. package/definitions/environments-runtime.json +0 -1
  236. package/definitions/environments.json +0 -363
  237. package/definitions/erp-integration-runtime.json +0 -1
  238. package/definitions/erp-integration.json +0 -5845
  239. package/definitions/event-catalog-runtime.json +0 -1
  240. package/definitions/event-catalog.json +0 -1051
  241. package/definitions/file-runtime.json +0 -1
  242. package/definitions/file.json +0 -2842
  243. package/definitions/iban-runtime.json +0 -1
  244. package/definitions/iban.json +0 -132
  245. package/definitions/journey-runtime.json +0 -1
  246. package/definitions/journey.json +0 -2341
  247. package/definitions/kanban-runtime.json +0 -1
  248. package/definitions/kanban.json +0 -929
  249. package/definitions/message-runtime.json +0 -1
  250. package/definitions/message.json +0 -2660
  251. package/definitions/metering-runtime.json +0 -1
  252. package/definitions/metering.json +0 -2321
  253. package/definitions/notes-runtime.json +0 -1
  254. package/definitions/notes.json +0 -1531
  255. package/definitions/notification-runtime.json +0 -1
  256. package/definitions/notification.json +0 -1425
  257. package/definitions/organization-runtime.json +0 -1
  258. package/definitions/organization.json +0 -629
  259. package/definitions/partner-directory-runtime.json +0 -1
  260. package/definitions/partner-directory.json +0 -1718
  261. package/definitions/permissions-runtime.json +0 -1
  262. package/definitions/permissions.json +0 -1480
  263. package/definitions/pricing-runtime.json +0 -1
  264. package/definitions/pricing-tier-runtime.json +0 -1
  265. package/definitions/pricing-tier.json +0 -105
  266. package/definitions/pricing.json +0 -9884
  267. package/definitions/purpose-runtime.json +0 -1
  268. package/definitions/purpose.json +0 -524
  269. package/definitions/sandbox-runtime.json +0 -1
  270. package/definitions/sandbox.json +0 -453
  271. package/definitions/submission-runtime.json +0 -1
  272. package/definitions/submission.json +0 -313
  273. package/definitions/targeting-runtime.json +0 -1
  274. package/definitions/targeting.json +0 -1474
  275. package/definitions/template-variables-runtime.json +0 -1
  276. package/definitions/template-variables.json +0 -1408
  277. package/definitions/user-runtime.json +0 -1
  278. package/definitions/user.json +0 -2408
  279. package/definitions/validation-rules-runtime.json +0 -1
  280. package/definitions/validation-rules.json +0 -1491
  281. package/definitions/webhooks-runtime.json +0 -1
  282. package/definitions/webhooks.json +0 -1525
  283. package/definitions/workflow-definition-runtime.json +0 -1
  284. package/definitions/workflow-definition.json +0 -3417
  285. package/definitions/workflow-runtime.json +0 -1
  286. package/definitions/workflow.json +0 -4106
  287. package/dist/kanban.d-DYVjUQ_S.d.cts +0 -630
  288. package/dist/kanban.d-DYVjUQ_S.d.ts +0 -630
  289. package/dist/organization.d-BxZWnh8L.d.cts +0 -628
  290. package/dist/organization.d-BxZWnh8L.d.ts +0 -628
@@ -1,4106 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Workflows Executions",
5
- "version": "1.0.0",
6
- "description": "Service for Workflow Executions which covers executions of processes defined in an Organization\n"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://workflows-execution.sls.epilot.io"
11
- }
12
- ],
13
- "tags": [
14
- {
15
- "name": "Workflow Executions",
16
- "description": "Interact with workflow executions - start / close / retrieve one or all / search / delete"
17
- },
18
- {
19
- "name": "Workflow Steps"
20
- },
21
- {
22
- "name": "Closing Reasons"
23
- },
24
- {
25
- "name": "Flows V2"
26
- }
27
- ],
28
- "security": [
29
- {
30
- "BearerAuth": []
31
- }
32
- ],
33
- "paths": {
34
- "/v1/workflows/executions": {
35
- "get": {
36
- "operationId": "getExecutions",
37
- "summary": "getExecutions",
38
- "description": "Retrieve Workflow Executions. Optionally, you can filter them by context & schema. Please be aware, these executions are more light weight - steps are not loaded with all information.",
39
- "tags": [
40
- "Workflow Executions"
41
- ],
42
- "parameters": [
43
- {
44
- "in": "query",
45
- "name": "context",
46
- "schema": {
47
- "type": "string"
48
- },
49
- "required": false,
50
- "description": "Id of an Entity",
51
- "example": "2843c005-c5b0-4df2-94ee-1ca2ddd998ac"
52
- },
53
- {
54
- "in": "query",
55
- "name": "schema",
56
- "schema": {
57
- "type": "string"
58
- },
59
- "required": false,
60
- "description": "Schema of an Entity",
61
- "example": "contact"
62
- }
63
- ],
64
- "responses": {
65
- "200": {
66
- "description": "Success - executions loaded with success. Empty array if org has no executions.",
67
- "content": {
68
- "application/json": {
69
- "schema": {
70
- "type": "array",
71
- "items": {
72
- "$ref": "#/components/schemas/WorkflowExecutionSlim"
73
- }
74
- }
75
- }
76
- }
77
- },
78
- "500": {
79
- "description": "Other errors",
80
- "content": {
81
- "application/json": {
82
- "schema": {
83
- "$ref": "#/components/schemas/ErrorResp"
84
- }
85
- }
86
- }
87
- }
88
- }
89
- },
90
- "post": {
91
- "operationId": "createExecution",
92
- "summary": "createExecution",
93
- "description": "Create a Workflow Execution. Start a new workflow execution, based on a workflow definition (template).",
94
- "tags": [
95
- "Workflow Executions"
96
- ],
97
- "requestBody": {
98
- "description": "Workflow Execution payload",
99
- "required": true,
100
- "content": {
101
- "application/json": {
102
- "schema": {
103
- "$ref": "#/components/schemas/WorkflowExecutionCreateReq"
104
- }
105
- }
106
- }
107
- },
108
- "responses": {
109
- "201": {
110
- "description": "Success - if the execution is created successfully",
111
- "content": {
112
- "application/json": {
113
- "schema": {
114
- "$ref": "#/components/schemas/WorkflowExecution"
115
- }
116
- }
117
- }
118
- },
119
- "400": {
120
- "description": "Validation Errors",
121
- "content": {
122
- "application/json": {
123
- "schema": {
124
- "$ref": "#/components/schemas/ErrorResp"
125
- }
126
- }
127
- }
128
- },
129
- "401": {
130
- "description": "Authentication Errors",
131
- "content": {
132
- "application/json": {
133
- "schema": {
134
- "$ref": "#/components/schemas/ErrorResp"
135
- }
136
- }
137
- }
138
- },
139
- "500": {
140
- "description": "Other errors",
141
- "content": {
142
- "application/json": {
143
- "schema": {
144
- "$ref": "#/components/schemas/ErrorResp"
145
- }
146
- }
147
- }
148
- }
149
- }
150
- }
151
- },
152
- "/v1/workflows/executions/{executionId}": {
153
- "get": {
154
- "operationId": "getExecution",
155
- "summary": "getExecution",
156
- "description": "Get a full workflow execution, included steps information, by execution id.",
157
- "tags": [
158
- "Workflow Executions"
159
- ],
160
- "parameters": [
161
- {
162
- "in": "path",
163
- "name": "executionId",
164
- "schema": {
165
- "type": "string"
166
- },
167
- "required": true,
168
- "description": "Id of the execution",
169
- "example": "wd561"
170
- }
171
- ],
172
- "responses": {
173
- "200": {
174
- "description": "Success - execution loaded with success. Empty response execution was not found.",
175
- "content": {
176
- "application/json": {
177
- "schema": {
178
- "$ref": "#/components/schemas/WorkflowExecution"
179
- }
180
- }
181
- }
182
- },
183
- "500": {
184
- "description": "Other errors",
185
- "content": {
186
- "application/json": {
187
- "schema": {
188
- "$ref": "#/components/schemas/ErrorResp"
189
- }
190
- }
191
- }
192
- }
193
- }
194
- },
195
- "patch": {
196
- "operationId": "updateExecution",
197
- "summary": "updateExecution",
198
- "description": "Patches updates like assignees, status, closingReason for a single Workflow Execution.",
199
- "tags": [
200
- "Workflow Executions"
201
- ],
202
- "parameters": [
203
- {
204
- "in": "path",
205
- "name": "executionId",
206
- "schema": {
207
- "type": "string"
208
- },
209
- "required": true,
210
- "description": "Id of the execution",
211
- "example": "wd561"
212
- }
213
- ],
214
- "requestBody": {
215
- "description": "Patch Updates for Workflow Execution payload.",
216
- "required": true,
217
- "content": {
218
- "application/json": {
219
- "schema": {
220
- "$ref": "#/components/schemas/WorkflowExecutionUpdateReq"
221
- }
222
- }
223
- }
224
- },
225
- "responses": {
226
- "204": {
227
- "description": "Success - execution updated with success."
228
- },
229
- "500": {
230
- "description": "Other errors",
231
- "content": {
232
- "application/json": {
233
- "schema": {
234
- "$ref": "#/components/schemas/ErrorResp"
235
- }
236
- }
237
- }
238
- }
239
- }
240
- },
241
- "delete": {
242
- "operationId": "deleteExecution",
243
- "summary": "deleteExecution",
244
- "description": "Delete workflow execution by id. Workflow contexts will NOT be deleted.",
245
- "tags": [
246
- "Workflow Executions"
247
- ],
248
- "parameters": [
249
- {
250
- "in": "path",
251
- "name": "executionId",
252
- "schema": {
253
- "type": "string"
254
- },
255
- "required": true,
256
- "description": "Id of the execution to de deleted.",
257
- "example": "CustomerRequest"
258
- }
259
- ],
260
- "responses": {
261
- "204": {
262
- "description": "Success - if the execution was deleted successfully"
263
- },
264
- "401": {
265
- "description": "Failed to authenticate",
266
- "content": {
267
- "application/json": {
268
- "schema": {
269
- "$ref": "#/components/schemas/ErrorResp"
270
- }
271
- }
272
- }
273
- },
274
- "404": {
275
- "description": "No execution found"
276
- }
277
- }
278
- }
279
- },
280
- "/v1/workflows/executions/{executionId}/steps": {
281
- "post": {
282
- "operationId": "createStep",
283
- "summary": "createStep",
284
- "description": "Create a new step in current workflow execution.",
285
- "tags": [
286
- "Workflow Steps"
287
- ],
288
- "parameters": [
289
- {
290
- "in": "path",
291
- "name": "executionId",
292
- "schema": {
293
- "type": "string"
294
- },
295
- "required": true,
296
- "description": "Id of the execution",
297
- "example": "wd56125gah"
298
- }
299
- ],
300
- "requestBody": {
301
- "description": "Workflow Execution Step payload",
302
- "required": true,
303
- "content": {
304
- "application/json": {
305
- "schema": {
306
- "$ref": "#/components/schemas/CreateStepReq"
307
- }
308
- }
309
- }
310
- },
311
- "responses": {
312
- "201": {
313
- "description": "Success - if the step is created with success",
314
- "content": {
315
- "application/json": {
316
- "schema": {
317
- "$ref": "#/components/schemas/Step"
318
- }
319
- }
320
- }
321
- },
322
- "400": {
323
- "description": "Validation Errors",
324
- "content": {
325
- "application/json": {
326
- "schema": {
327
- "$ref": "#/components/schemas/ErrorResp"
328
- }
329
- }
330
- }
331
- },
332
- "401": {
333
- "description": "Authentication Errors",
334
- "content": {
335
- "application/json": {
336
- "schema": {
337
- "$ref": "#/components/schemas/ErrorResp"
338
- }
339
- }
340
- }
341
- },
342
- "500": {
343
- "description": "Other errors",
344
- "content": {
345
- "application/json": {
346
- "schema": {
347
- "$ref": "#/components/schemas/ErrorResp"
348
- }
349
- }
350
- }
351
- }
352
- }
353
- }
354
- },
355
- "/v1/workflows/executions/{executionId}/steps/{stepId}": {
356
- "patch": {
357
- "operationId": "updateStep",
358
- "summary": "updateStep",
359
- "description": "Patches various changes to a workflow execution step.",
360
- "tags": [
361
- "Workflow Steps"
362
- ],
363
- "parameters": [
364
- {
365
- "in": "path",
366
- "name": "executionId",
367
- "schema": {
368
- "type": "string"
369
- },
370
- "required": true,
371
- "description": "Id of the execution",
372
- "example": "wd56125gah"
373
- },
374
- {
375
- "in": "path",
376
- "name": "stepId",
377
- "schema": {
378
- "type": "string"
379
- },
380
- "required": true,
381
- "description": "Short uuid (length 6) to identify the Workflow Execution Step.",
382
- "example": "7hj28a"
383
- }
384
- ],
385
- "requestBody": {
386
- "description": "Workflow Execution Step payload",
387
- "required": true,
388
- "content": {
389
- "application/json": {
390
- "schema": {
391
- "$ref": "#/components/schemas/UpdateStepReq"
392
- },
393
- "examples": {
394
- "dynamicDueDate": {
395
- "value": {
396
- "stepId": "string",
397
- "assignedTo": [
398
- "10010730"
399
- ],
400
- "dynamicDueDate": {
401
- "numberOfUnits": 2,
402
- "timePeriod": "weeks",
403
- "actionTypeCondition": "STEP_CLOSED",
404
- "stepId": "optional"
405
- },
406
- "name": "Static Duedate",
407
- "position": {
408
- "index": 0
409
- },
410
- "sectionId": "string",
411
- "status": "string"
412
- }
413
- }
414
- }
415
- }
416
- }
417
- },
418
- "responses": {
419
- "200": {
420
- "description": "Success - if the step is updated successfully",
421
- "content": {
422
- "application/json": {
423
- "schema": {
424
- "$ref": "#/components/schemas/Step"
425
- }
426
- }
427
- }
428
- },
429
- "400": {
430
- "description": "Validation Errors",
431
- "content": {
432
- "application/json": {
433
- "schema": {
434
- "$ref": "#/components/schemas/ErrorResp"
435
- }
436
- }
437
- }
438
- },
439
- "401": {
440
- "description": "Authentication Errors",
441
- "content": {
442
- "application/json": {
443
- "schema": {
444
- "$ref": "#/components/schemas/ErrorResp"
445
- }
446
- }
447
- }
448
- },
449
- "500": {
450
- "description": "Other errors",
451
- "content": {
452
- "application/json": {
453
- "schema": {
454
- "$ref": "#/components/schemas/ErrorResp"
455
- }
456
- }
457
- }
458
- }
459
- }
460
- },
461
- "delete": {
462
- "operationId": "deleteStep",
463
- "summary": "deleteStep",
464
- "description": "Deletes a step from a workflow execution.",
465
- "tags": [
466
- "Workflow Steps"
467
- ],
468
- "parameters": [
469
- {
470
- "in": "path",
471
- "name": "executionId",
472
- "schema": {
473
- "type": "string"
474
- },
475
- "required": true,
476
- "description": "Id of the execution",
477
- "example": "wd56125gah"
478
- },
479
- {
480
- "in": "path",
481
- "name": "stepId",
482
- "schema": {
483
- "type": "string"
484
- },
485
- "required": true,
486
- "description": "Short uuid (length 6) to identify the Workflow Execution Step.",
487
- "example": "7hj28a"
488
- }
489
- ],
490
- "responses": {
491
- "204": {
492
- "description": "Deletion happened with success."
493
- },
494
- "500": {
495
- "description": "Other errors",
496
- "content": {
497
- "application/json": {
498
- "schema": {
499
- "$ref": "#/components/schemas/ErrorResp"
500
- }
501
- }
502
- }
503
- }
504
- }
505
- }
506
- },
507
- "/v1/workflows/executions/search": {
508
- "post": {
509
- "deprecated": true,
510
- "operationId": "searchExecutions",
511
- "summary": "searchExecutions",
512
- "description": "Search Workflow Executions by different filters.",
513
- "tags": [
514
- "Workflow Executions"
515
- ],
516
- "requestBody": {
517
- "description": "Search steps request",
518
- "required": true,
519
- "content": {
520
- "application/json": {
521
- "schema": {
522
- "$ref": "#/components/schemas/SearchExecutionsReq"
523
- }
524
- }
525
- }
526
- },
527
- "responses": {
528
- "200": {
529
- "description": "Success - filtered steps are returned",
530
- "content": {
531
- "application/json": {
532
- "schema": {
533
- "$ref": "#/components/schemas/SearchExecutionsResp"
534
- }
535
- }
536
- }
537
- },
538
- "400": {
539
- "description": "Validation Errors",
540
- "content": {
541
- "application/json": {
542
- "schema": {
543
- "$ref": "#/components/schemas/ErrorResp"
544
- }
545
- }
546
- }
547
- },
548
- "401": {
549
- "description": "Authentication Errors",
550
- "content": {
551
- "application/json": {
552
- "schema": {
553
- "$ref": "#/components/schemas/ErrorResp"
554
- }
555
- }
556
- }
557
- },
558
- "500": {
559
- "description": "Other errors",
560
- "content": {
561
- "application/json": {
562
- "schema": {
563
- "$ref": "#/components/schemas/ErrorResp"
564
- }
565
- }
566
- }
567
- }
568
- }
569
- }
570
- },
571
- "/v1/workflows/executions/steps/search": {
572
- "post": {
573
- "deprecated": true,
574
- "operationId": "searchSteps",
575
- "summary": "searchSteps",
576
- "description": "Search workflow execution steps by different filters.",
577
- "tags": [
578
- "Workflow Steps"
579
- ],
580
- "requestBody": {
581
- "description": "Search steps request",
582
- "required": true,
583
- "content": {
584
- "application/json": {
585
- "schema": {
586
- "$ref": "#/components/schemas/SearchStepsReq"
587
- }
588
- }
589
- }
590
- },
591
- "responses": {
592
- "200": {
593
- "description": "Success - filtered steps are returned",
594
- "content": {
595
- "application/json": {
596
- "schema": {
597
- "type": "object",
598
- "$ref": "#/components/schemas/SearchStepsResp"
599
- }
600
- }
601
- }
602
- },
603
- "400": {
604
- "description": "Validation Errors",
605
- "content": {
606
- "application/json": {
607
- "schema": {
608
- "$ref": "#/components/schemas/ErrorResp"
609
- }
610
- }
611
- }
612
- },
613
- "401": {
614
- "description": "Authentication Errors",
615
- "content": {
616
- "application/json": {
617
- "schema": {
618
- "$ref": "#/components/schemas/ErrorResp"
619
- }
620
- }
621
- }
622
- },
623
- "500": {
624
- "description": "Other errors",
625
- "content": {
626
- "application/json": {
627
- "schema": {
628
- "$ref": "#/components/schemas/ErrorResp"
629
- }
630
- }
631
- }
632
- }
633
- }
634
- }
635
- },
636
- "/v1/workflows/executions/{executionId}/closing-reasons": {
637
- "get": {
638
- "operationId": "getClosingReasonExecution",
639
- "summary": "getClosingReasonExecution",
640
- "description": "Shows all Closing Reasons defined at the moment of starting the Workflow Execution.\nThe Closing Reasons shown in the execution are just snapshots\nfrom the state of the Definition when the instance was created.\n",
641
- "tags": [
642
- "Closing Reasons"
643
- ],
644
- "parameters": [
645
- {
646
- "in": "path",
647
- "name": "executionId",
648
- "schema": {
649
- "type": "string"
650
- },
651
- "required": true,
652
- "description": "Id of the execution",
653
- "example": "wd561"
654
- }
655
- ],
656
- "responses": {
657
- "200": {
658
- "description": "returns all Closing Reasons for this Execution",
659
- "content": {
660
- "application/json": {
661
- "schema": {
662
- "$ref": "#/components/schemas/ClosingReasonResp"
663
- }
664
- }
665
- }
666
- },
667
- "500": {
668
- "description": "Internal Issues",
669
- "content": {
670
- "application/json": {
671
- "schema": {
672
- "$ref": "#/components/schemas/ErrorResp"
673
- }
674
- }
675
- }
676
- }
677
- }
678
- }
679
- },
680
- "/v2/flows/executions": {
681
- "post": {
682
- "operationId": "startFlowExecution",
683
- "summary": "startFlowExecution",
684
- "description": "Starts a new Flow Execution based on a flow template.",
685
- "tags": [
686
- "Flows V2"
687
- ],
688
- "requestBody": {
689
- "description": "Flow Execution payload",
690
- "required": true,
691
- "content": {
692
- "application/json": {
693
- "schema": {
694
- "$ref": "#/components/schemas/StartFlowReq"
695
- }
696
- }
697
- }
698
- },
699
- "responses": {
700
- "201": {
701
- "description": "Success - when the flow execution is started successfully",
702
- "content": {
703
- "application/json": {
704
- "schema": {
705
- "$ref": "#/components/schemas/FlowExecution"
706
- }
707
- }
708
- }
709
- },
710
- "400": {
711
- "description": "Validation Errors",
712
- "content": {
713
- "application/json": {
714
- "schema": {
715
- "$ref": "#/components/schemas/ErrorResp"
716
- }
717
- }
718
- }
719
- },
720
- "401": {
721
- "description": "Unauthorized"
722
- },
723
- "403": {
724
- "description": "Forbidden"
725
- },
726
- "500": {
727
- "description": "Other errors",
728
- "content": {
729
- "application/json": {
730
- "schema": {
731
- "$ref": "#/components/schemas/ErrorResp"
732
- }
733
- }
734
- }
735
- }
736
- }
737
- }
738
- },
739
- "/v2/flows/executions/{execution_id}": {
740
- "get": {
741
- "operationId": "getFlowExecution",
742
- "summary": "getFlowExecution",
743
- "description": "Get a full flow execution, included tasks, phases, edges & analytics.",
744
- "tags": [
745
- "Flows V2"
746
- ],
747
- "parameters": [
748
- {
749
- "$ref": "#/components/parameters/ExecutionIdParam"
750
- }
751
- ],
752
- "responses": {
753
- "200": {
754
- "description": "Success - execution",
755
- "content": {
756
- "application/json": {
757
- "schema": {
758
- "$ref": "#/components/schemas/FlowExecution"
759
- }
760
- }
761
- }
762
- },
763
- "401": {
764
- "description": "Unauthorized"
765
- },
766
- "403": {
767
- "description": "Forbidden"
768
- },
769
- "404": {
770
- "description": "Not Found"
771
- }
772
- }
773
- },
774
- "patch": {
775
- "operationId": "patchFlowExecution",
776
- "summary": "patchFlowExecution",
777
- "description": "Patch flow execution with new assignees, status, analytics & other changes.",
778
- "tags": [
779
- "Flows V2"
780
- ],
781
- "parameters": [
782
- {
783
- "$ref": "#/components/parameters/ExecutionIdParam"
784
- }
785
- ],
786
- "requestBody": {
787
- "description": "Patch Flow Execution payload.",
788
- "required": true,
789
- "content": {
790
- "application/json": {
791
- "schema": {
792
- "$ref": "#/components/schemas/PatchFlowReq"
793
- }
794
- }
795
- }
796
- },
797
- "responses": {
798
- "200": {
799
- "description": "Success - execution updated with success.",
800
- "content": {
801
- "application/json": {
802
- "schema": {
803
- "$ref": "#/components/schemas/FlowExecution"
804
- }
805
- }
806
- }
807
- },
808
- "401": {
809
- "description": "Unauthorized"
810
- },
811
- "403": {
812
- "description": "Forbidden"
813
- },
814
- "404": {
815
- "description": "Not Found"
816
- },
817
- "500": {
818
- "description": "Other errors",
819
- "content": {
820
- "application/json": {
821
- "schema": {
822
- "$ref": "#/components/schemas/ErrorResp"
823
- }
824
- }
825
- }
826
- }
827
- }
828
- },
829
- "delete": {
830
- "operationId": "deleteFlowExecution",
831
- "summary": "deleteFlowExecution",
832
- "description": "Deletes a specific execution of a flow, identified by id. Flow contexts will NOT be deleted.",
833
- "tags": [
834
- "Flows V2"
835
- ],
836
- "parameters": [
837
- {
838
- "$ref": "#/components/parameters/ExecutionIdParam"
839
- },
840
- {
841
- "$ref": "#/components/parameters/SoftDeleteParam"
842
- }
843
- ],
844
- "responses": {
845
- "204": {
846
- "description": "Success - if the execution was deleted successfully"
847
- },
848
- "401": {
849
- "description": "Unauthorized"
850
- },
851
- "403": {
852
- "description": "Forbidden"
853
- },
854
- "404": {
855
- "description": "Not Found"
856
- }
857
- }
858
- }
859
- },
860
- "/v2/flows/executions:search": {
861
- "post": {
862
- "operationId": "searchFlowExecutions",
863
- "summary": "searchFlowExecutions",
864
- "description": "Search Flow Executions for a specific Entity.",
865
- "tags": [
866
- "Flows V2"
867
- ],
868
- "requestBody": {
869
- "description": "Search Flow Executions for a specific Entity",
870
- "required": true,
871
- "content": {
872
- "application/json": {
873
- "schema": {
874
- "$ref": "#/components/schemas/SearchFlowsReq"
875
- }
876
- }
877
- }
878
- },
879
- "responses": {
880
- "200": {
881
- "description": "List of Running Flow Executions",
882
- "content": {
883
- "application/json": {
884
- "schema": {
885
- "type": "object",
886
- "properties": {
887
- "results": {
888
- "type": "array",
889
- "items": {
890
- "$ref": "#/components/schemas/FlowExecution"
891
- }
892
- }
893
- }
894
- }
895
- }
896
- }
897
- },
898
- "400": {
899
- "description": "Validation Errors",
900
- "content": {
901
- "application/json": {
902
- "schema": {
903
- "$ref": "#/components/schemas/ErrorResp"
904
- }
905
- }
906
- }
907
- },
908
- "401": {
909
- "description": "Unauthorized"
910
- },
911
- "403": {
912
- "description": "Forbidden"
913
- },
914
- "500": {
915
- "description": "Other errors",
916
- "content": {
917
- "application/json": {
918
- "schema": {
919
- "$ref": "#/components/schemas/ErrorResp"
920
- }
921
- }
922
- }
923
- }
924
- }
925
- }
926
- },
927
- "/v2/flows/executions/{execution_id}/tasks/{task_id}": {
928
- "patch": {
929
- "operationId": "patchTask",
930
- "summary": "patchTask",
931
- "description": "Changes various attributes of a flow task, like assignees, status, due date, etc.",
932
- "tags": [
933
- "Flows V2"
934
- ],
935
- "parameters": [
936
- {
937
- "$ref": "#/components/parameters/ExecutionIdParam"
938
- },
939
- {
940
- "$ref": "#/components/parameters/TaskIdParam"
941
- }
942
- ],
943
- "requestBody": {
944
- "description": "Patch Task Payload",
945
- "required": true,
946
- "content": {
947
- "application/json": {
948
- "schema": {
949
- "$ref": "#/components/schemas/PatchTaskReq"
950
- }
951
- }
952
- }
953
- },
954
- "responses": {
955
- "200": {
956
- "description": "Success - when task has been successfully updated",
957
- "content": {
958
- "application/json": {
959
- "schema": {
960
- "$ref": "#/components/schemas/Task"
961
- }
962
- }
963
- }
964
- },
965
- "400": {
966
- "description": "Validation Errors",
967
- "content": {
968
- "application/json": {
969
- "schema": {
970
- "$ref": "#/components/schemas/ErrorResp"
971
- }
972
- }
973
- }
974
- },
975
- "401": {
976
- "description": "Authentication Errors",
977
- "content": {
978
- "application/json": {
979
- "schema": {
980
- "$ref": "#/components/schemas/ErrorResp"
981
- }
982
- }
983
- }
984
- },
985
- "500": {
986
- "description": "Other errors",
987
- "content": {
988
- "application/json": {
989
- "schema": {
990
- "$ref": "#/components/schemas/ErrorResp"
991
- }
992
- }
993
- }
994
- }
995
- }
996
- }
997
- },
998
- "/v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run": {
999
- "post": {
1000
- "operationId": "runTaskAutomation",
1001
- "summary": "runTaskAutomation",
1002
- "description": "Runs configured automation for a flow task",
1003
- "tags": [
1004
- "Flows V2"
1005
- ],
1006
- "parameters": [
1007
- {
1008
- "$ref": "#/components/parameters/ExecutionIdParam"
1009
- },
1010
- {
1011
- "$ref": "#/components/parameters/TaskIdParam"
1012
- }
1013
- ],
1014
- "responses": {
1015
- "200": {
1016
- "description": "Success - when task automation has been successfully started",
1017
- "content": {
1018
- "application/json": {
1019
- "schema": {
1020
- "$ref": "#/components/schemas/AutomationTask"
1021
- }
1022
- }
1023
- }
1024
- },
1025
- "400": {
1026
- "description": "Validation Errors",
1027
- "content": {
1028
- "application/json": {
1029
- "schema": {
1030
- "$ref": "#/components/schemas/ErrorResp"
1031
- }
1032
- }
1033
- }
1034
- },
1035
- "401": {
1036
- "description": "Authentication Errors",
1037
- "content": {
1038
- "application/json": {
1039
- "schema": {
1040
- "$ref": "#/components/schemas/ErrorResp"
1041
- }
1042
- }
1043
- }
1044
- },
1045
- "500": {
1046
- "description": "Other errors",
1047
- "content": {
1048
- "application/json": {
1049
- "schema": {
1050
- "$ref": "#/components/schemas/ErrorResp"
1051
- }
1052
- }
1053
- }
1054
- }
1055
- }
1056
- }
1057
- },
1058
- "/v2/flows/executions/{execution_id}/tasks/{task_id}/execute": {
1059
- "post": {
1060
- "operationId": "executeTask",
1061
- "summary": "executeTask",
1062
- "description": "Executes any kind of flow task immediately.",
1063
- "tags": [
1064
- "Flows V2"
1065
- ],
1066
- "parameters": [
1067
- {
1068
- "$ref": "#/components/parameters/ExecutionIdParam"
1069
- },
1070
- {
1071
- "$ref": "#/components/parameters/TaskIdParam"
1072
- }
1073
- ],
1074
- "responses": {
1075
- "200": {
1076
- "description": "Success - when task has been executed manually or automation has been started.",
1077
- "content": {
1078
- "application/json": {
1079
- "schema": {
1080
- "$ref": "#/components/schemas/Task"
1081
- }
1082
- }
1083
- }
1084
- },
1085
- "400": {
1086
- "description": "Validation Errors",
1087
- "content": {
1088
- "application/json": {
1089
- "schema": {
1090
- "$ref": "#/components/schemas/ErrorResp"
1091
- }
1092
- }
1093
- }
1094
- },
1095
- "401": {
1096
- "description": "Authentication Errors",
1097
- "content": {
1098
- "application/json": {
1099
- "schema": {
1100
- "$ref": "#/components/schemas/ErrorResp"
1101
- }
1102
- }
1103
- }
1104
- },
1105
- "500": {
1106
- "description": "Other errors",
1107
- "content": {
1108
- "application/json": {
1109
- "schema": {
1110
- "$ref": "#/components/schemas/ErrorResp"
1111
- }
1112
- }
1113
- }
1114
- }
1115
- }
1116
- }
1117
- },
1118
- "/v2/flows/executions/{execution_id}/phases/{phase_id}": {
1119
- "patch": {
1120
- "operationId": "patchPhase",
1121
- "summary": "patchPhase",
1122
- "description": "Apply updates to a phase within flow execution",
1123
- "tags": [
1124
- "Flows V2"
1125
- ],
1126
- "parameters": [
1127
- {
1128
- "$ref": "#/components/parameters/ExecutionIdParam"
1129
- },
1130
- {
1131
- "$ref": "#/components/parameters/PhaseIdParam"
1132
- }
1133
- ],
1134
- "requestBody": {
1135
- "description": "Patch Phase Payload",
1136
- "required": true,
1137
- "content": {
1138
- "application/json": {
1139
- "schema": {
1140
- "$ref": "#/components/schemas/PatchPhaseReq"
1141
- }
1142
- }
1143
- }
1144
- },
1145
- "responses": {
1146
- "200": {
1147
- "description": "Success - when phase has been successfully updated",
1148
- "content": {
1149
- "application/json": {
1150
- "schema": {
1151
- "$ref": "#/components/schemas/Phase"
1152
- }
1153
- }
1154
- }
1155
- },
1156
- "400": {
1157
- "description": "Validation Errors",
1158
- "content": {
1159
- "application/json": {
1160
- "schema": {
1161
- "$ref": "#/components/schemas/ErrorResp"
1162
- }
1163
- }
1164
- }
1165
- },
1166
- "401": {
1167
- "description": "Authentication Errors",
1168
- "content": {
1169
- "application/json": {
1170
- "schema": {
1171
- "$ref": "#/components/schemas/ErrorResp"
1172
- }
1173
- }
1174
- }
1175
- },
1176
- "500": {
1177
- "description": "Other errors",
1178
- "content": {
1179
- "application/json": {
1180
- "schema": {
1181
- "$ref": "#/components/schemas/ErrorResp"
1182
- }
1183
- }
1184
- }
1185
- }
1186
- }
1187
- }
1188
- },
1189
- "/v2/flows/executions/{execution_id}/tasks": {
1190
- "post": {
1191
- "operationId": "addTask",
1192
- "summary": "addTask",
1193
- "description": "Create a new task in current workflow execution.",
1194
- "tags": [
1195
- "Flows V2"
1196
- ],
1197
- "parameters": [
1198
- {
1199
- "$ref": "#/components/parameters/ExecutionIdParam"
1200
- }
1201
- ],
1202
- "requestBody": {
1203
- "description": "Workflow Execution Task payload",
1204
- "required": true,
1205
- "content": {
1206
- "application/json": {
1207
- "schema": {
1208
- "$ref": "#/components/schemas/AddTaskReq"
1209
- }
1210
- }
1211
- }
1212
- },
1213
- "responses": {
1214
- "201": {
1215
- "description": "Success - if the task is created with success",
1216
- "content": {
1217
- "application/json": {
1218
- "schema": {
1219
- "$ref": "#/components/schemas/Task"
1220
- }
1221
- }
1222
- }
1223
- },
1224
- "400": {
1225
- "description": "Validation Errors",
1226
- "content": {
1227
- "application/json": {
1228
- "schema": {
1229
- "$ref": "#/components/schemas/ErrorResp"
1230
- }
1231
- }
1232
- }
1233
- },
1234
- "401": {
1235
- "description": "Authentication Errors",
1236
- "content": {
1237
- "application/json": {
1238
- "schema": {
1239
- "$ref": "#/components/schemas/ErrorResp"
1240
- }
1241
- }
1242
- }
1243
- },
1244
- "500": {
1245
- "description": "Other errors",
1246
- "content": {
1247
- "application/json": {
1248
- "schema": {
1249
- "$ref": "#/components/schemas/ErrorResp"
1250
- }
1251
- }
1252
- }
1253
- }
1254
- }
1255
- }
1256
- },
1257
- "/v2/flows/executions/{execution_id}/tasks/{task_id}/schedule": {
1258
- "delete": {
1259
- "operationId": "cancelTaskSchedule",
1260
- "summary": "cancelTaskSchedule",
1261
- "description": "Cancels a scheduled task, deleting the schedule and marking the task as skipped.",
1262
- "tags": [
1263
- "Flows V2"
1264
- ],
1265
- "parameters": [
1266
- {
1267
- "$ref": "#/components/parameters/ExecutionIdParam"
1268
- },
1269
- {
1270
- "$ref": "#/components/parameters/TaskIdParam"
1271
- }
1272
- ],
1273
- "responses": {
1274
- "204": {
1275
- "description": "Success - when schedule has been successfully canceled"
1276
- },
1277
- "400": {
1278
- "description": "Validation Errors",
1279
- "content": {
1280
- "application/json": {
1281
- "schema": {
1282
- "$ref": "#/components/schemas/ErrorResp"
1283
- }
1284
- }
1285
- }
1286
- },
1287
- "401": {
1288
- "description": "Authentication Errors",
1289
- "content": {
1290
- "application/json": {
1291
- "schema": {
1292
- "$ref": "#/components/schemas/ErrorResp"
1293
- }
1294
- }
1295
- }
1296
- },
1297
- "404": {
1298
- "description": "Not Found",
1299
- "content": {
1300
- "application/json": {
1301
- "schema": {
1302
- "$ref": "#/components/schemas/ErrorResp"
1303
- }
1304
- }
1305
- }
1306
- },
1307
- "500": {
1308
- "description": "Other errors",
1309
- "content": {
1310
- "application/json": {
1311
- "schema": {
1312
- "$ref": "#/components/schemas/ErrorResp"
1313
- }
1314
- }
1315
- }
1316
- }
1317
- }
1318
- }
1319
- },
1320
- "/v2/flows/executions/{execution_id}/schedules/{schedule_id}": {
1321
- "post": {
1322
- "operationId": "cancelSchedule",
1323
- "summary": "cancelSchedule",
1324
- "deprecated": true,
1325
- "description": "Cancels a flow schedule, marking it as canceled.\n\n**Deprecated**: Use DELETE /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule instead.\n",
1326
- "tags": [
1327
- "Flows V2"
1328
- ],
1329
- "parameters": [
1330
- {
1331
- "$ref": "#/components/parameters/ExecutionIdParam"
1332
- },
1333
- {
1334
- "$ref": "#/components/parameters/ScheduleIdParam"
1335
- }
1336
- ],
1337
- "responses": {
1338
- "204": {
1339
- "description": "Success - when schedule has been successfully canceled"
1340
- },
1341
- "400": {
1342
- "description": "Validation Errors",
1343
- "content": {
1344
- "application/json": {
1345
- "schema": {
1346
- "$ref": "#/components/schemas/ErrorResp"
1347
- }
1348
- }
1349
- }
1350
- },
1351
- "401": {
1352
- "description": "Authentication Errors",
1353
- "content": {
1354
- "application/json": {
1355
- "schema": {
1356
- "$ref": "#/components/schemas/ErrorResp"
1357
- }
1358
- }
1359
- }
1360
- },
1361
- "404": {
1362
- "description": "Not Found",
1363
- "content": {
1364
- "application/json": {
1365
- "schema": {
1366
- "$ref": "#/components/schemas/ErrorResp"
1367
- }
1368
- }
1369
- }
1370
- },
1371
- "500": {
1372
- "description": "Other errors",
1373
- "content": {
1374
- "application/json": {
1375
- "schema": {
1376
- "$ref": "#/components/schemas/ErrorResp"
1377
- }
1378
- }
1379
- }
1380
- }
1381
- }
1382
- }
1383
- }
1384
- },
1385
- "components": {
1386
- "securitySchemes": {
1387
- "BearerAuth": {
1388
- "type": "http",
1389
- "scheme": "bearer",
1390
- "bearerFormat": "JWT"
1391
- }
1392
- },
1393
- "parameters": {
1394
- "ExecutionIdParam": {
1395
- "in": "path",
1396
- "name": "execution_id",
1397
- "schema": {
1398
- "type": "string"
1399
- },
1400
- "required": true,
1401
- "description": "Id of the execution",
1402
- "example": "wd561"
1403
- },
1404
- "TaskIdParam": {
1405
- "in": "path",
1406
- "name": "task_id",
1407
- "schema": {
1408
- "type": "string"
1409
- },
1410
- "required": true,
1411
- "description": "Id of the task",
1412
- "example": "7hj28a"
1413
- },
1414
- "PhaseIdParam": {
1415
- "in": "path",
1416
- "name": "phase_id",
1417
- "schema": {
1418
- "type": "string"
1419
- },
1420
- "required": true,
1421
- "description": "Id of the phase",
1422
- "example": "9gjs2952j"
1423
- },
1424
- "ScheduleIdParam": {
1425
- "in": "path",
1426
- "name": "schedule_id",
1427
- "schema": {
1428
- "type": "string"
1429
- },
1430
- "required": true,
1431
- "description": "Id of the schedule",
1432
- "example": "sch_8k2m9n4p"
1433
- },
1434
- "SoftDeleteParam": {
1435
- "in": "query",
1436
- "name": "soft",
1437
- "schema": {
1438
- "type": "boolean",
1439
- "default": false
1440
- },
1441
- "required": false,
1442
- "description": "If true, the execution will NOT be deleted permanently, but rather kept for archive purpose.",
1443
- "example": true
1444
- }
1445
- },
1446
- "schemas": {
1447
- "WorkflowExecutionCreateReq": {
1448
- "type": "object",
1449
- "properties": {
1450
- "workflowId": {
1451
- "type": "string"
1452
- },
1453
- "trigger": {
1454
- "$ref": "#/components/schemas/TriggerType"
1455
- },
1456
- "assignedTo": {
1457
- "deprecated": true,
1458
- "type": "array",
1459
- "items": {
1460
- "type": "string"
1461
- }
1462
- },
1463
- "contexts": {
1464
- "type": "array",
1465
- "items": {
1466
- "$ref": "#/components/schemas/WorkflowContext"
1467
- }
1468
- },
1469
- "purposes": {
1470
- "type": "array",
1471
- "items": {
1472
- "type": "string"
1473
- },
1474
- "description": "An array of purposes to filter workflow phases."
1475
- }
1476
- },
1477
- "required": [
1478
- "workflowId"
1479
- ],
1480
- "example": {
1481
- "workflowId": "j3f23fh23uif98",
1482
- "trigger": "AUTOMATIC",
1483
- "contexts": [
1484
- {
1485
- "id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
1486
- "schema": "contact"
1487
- },
1488
- {
1489
- "id": "3a6d42fa-5070-4723-b90f-41ead4303e33",
1490
- "schema": "opportunity"
1491
- }
1492
- ]
1493
- }
1494
- },
1495
- "WorkflowExecutionUpdateReq": {
1496
- "type": "object",
1497
- "properties": {
1498
- "status": {
1499
- "$ref": "#/components/schemas/WorkflowStatus"
1500
- },
1501
- "assignedTo": {
1502
- "type": "array",
1503
- "items": {
1504
- "type": "string"
1505
- }
1506
- },
1507
- "selectedClosingReasons": {
1508
- "type": "array",
1509
- "items": {
1510
- "$ref": "#/components/schemas/ClosingReason"
1511
- }
1512
- },
1513
- "closingReasonDescription": {
1514
- "type": "string"
1515
- },
1516
- "dueDate": {
1517
- "type": "string"
1518
- },
1519
- "dynamicDueDate": {
1520
- "$ref": "#/components/schemas/DynamicDueDate"
1521
- },
1522
- "closedBy": {
1523
- "type": "string",
1524
- "description": "id of the user / partner user who is closing the workflow. For partner pass orgId_userId."
1525
- },
1526
- "contexts": {
1527
- "type": "array",
1528
- "items": {
1529
- "$ref": "#/components/schemas/WorkflowContext"
1530
- }
1531
- },
1532
- "completedTime": {
1533
- "type": "string",
1534
- "description": "Completed time of the workflow execution"
1535
- }
1536
- }
1537
- },
1538
- "ClosingReason": {
1539
- "type": "object",
1540
- "properties": {
1541
- "id": {
1542
- "type": "string"
1543
- },
1544
- "title": {
1545
- "type": "string"
1546
- }
1547
- },
1548
- "required": [
1549
- "id",
1550
- "title"
1551
- ]
1552
- },
1553
- "WorkflowContext": {
1554
- "type": "object",
1555
- "properties": {
1556
- "id": {
1557
- "type": "string"
1558
- },
1559
- "title": {
1560
- "type": "string"
1561
- },
1562
- "schema": {
1563
- "type": "string"
1564
- }
1565
- },
1566
- "required": [
1567
- "id",
1568
- "title",
1569
- "schema"
1570
- ]
1571
- },
1572
- "WorkflowExecutionBase": {
1573
- "type": "object",
1574
- "properties": {
1575
- "id": {
1576
- "type": "string"
1577
- },
1578
- "definitionId": {
1579
- "type": "string"
1580
- },
1581
- "orgId": {
1582
- "type": "string"
1583
- },
1584
- "name": {
1585
- "type": "string"
1586
- },
1587
- "creationTime": {
1588
- "type": "string",
1589
- "description": "Creation timestamp which will double as started time as well"
1590
- },
1591
- "lastUpdateTime": {
1592
- "type": "string",
1593
- "description": "Last Update timestamp"
1594
- },
1595
- "dueDate": {
1596
- "type": "string",
1597
- "description": "Due date for finishing the workflow"
1598
- },
1599
- "completedTime": {
1600
- "type": "string",
1601
- "description": "Completed time of the workflow execution"
1602
- },
1603
- "dynamicDueDate": {
1604
- "$ref": "#/components/schemas/DynamicDueDate"
1605
- },
1606
- "status": {
1607
- "$ref": "#/components/schemas/WorkflowStatus"
1608
- },
1609
- "trigger": {
1610
- "$ref": "#/components/schemas/TriggerType"
1611
- },
1612
- "assignedTo": {
1613
- "type": "array",
1614
- "items": {
1615
- "type": "string"
1616
- }
1617
- },
1618
- "lastModifiedBy": {
1619
- "type": "string",
1620
- "description": "Id of the user who closed workflow"
1621
- },
1622
- "contexts": {
1623
- "type": "array",
1624
- "items": {
1625
- "$ref": "#/components/schemas/WorkflowContext"
1626
- }
1627
- },
1628
- "nextOpenStep": {
1629
- "$ref": "#/components/schemas/StepId"
1630
- },
1631
- "configuredClosingReasonSnapshot": {
1632
- "type": "array",
1633
- "items": {
1634
- "$ref": "#/components/schemas/ClosingReason"
1635
- }
1636
- },
1637
- "selectedClosingReasons": {
1638
- "type": "array",
1639
- "items": {
1640
- "$ref": "#/components/schemas/ClosingReason"
1641
- }
1642
- },
1643
- "closingReasonDescription": {
1644
- "type": "string"
1645
- },
1646
- "enableECPWorkflow": {
1647
- "type": "boolean",
1648
- "description": "Indicates whether this workflow is available for End Customer Portal or not. By default it's not."
1649
- },
1650
- "updateEntityAttributes": {
1651
- "type": "array",
1652
- "items": {
1653
- "$ref": "#/components/schemas/UpdateEntityAttributes"
1654
- }
1655
- },
1656
- "version": {
1657
- "type": "integer",
1658
- "description": "Version of the workflow execution."
1659
- },
1660
- "taxonomies": {
1661
- "type": "array",
1662
- "items": {
1663
- "type": "string"
1664
- },
1665
- "description": "Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering"
1666
- },
1667
- "singleClosingReasonSelection": {
1668
- "type": "boolean",
1669
- "description": "Indicates whether only a single closing reason can be selected when closing the workflow execution"
1670
- }
1671
- }
1672
- },
1673
- "WorkflowExecutionSlim": {
1674
- "allOf": [
1675
- {
1676
- "$ref": "#/components/schemas/WorkflowExecutionBase"
1677
- },
1678
- {
1679
- "$ref": "#/components/schemas/FlowSlim"
1680
- }
1681
- ],
1682
- "example": {
1683
- "id": "8gja72h6kas6h",
1684
- "name": "Lead Qualification",
1685
- "trigger": "MANUAL",
1686
- "status": "STARTED",
1687
- "creationTime": "2021-04-27T12:01:13.000Z",
1688
- "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1689
- "dueDate": "2021-04-27T12:01:13.000Z",
1690
- "flow": [
1691
- {
1692
- "id": "sectionId1",
1693
- "definitionId": "section_definition_id_1",
1694
- "name": "Initial Information Gathering",
1695
- "type": "SECTION",
1696
- "steps": [
1697
- {
1698
- "id": "sada5641f3a21",
1699
- "definitionId": "step_definition_id_1",
1700
- "name": "Call client"
1701
- },
1702
- {
1703
- "id": "sada5641f3a22",
1704
- "definitionId": "step_definition_id_2",
1705
- "name": "Check product availability"
1706
- },
1707
- {
1708
- "id": "sada5641f3a23",
1709
- "definitionId": "step_definition_id_3",
1710
- "name": "Send email confirming contact with the client"
1711
- }
1712
- ]
1713
- },
1714
- {
1715
- "id": "firstLevelStepId1",
1716
- "definitionId": "step_definition_id_4",
1717
- "name": "Print and send catalog",
1718
- "type": "STEP"
1719
- }
1720
- ]
1721
- }
1722
- },
1723
- "FlowSlim": {
1724
- "type": "object",
1725
- "properties": {
1726
- "flow": {
1727
- "type": "array",
1728
- "items": {
1729
- "anyOf": [
1730
- {
1731
- "$ref": "#/components/schemas/Section"
1732
- },
1733
- {
1734
- "$ref": "#/components/schemas/Step"
1735
- }
1736
- ]
1737
- }
1738
- }
1739
- },
1740
- "required": [
1741
- "flow"
1742
- ]
1743
- },
1744
- "Flow": {
1745
- "type": "object",
1746
- "properties": {
1747
- "flow": {
1748
- "type": "array",
1749
- "items": {
1750
- "anyOf": [
1751
- {
1752
- "$ref": "#/components/schemas/Section"
1753
- },
1754
- {
1755
- "$ref": "#/components/schemas/Step"
1756
- }
1757
- ]
1758
- }
1759
- }
1760
- },
1761
- "required": [
1762
- "flow"
1763
- ]
1764
- },
1765
- "WorkflowExecution": {
1766
- "allOf": [
1767
- {
1768
- "$ref": "#/components/schemas/WorkflowExecutionBase"
1769
- },
1770
- {
1771
- "$ref": "#/components/schemas/Flow"
1772
- }
1773
- ],
1774
- "example": {
1775
- "id": "8gja72h6kas6h",
1776
- "name": "Lead Qualification",
1777
- "trigger": "MANUAL",
1778
- "status": "STARTED",
1779
- "creationTime": "2021-04-27T12:01:13.000Z",
1780
- "lastUpdateTime": "2021-04-27T12:01:13.000Z",
1781
- "dueDate": "2021-04-27T12:01:13.000Z",
1782
- "assignedTo": [
1783
- "252",
1784
- "29052"
1785
- ],
1786
- "flow": [
1787
- {
1788
- "id": "sectionId1",
1789
- "name": "Initial Information Gathering",
1790
- "steps": [
1791
- {
1792
- "id": "sada5641f3a21",
1793
- "name": "Call client and confirm address and product",
1794
- "definitionId": "step_definition_id_1",
1795
- "status": "ASSIGNED",
1796
- "assignedTo": [
1797
- "11"
1798
- ]
1799
- },
1800
- {
1801
- "id": "sada5641f3a22",
1802
- "name": "Check product availability",
1803
- "status": "UNASSIGNED",
1804
- "definitionId": "step_definition_id_2"
1805
- },
1806
- {
1807
- "id": "sada5641f3a23",
1808
- "name": "Send email confirming contact with the client",
1809
- "definitionId": "step_definition_id_3",
1810
- "status": "SKIPPED"
1811
- }
1812
- ]
1813
- },
1814
- {
1815
- "id": "firstLevelStepId1",
1816
- "definitionId": "step_definition_id_4",
1817
- "name": "Print and send catalog",
1818
- "status": "SKIPPED",
1819
- "dueDate": "2023-01-15T20:00:00"
1820
- }
1821
- ]
1822
- }
1823
- },
1824
- "WorkflowStatus": {
1825
- "type": "string",
1826
- "enum": [
1827
- "STARTED",
1828
- "DONE",
1829
- "CLOSED"
1830
- ]
1831
- },
1832
- "SectionSimplified": {
1833
- "type": "object",
1834
- "description": "A group of Steps that define the progress of the Workflow",
1835
- "properties": {
1836
- "id": {
1837
- "type": "string"
1838
- },
1839
- "definitionId": {
1840
- "type": "string"
1841
- },
1842
- "name": {
1843
- "type": "string",
1844
- "description": "Name for this Section",
1845
- "example": "Lead Qualification"
1846
- },
1847
- "type": {
1848
- "$ref": "#/components/schemas/ItemType"
1849
- },
1850
- "steps": {
1851
- "type": "array",
1852
- "items": {
1853
- "$ref": "#/components/schemas/StepSimplified"
1854
- }
1855
- },
1856
- "assignedTo": {
1857
- "type": "array",
1858
- "items": {
1859
- "type": "string"
1860
- }
1861
- }
1862
- },
1863
- "required": [
1864
- "id",
1865
- "name",
1866
- "type",
1867
- "steps"
1868
- ]
1869
- },
1870
- "Section": {
1871
- "type": "object",
1872
- "description": "A group of Steps that define the progress of the Workflow",
1873
- "properties": {
1874
- "id": {
1875
- "type": "string"
1876
- },
1877
- "definitionId": {
1878
- "type": "string"
1879
- },
1880
- "name": {
1881
- "type": "string",
1882
- "description": "Name for this Section",
1883
- "example": "Lead Qualification"
1884
- },
1885
- "userIds": {
1886
- "type": "array",
1887
- "items": {
1888
- "type": "number"
1889
- },
1890
- "deprecated": true,
1891
- "description": "This field is deprecated. Please use assignedTo"
1892
- },
1893
- "assignedTo": {
1894
- "type": "array",
1895
- "items": {
1896
- "type": "string"
1897
- }
1898
- },
1899
- "dueDate": {
1900
- "type": "string",
1901
- "example": "2021-04-27T12:00:00.000Z"
1902
- },
1903
- "dynamicDueDate": {
1904
- "$ref": "#/components/schemas/DynamicDueDate"
1905
- },
1906
- "startedTime": {
1907
- "type": "string"
1908
- },
1909
- "completedTime": {
1910
- "type": "string"
1911
- },
1912
- "status": {
1913
- "$ref": "#/components/schemas/SectionStatus"
1914
- },
1915
- "type": {
1916
- "$ref": "#/components/schemas/ItemType"
1917
- },
1918
- "steps": {
1919
- "type": "array",
1920
- "items": {
1921
- "$ref": "#/components/schemas/Step"
1922
- }
1923
- },
1924
- "taxonomies": {
1925
- "type": "array",
1926
- "items": {
1927
- "type": "string"
1928
- },
1929
- "description": "Taxonomy ids (purposes in this case) that are associated with this section and used for filtering"
1930
- }
1931
- },
1932
- "required": [
1933
- "id",
1934
- "name",
1935
- "type",
1936
- "steps"
1937
- ]
1938
- },
1939
- "StepId": {
1940
- "type": "object",
1941
- "properties": {
1942
- "id": {
1943
- "type": "string"
1944
- },
1945
- "entityRefId": {
1946
- "type": "string",
1947
- "deprecated": true,
1948
- "description": "This field is deprecated. It will be soon removed. Please use only id."
1949
- }
1950
- }
1951
- },
1952
- "StepSimplified": {
1953
- "type": "object",
1954
- "properties": {
1955
- "id": {
1956
- "type": "string"
1957
- },
1958
- "definitionId": {
1959
- "type": "string"
1960
- },
1961
- "entityRefId": {
1962
- "type": "string",
1963
- "deprecated": true,
1964
- "description": "This field is deprecated. It will be soon removed. Please use only id."
1965
- },
1966
- "name": {
1967
- "type": "string"
1968
- },
1969
- "description": {
1970
- "$ref": "#/components/schemas/StepDescription"
1971
- },
1972
- "type": {
1973
- "$ref": "#/components/schemas/ItemType"
1974
- },
1975
- "ecp": {
1976
- "$ref": "#/components/schemas/ECPDetails"
1977
- },
1978
- "installer": {
1979
- "$ref": "#/components/schemas/ECPDetails"
1980
- },
1981
- "enabled": {
1982
- "type": "boolean"
1983
- },
1984
- "requirements": {
1985
- "type": "array",
1986
- "items": {
1987
- "$ref": "#/components/schemas/StepRequirement"
1988
- }
1989
- },
1990
- "executionType": {
1991
- "description": "Manual / Automation step",
1992
- "$ref": "#/components/schemas/StepType"
1993
- }
1994
- },
1995
- "required": [
1996
- "id",
1997
- "name",
1998
- "type"
1999
- ]
2000
- },
2001
- "Step": {
2002
- "allOf": [
2003
- {
2004
- "$ref": "#/components/schemas/StepSimplified"
2005
- },
2006
- {
2007
- "type": "object",
2008
- "properties": {
2009
- "sectionId": {
2010
- "type": "string"
2011
- },
2012
- "executionId": {
2013
- "type": "string"
2014
- },
2015
- "userIds": {
2016
- "type": "array",
2017
- "items": {
2018
- "type": "number"
2019
- },
2020
- "deprecated": true,
2021
- "description": "This field is deprecated. Please use assignedTo"
2022
- },
2023
- "assignedTo": {
2024
- "type": "array",
2025
- "items": {
2026
- "type": "string"
2027
- }
2028
- },
2029
- "assignedToInProgress": {
2030
- "description": "The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task",
2031
- "type": "string"
2032
- },
2033
- "status": {
2034
- "$ref": "#/components/schemas/StepStatus"
2035
- },
2036
- "created": {
2037
- "type": "string"
2038
- },
2039
- "lastUpdated": {
2040
- "type": "string"
2041
- },
2042
- "statusLastUpdated": {
2043
- "type": "string",
2044
- "description": "Last updated timestamp of the status"
2045
- },
2046
- "startedTime": {
2047
- "type": "string"
2048
- },
2049
- "completedTime": {
2050
- "type": "string"
2051
- },
2052
- "dueDate": {
2053
- "type": "string"
2054
- },
2055
- "dynamicDueDate": {
2056
- "$ref": "#/components/schemas/DynamicDueDate"
2057
- },
2058
- "manuallyCreated": {
2059
- "type": "boolean"
2060
- },
2061
- "enabled": {
2062
- "type": "boolean",
2063
- "description": "enabled flag results from calculating the requirements"
2064
- },
2065
- "automationConfig": {
2066
- "description": "Configuration for automated steps",
2067
- "$ref": "#/components/schemas/AutomationConfig"
2068
- },
2069
- "journey": {
2070
- "$ref": "#/components/schemas/StepJourney"
2071
- },
2072
- "taxonomies": {
2073
- "type": "array",
2074
- "items": {
2075
- "type": "string"
2076
- },
2077
- "description": "Taxonomy ids (purposes in this case) that are associated with this step/task and used for filtering"
2078
- }
2079
- }
2080
- }
2081
- ]
2082
- },
2083
- "StepExtended": {
2084
- "allOf": [
2085
- {
2086
- "$ref": "#/components/schemas/Step"
2087
- },
2088
- {
2089
- "type": "object",
2090
- "properties": {
2091
- "executionId": {
2092
- "type": "string"
2093
- },
2094
- "executionName": {
2095
- "type": "string"
2096
- },
2097
- "executionStatus": {
2098
- "$ref": "#/components/schemas/WorkflowStatus"
2099
- },
2100
- "contexts": {
2101
- "type": "array",
2102
- "items": {
2103
- "allOf": [
2104
- {
2105
- "$ref": "#/components/schemas/WorkflowContext"
2106
- }
2107
- ]
2108
- }
2109
- }
2110
- },
2111
- "required": [
2112
- "executionId",
2113
- "executionName",
2114
- "executionStatus"
2115
- ]
2116
- }
2117
- ]
2118
- },
2119
- "StepStatus": {
2120
- "type": "string",
2121
- "enum": [
2122
- "UNASSIGNED",
2123
- "ASSIGNED",
2124
- "COMPLETED",
2125
- "SKIPPED",
2126
- "IN_PROGRESS",
2127
- "SCHEDULED",
2128
- "PENDING",
2129
- "CONDITION_PENDING",
2130
- "WAITING_FOR_CONFIRMATION",
2131
- "ON_HOLD",
2132
- "FAILED"
2133
- ],
2134
- "description": "**Note**: \"UNASSIGNED\" and \"ASSIGNED\" are deprecated and will be removed in a future version. Please use \"PENDING\" instead. Status values for workflow execution steps/tasks:\n- **UNASSIGNED**: Step has not been assigned to any user (deprecated - use PENDING instead)\n- **ASSIGNED**: Step has been assigned to one or more users (deprecated - use PENDING instead)\n- **PENDING**: Step/Task is waiting to be started by assigned users or is ready for execution\n- **IN_PROGRESS**: Step/Task is currently being worked on by a user\n- **COMPLETED**: Step/Task has been finished successfully\n- **SKIPPED**: Step/Task was intentionally bypassed and will not be executed\n- **SCHEDULED**: Task is scheduled to run at a specific time in the future\n- **CONDITION_PENDING**: Task is waiting for certain conditions to be met before it can proceed\n- **WAITING_FOR_CONFIRMATION**: Step/Task is paused and waiting for user confirmation via an external input (e.g., link in email) before proceeding.\n- **ON_HOLD**: Step/Task is temporarily paused and cannot proceed until manually resumed\n- **FAILED**: Task encountered an error and could not be completed. Mainly for automation tasks.\n"
2135
- },
2136
- "SectionStatus": {
2137
- "type": "string",
2138
- "enum": [
2139
- "OPEN",
2140
- "IN_PROGRESS",
2141
- "COMPLETED"
2142
- ]
2143
- },
2144
- "StepType": {
2145
- "type": "string",
2146
- "enum": [
2147
- "MANUAL",
2148
- "AUTOMATION"
2149
- ]
2150
- },
2151
- "StepJourney": {
2152
- "type": "object",
2153
- "properties": {
2154
- "id": {
2155
- "type": "string"
2156
- },
2157
- "journeyId": {
2158
- "type": "string"
2159
- },
2160
- "name": {
2161
- "type": "string"
2162
- },
2163
- "complete_task_automatically": {
2164
- "type": "boolean",
2165
- "description": "If true, the task be auto completed when the journey is completed"
2166
- }
2167
- }
2168
- },
2169
- "AutomationConfig": {
2170
- "type": "object",
2171
- "description": "Configuration for automation execution to run",
2172
- "properties": {
2173
- "flowId": {
2174
- "type": "string",
2175
- "description": "Id of the configured automation to run"
2176
- },
2177
- "executionId": {
2178
- "type": "string",
2179
- "description": "Id of the automation execution which ran"
2180
- },
2181
- "executionStatus": {
2182
- "type": "string",
2183
- "description": "Status of Automation Execution. Types can be found in Automation API"
2184
- }
2185
- },
2186
- "required": [
2187
- "flowId"
2188
- ]
2189
- },
2190
- "ECPDetails": {
2191
- "type": "object",
2192
- "description": "Details regarding ECP for the workflow step",
2193
- "properties": {
2194
- "enabled": {
2195
- "type": "boolean"
2196
- },
2197
- "label": {
2198
- "type": "string"
2199
- },
2200
- "description": {
2201
- "type": "string"
2202
- },
2203
- "journey": {
2204
- "$ref": "#/components/schemas/StepJourney"
2205
- }
2206
- }
2207
- },
2208
- "StepDescription": {
2209
- "type": "object",
2210
- "description": "Longer information regarding Task",
2211
- "properties": {
2212
- "enabled": {
2213
- "type": "boolean"
2214
- },
2215
- "value": {
2216
- "type": "string"
2217
- }
2218
- }
2219
- },
2220
- "ItemType": {
2221
- "type": "string",
2222
- "enum": [
2223
- "STEP",
2224
- "SECTION"
2225
- ]
2226
- },
2227
- "TriggerType": {
2228
- "type": "string",
2229
- "enum": [
2230
- "MANUAL",
2231
- "AUTOMATIC"
2232
- ]
2233
- },
2234
- "CreateStepReq": {
2235
- "type": "object",
2236
- "properties": {
2237
- "insertionIndex": {
2238
- "type": "number",
2239
- "default": 0
2240
- },
2241
- "name": {
2242
- "type": "string"
2243
- },
2244
- "description": {
2245
- "type": "object",
2246
- "properties": {
2247
- "enabled": {
2248
- "type": "boolean"
2249
- },
2250
- "value": {
2251
- "type": "string"
2252
- }
2253
- },
2254
- "required": [
2255
- "enabled",
2256
- "value"
2257
- ],
2258
- "description": "Longer information regarding Task"
2259
- },
2260
- "status": {
2261
- "$ref": "#/components/schemas/StepStatus"
2262
- },
2263
- "sectionId": {
2264
- "type": "string"
2265
- },
2266
- "executionType": {
2267
- "description": "Manual / Automation step",
2268
- "$ref": "#/components/schemas/StepType"
2269
- },
2270
- "automationConfig": {
2271
- "description": "Configuration for automated steps",
2272
- "$ref": "#/components/schemas/AutomationConfig"
2273
- }
2274
- },
2275
- "required": [
2276
- "name",
2277
- "insertionIndex"
2278
- ]
2279
- },
2280
- "UpdateStepReq": {
2281
- "type": "object",
2282
- "properties": {
2283
- "stepId": {
2284
- "type": "string"
2285
- },
2286
- "entityRefId": {
2287
- "type": "string",
2288
- "deprecated": true,
2289
- "description": "This field is deprecated. Please use stepId"
2290
- },
2291
- "userIds": {
2292
- "type": "array",
2293
- "items": {
2294
- "type": "number"
2295
- },
2296
- "deprecated": true,
2297
- "description": "This field is deprecated. Please use assignedTo"
2298
- },
2299
- "assignedTo": {
2300
- "type": "array",
2301
- "items": {
2302
- "type": "string"
2303
- }
2304
- },
2305
- "assignedToInProgress": {
2306
- "description": "The user which moved the step/task to the IN_PROGRESS state. The user should also be present in the assignedTo property of the step/task",
2307
- "type": "string"
2308
- },
2309
- "status": {
2310
- "$ref": "#/components/schemas/StepStatus"
2311
- },
2312
- "dueDate": {
2313
- "type": "string"
2314
- },
2315
- "dynamicDueDate": {
2316
- "$ref": "#/components/schemas/DynamicDueDate"
2317
- },
2318
- "name": {
2319
- "type": "string"
2320
- },
2321
- "description": {
2322
- "type": "object",
2323
- "properties": {
2324
- "enabled": {
2325
- "type": "boolean"
2326
- },
2327
- "value": {
2328
- "type": "string"
2329
- }
2330
- },
2331
- "required": [
2332
- "enabled",
2333
- "value"
2334
- ],
2335
- "description": "Longer information regarding Task"
2336
- },
2337
- "position": {
2338
- "$ref": "#/components/schemas/StepPositionAt"
2339
- },
2340
- "automationConfig": {
2341
- "$ref": "#/components/schemas/AutomationConfig"
2342
- },
2343
- "startedTime": {
2344
- "type": "string"
2345
- },
2346
- "completedTime": {
2347
- "type": "string"
2348
- }
2349
- }
2350
- },
2351
- "StepPositionAt": {
2352
- "type": "object",
2353
- "properties": {
2354
- "index": {
2355
- "type": "number",
2356
- "default": 0
2357
- },
2358
- "sectionId": {
2359
- "type": "string"
2360
- }
2361
- },
2362
- "required": [
2363
- "index"
2364
- ]
2365
- },
2366
- "UpdateStepResp": {
2367
- "allOf": [
2368
- {
2369
- "$ref": "#/components/schemas/Step"
2370
- }
2371
- ]
2372
- },
2373
- "SearchStepsResp": {
2374
- "type": "object",
2375
- "properties": {
2376
- "hits": {
2377
- "type": "number",
2378
- "example": 50
2379
- },
2380
- "results": {
2381
- "type": "array",
2382
- "items": {
2383
- "allOf": [
2384
- {
2385
- "$ref": "#/components/schemas/StepExtended"
2386
- }
2387
- ]
2388
- }
2389
- }
2390
- }
2391
- },
2392
- "SearchExecutionsReq": {
2393
- "type": "object",
2394
- "properties": {
2395
- "name": {
2396
- "type": "string"
2397
- },
2398
- "status": {
2399
- "$ref": "#/components/schemas/WorkflowStatus"
2400
- },
2401
- "includeDoneWorkflows": {
2402
- "type": "boolean"
2403
- },
2404
- "assignedTo": {
2405
- "type": "string"
2406
- },
2407
- "sorting": {
2408
- "$ref": "#/components/schemas/SearchSorting"
2409
- },
2410
- "pagination": {
2411
- "$ref": "#/components/schemas/ExecutionPaginationDynamo"
2412
- }
2413
- }
2414
- },
2415
- "SearchExecutionsResp": {
2416
- "type": "object",
2417
- "properties": {
2418
- "executions": {
2419
- "type": "array",
2420
- "items": {
2421
- "$ref": "#/components/schemas/WorkflowExecutionSlim"
2422
- }
2423
- },
2424
- "lastEvaluatedKey": {
2425
- "$ref": "#/components/schemas/LastEvaluatedKey"
2426
- }
2427
- },
2428
- "required": [
2429
- "executions"
2430
- ]
2431
- },
2432
- "LastEvaluatedKey": {
2433
- "type": "object",
2434
- "properties": {
2435
- "orgId": {
2436
- "type": "string"
2437
- },
2438
- "creationTime": {
2439
- "type": "string"
2440
- }
2441
- }
2442
- },
2443
- "SearchStepsReq": {
2444
- "type": "object",
2445
- "properties": {
2446
- "executionName": {
2447
- "type": "string"
2448
- },
2449
- "stepName": {
2450
- "type": "string"
2451
- },
2452
- "assignedTo": {
2453
- "type": "number"
2454
- },
2455
- "includeDoneWorkflows": {
2456
- "type": "boolean"
2457
- },
2458
- "manuallyCreated": {
2459
- "type": "boolean"
2460
- },
2461
- "status": {
2462
- "type": "string",
2463
- "enum": [
2464
- "OPEN",
2465
- "COMPLETE",
2466
- "NEXT_OPEN_ITEM_IN_WORKFLOW"
2467
- ]
2468
- },
2469
- "sorting": {
2470
- "$ref": "#/components/schemas/SearchSorting"
2471
- },
2472
- "pagination": {
2473
- "$ref": "#/components/schemas/SearchPagination"
2474
- }
2475
- }
2476
- },
2477
- "SearchSorting": {
2478
- "type": "string",
2479
- "enum": [
2480
- "A_Z",
2481
- "Z_A",
2482
- "DUE_DATE_ASC",
2483
- "DUE_DATE_DESC",
2484
- "TRIGGER_DATE_ASC",
2485
- "TRIGGER_DATE_DESC"
2486
- ]
2487
- },
2488
- "SearchPagination": {
2489
- "type": "object",
2490
- "properties": {
2491
- "from": {
2492
- "type": "number"
2493
- },
2494
- "size": {
2495
- "type": "number"
2496
- }
2497
- }
2498
- },
2499
- "ExecutionPaginationDynamo": {
2500
- "type": "object",
2501
- "properties": {
2502
- "orgId": {
2503
- "type": "string"
2504
- },
2505
- "creationTime": {
2506
- "type": "string"
2507
- }
2508
- }
2509
- },
2510
- "ErrorResp": {
2511
- "type": "object",
2512
- "properties": {
2513
- "message": {
2514
- "type": "string"
2515
- }
2516
- }
2517
- },
2518
- "ClosingReasonResp": {
2519
- "type": "object",
2520
- "properties": {
2521
- "reasons": {
2522
- "type": "array",
2523
- "items": {
2524
- "$ref": "#/components/schemas/ClosingReason"
2525
- }
2526
- }
2527
- }
2528
- },
2529
- "PhaseInEntity": {
2530
- "type": "object",
2531
- "properties": {
2532
- "phase_id": {
2533
- "type": "string"
2534
- },
2535
- "phase_name": {
2536
- "type": "string"
2537
- },
2538
- "phase_progress": {
2539
- "type": "number"
2540
- },
2541
- "phase_assignees": {
2542
- "type": "array",
2543
- "items": {
2544
- "type": "string"
2545
- }
2546
- }
2547
- }
2548
- },
2549
- "WorkflowInEntity": {
2550
- "type": "object",
2551
- "properties": {
2552
- "id": {
2553
- "type": "string"
2554
- },
2555
- "definition_id": {
2556
- "type": "string"
2557
- },
2558
- "name": {
2559
- "type": "string"
2560
- },
2561
- "status": {
2562
- "$ref": "#/components/schemas/WorkflowStatus"
2563
- },
2564
- "assignees": {
2565
- "type": "array",
2566
- "items": {
2567
- "type": "string"
2568
- }
2569
- },
2570
- "duedate": {
2571
- "type": "string",
2572
- "format": "date-time"
2573
- },
2574
- "last_update_time": {
2575
- "type": "string",
2576
- "format": "date-time"
2577
- },
2578
- "progress": {
2579
- "type": "number"
2580
- },
2581
- "upcoming_tasks_assignees": {
2582
- "type": "array",
2583
- "items": {
2584
- "type": "string"
2585
- }
2586
- },
2587
- "task_id": {
2588
- "type": "string"
2589
- },
2590
- "task_name": {
2591
- "type": "string"
2592
- },
2593
- "task_assignees": {
2594
- "type": "array",
2595
- "items": {
2596
- "type": "string"
2597
- }
2598
- },
2599
- "task_duedate": {
2600
- "type": "string",
2601
- "format": "date-time"
2602
- },
2603
- "task_execution_type": {
2604
- "$ref": "#/components/schemas/StepType"
2605
- },
2606
- "task_status": {
2607
- "$ref": "#/components/schemas/StepStatus"
2608
- },
2609
- "phase_id": {
2610
- "type": "string"
2611
- },
2612
- "phase_name": {
2613
- "type": "string"
2614
- },
2615
- "phase_assignees": {
2616
- "type": "array",
2617
- "items": {
2618
- "type": "string"
2619
- }
2620
- },
2621
- "phase_progress": {
2622
- "type": "number"
2623
- },
2624
- "phases_in_progress": {
2625
- "type": "array",
2626
- "items": {
2627
- "$ref": "#/components/schemas/PhaseInEntity"
2628
- }
2629
- },
2630
- "selected_closing_reasons": {
2631
- "type": "array",
2632
- "items": {
2633
- "$ref": "#/components/schemas/ClosingReason"
2634
- }
2635
- },
2636
- "closing_reason_description": {
2637
- "type": "string"
2638
- }
2639
- }
2640
- },
2641
- "UpdateEntityAttributes": {
2642
- "type": "object",
2643
- "properties": {
2644
- "source": {
2645
- "type": "string",
2646
- "enum": [
2647
- "workflow_status",
2648
- "current_section",
2649
- "current_step"
2650
- ]
2651
- },
2652
- "target": {
2653
- "type": "object",
2654
- "properties": {
2655
- "entitySchema": {
2656
- "type": "string",
2657
- "example": "opportunity"
2658
- },
2659
- "entityAttribute": {
2660
- "type": "string",
2661
- "example": "my_status"
2662
- }
2663
- },
2664
- "required": [
2665
- "entitySchema",
2666
- "entityAttribute"
2667
- ]
2668
- }
2669
- },
2670
- "required": [
2671
- "source",
2672
- "target"
2673
- ]
2674
- },
2675
- "EntitySync": {
2676
- "type": "object",
2677
- "properties": {
2678
- "trigger": {
2679
- "type": "object",
2680
- "description": "Trigger configuration that determines when entity sync occurs.\nContains the event type and optional filter to target specific tasks/phases.\n",
2681
- "required": [
2682
- "event"
2683
- ],
2684
- "properties": {
2685
- "event": {
2686
- "type": "string",
2687
- "description": "Event or condition that triggers the entity sync.\nDirect triggers match EventBridge event names (PascalCase).\nStatus triggers are deduced from event + entity status combination.\n",
2688
- "enum": [
2689
- "FlowStarted",
2690
- "FlowCompleted",
2691
- "FlowCancelled",
2692
- "FlowReopened",
2693
- "FlowDeleted",
2694
- "FlowAssigned",
2695
- "FlowDueDateChanged",
2696
- "FlowContextsChanged",
2697
- "TaskUpdated",
2698
- "CurrTaskChanged",
2699
- "TaskCompleted",
2700
- "TaskSkipped",
2701
- "TaskMarkedInProgress",
2702
- "TaskMarkedOnHold",
2703
- "PhaseUpdated",
2704
- "PhaseCompleted",
2705
- "PhaseSkipped",
2706
- "PhaseMarkedInProgress"
2707
- ]
2708
- },
2709
- "filter": {
2710
- "type": "object",
2711
- "description": "Optional filter to target specific tasks or phases.\nSpecify either task_template_id OR phase_template_id (mutually exclusive).\nIf omitted, trigger applies to all tasks/phases.\n",
2712
- "properties": {
2713
- "task_template_id": {
2714
- "type": "string",
2715
- "description": "Target a specific task by its template ID (stable across executions)"
2716
- },
2717
- "phase_template_id": {
2718
- "type": "string",
2719
- "description": "Target a specific phase by its template ID (stable across executions)"
2720
- }
2721
- }
2722
- }
2723
- }
2724
- },
2725
- "value": {
2726
- "type": "object",
2727
- "properties": {
2728
- "source": {
2729
- "type": "string",
2730
- "enum": [
2731
- "workflow_name",
2732
- "workflow_status",
2733
- "workflow_assigned_to",
2734
- "task_name",
2735
- "task_status",
2736
- "task_assigned_to",
2737
- "phase_name",
2738
- "phase_status",
2739
- "phase_assigned_to",
2740
- "custom_value"
2741
- ]
2742
- },
2743
- "value": {
2744
- "type": "string"
2745
- }
2746
- },
2747
- "required": [
2748
- "source"
2749
- ]
2750
- },
2751
- "target": {
2752
- "type": "object",
2753
- "properties": {
2754
- "entitySchema": {
2755
- "type": "string",
2756
- "example": "opportunity"
2757
- },
2758
- "entityAttribute": {
2759
- "type": "string",
2760
- "example": "title"
2761
- }
2762
- },
2763
- "required": [
2764
- "entitySchema",
2765
- "entityAttribute"
2766
- ]
2767
- }
2768
- },
2769
- "example": {
2770
- "trigger": {
2771
- "event": "FlowStarted"
2772
- },
2773
- "target": {
2774
- "entitySchema": "opportunity",
2775
- "entityAttribute": "title"
2776
- },
2777
- "value": {
2778
- "source": "workflow_name"
2779
- }
2780
- },
2781
- "required": [
2782
- "trigger",
2783
- "target",
2784
- "value"
2785
- ]
2786
- },
2787
- "DynamicDueDate": {
2788
- "description": "set a Duedate for a step then a specific",
2789
- "type": "object",
2790
- "properties": {
2791
- "numberOfUnits": {
2792
- "type": "number"
2793
- },
2794
- "timePeriod": {
2795
- "type": "string",
2796
- "enum": [
2797
- "minutes",
2798
- "hours",
2799
- "days",
2800
- "weeks",
2801
- "months"
2802
- ]
2803
- },
2804
- "actionTypeCondition": {
2805
- "type": "string",
2806
- "enum": [
2807
- "WORKFLOW_STARTED",
2808
- "STEP_CLOSED",
2809
- "PHASE_FINISHED"
2810
- ]
2811
- },
2812
- "stepId": {
2813
- "type": "string"
2814
- },
2815
- "phaseId": {
2816
- "type": "string"
2817
- }
2818
- },
2819
- "required": [
2820
- "numberOfUnits",
2821
- "timePeriod",
2822
- "actionType"
2823
- ]
2824
- },
2825
- "StepRequirement": {
2826
- "description": "describe the requirement for step enablement",
2827
- "type": "object",
2828
- "properties": {
2829
- "definitionId": {
2830
- "type": "string"
2831
- },
2832
- "type": {
2833
- "$ref": "#/components/schemas/ItemType"
2834
- },
2835
- "condition": {
2836
- "type": "string",
2837
- "enum": [
2838
- "CLOSED"
2839
- ]
2840
- }
2841
- },
2842
- "required": [
2843
- "definitionId",
2844
- "type",
2845
- "condition"
2846
- ]
2847
- },
2848
- "StartFlowReq": {
2849
- "type": "object",
2850
- "required": [
2851
- "flow_template_id",
2852
- "contexts"
2853
- ],
2854
- "properties": {
2855
- "flow_template_id": {
2856
- "type": "string"
2857
- },
2858
- "trigger": {
2859
- "$ref": "#/components/schemas/FlowTrigger"
2860
- },
2861
- "contexts": {
2862
- "type": "array",
2863
- "items": {
2864
- "$ref": "#/components/schemas/FlowContext"
2865
- }
2866
- },
2867
- "purposes": {
2868
- "type": "array",
2869
- "items": {
2870
- "type": "string"
2871
- },
2872
- "description": "An array of purposes to filter workflow phases."
2873
- }
2874
- }
2875
- },
2876
- "SearchFlowsReq": {
2877
- "type": "object",
2878
- "properties": {
2879
- "entity_id": {
2880
- "type": "string"
2881
- },
2882
- "entity_schema": {
2883
- "type": "string"
2884
- }
2885
- },
2886
- "required": [
2887
- "entity_id",
2888
- "entity_schema"
2889
- ]
2890
- },
2891
- "PatchFlowReq": {
2892
- "type": "object",
2893
- "properties": {
2894
- "status": {
2895
- "$ref": "#/components/schemas/WorkflowStatus"
2896
- },
2897
- "assigned_to": {
2898
- "$ref": "#/components/schemas/Assignees"
2899
- },
2900
- "closing_reason": {
2901
- "$ref": "#/components/schemas/FlowClosingReason"
2902
- },
2903
- "due_date": {
2904
- "type": "string"
2905
- },
2906
- "due_date_config": {
2907
- "$ref": "#/components/schemas/DueDateConfig"
2908
- },
2909
- "contexts": {
2910
- "type": "array",
2911
- "items": {
2912
- "$ref": "#/components/schemas/FlowContext"
2913
- }
2914
- }
2915
- }
2916
- },
2917
- "FlowExecution": {
2918
- "type": "object",
2919
- "required": [
2920
- "id",
2921
- "flow_template_id",
2922
- "org_id",
2923
- "name",
2924
- "created_at",
2925
- "updated_at",
2926
- "analytics",
2927
- "status",
2928
- "trigger",
2929
- "contexts",
2930
- "crt_tasks",
2931
- "tasks",
2932
- "edges"
2933
- ],
2934
- "properties": {
2935
- "id": {
2936
- "$ref": "#/components/schemas/FlowExecutionId"
2937
- },
2938
- "flow_template_id": {
2939
- "$ref": "#/components/schemas/FlowTemplateId"
2940
- },
2941
- "org_id": {
2942
- "type": "string"
2943
- },
2944
- "name": {
2945
- "type": "string"
2946
- },
2947
- "created_at": {
2948
- "type": "string",
2949
- "description": "Creation timestamp which will double as started time as well"
2950
- },
2951
- "updated_at": {
2952
- "type": "string",
2953
- "description": "Last Update timestamp"
2954
- },
2955
- "due_date": {
2956
- "type": "string",
2957
- "description": "Due date for finishing the workflow"
2958
- },
2959
- "due_date_config": {
2960
- "$ref": "#/components/schemas/DueDateConfig"
2961
- },
2962
- "status": {
2963
- "$ref": "#/components/schemas/WorkflowStatus"
2964
- },
2965
- "assigned_to": {
2966
- "$ref": "#/components/schemas/Assignees"
2967
- },
2968
- "analytics": {
2969
- "type": "object",
2970
- "properties": {
2971
- "started_at": {
2972
- "type": "string",
2973
- "description": "Timestamp when the flow execution started"
2974
- },
2975
- "completed_at": {
2976
- "type": "string",
2977
- "description": "Timestamp when the flow execution was completed"
2978
- },
2979
- "closed_at": {
2980
- "type": "string",
2981
- "description": "Timestamp when the flow execution was closed"
2982
- },
2983
- "started_by": {
2984
- "type": "string",
2985
- "description": "User who started the flow execution."
2986
- },
2987
- "closed_by": {
2988
- "type": "string",
2989
- "description": "User who closed the flow execution"
2990
- }
2991
- }
2992
- },
2993
- "contexts": {
2994
- "type": "array",
2995
- "items": {
2996
- "$ref": "#/components/schemas/FlowContext"
2997
- }
2998
- },
2999
- "crt_tasks": {
3000
- "type": "array",
3001
- "items": {
3002
- "type": "object",
3003
- "properties": {
3004
- "id": {
3005
- "$ref": "#/components/schemas/TaskId"
3006
- }
3007
- }
3008
- }
3009
- },
3010
- "phases": {
3011
- "type": "array",
3012
- "items": {
3013
- "$ref": "#/components/schemas/Phase"
3014
- }
3015
- },
3016
- "tasks": {
3017
- "type": "array",
3018
- "items": {
3019
- "$ref": "#/components/schemas/Task"
3020
- }
3021
- },
3022
- "edges": {
3023
- "type": "array",
3024
- "items": {
3025
- "$ref": "#/components/schemas/Edge"
3026
- }
3027
- },
3028
- "_execution_chain": {
3029
- "type": "object",
3030
- "description": "[Internal] Tracks the chain of automation-originated executions to prevent infinite loops. This is an internal property and should not be used by external consumers.",
3031
- "properties": {
3032
- "parent_execution_id": {
3033
- "type": "string",
3034
- "description": "ID of the parent flow execution that triggered this execution via automation"
3035
- },
3036
- "parent_task_id": {
3037
- "type": "string",
3038
- "description": "ID of the automation task in the parent execution that triggered this"
3039
- },
3040
- "depth": {
3041
- "type": "integer",
3042
- "description": "The depth in the execution chain (0 for manual triggers, 1+ for automation-triggered)",
3043
- "default": 0,
3044
- "minimum": 0,
3045
- "maximum": 10
3046
- }
3047
- }
3048
- },
3049
- "closing_reason": {
3050
- "$ref": "#/components/schemas/FlowClosingReason"
3051
- },
3052
- "available_in_ecp": {
3053
- "type": "boolean",
3054
- "description": "Indicates whether this flow execution is available for End Customer Portal or not. By default it's not."
3055
- },
3056
- "entity_sync": {
3057
- "type": "array",
3058
- "items": {
3059
- "$ref": "#/components/schemas/EntitySync"
3060
- }
3061
- },
3062
- "taxonomies": {
3063
- "type": "array",
3064
- "items": {
3065
- "type": "string"
3066
- },
3067
- "description": "Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering"
3068
- },
3069
- "trigger": {
3070
- "$ref": "#/components/schemas/FlowTrigger"
3071
- },
3072
- "singleClosingReasonSelection": {
3073
- "type": "boolean",
3074
- "description": "Indicates whether only a single closing reason can be selected when closing the flow execution"
3075
- }
3076
- }
3077
- },
3078
- "FlowClosingReason": {
3079
- "type": "object",
3080
- "properties": {
3081
- "selected_reasons": {
3082
- "type": "array",
3083
- "items": {
3084
- "$ref": "#/components/schemas/ClosingReason"
3085
- }
3086
- },
3087
- "configured_reasons": {
3088
- "type": "array",
3089
- "items": {
3090
- "$ref": "#/components/schemas/ClosingReason"
3091
- }
3092
- },
3093
- "extra_description": {
3094
- "type": "string"
3095
- }
3096
- }
3097
- },
3098
- "FlowTrigger": {
3099
- "type": "object",
3100
- "properties": {
3101
- "type": {
3102
- "$ref": "#/components/schemas/TriggerType"
3103
- },
3104
- "automation_config": {
3105
- "$ref": "#/components/schemas/AutomationInfo"
3106
- }
3107
- }
3108
- },
3109
- "FlowContext": {
3110
- "anyOf": [
3111
- {
3112
- "$ref": "#/components/schemas/EntityRef"
3113
- }
3114
- ]
3115
- },
3116
- "EntityRef": {
3117
- "type": "object",
3118
- "properties": {
3119
- "entity_id": {
3120
- "type": "string"
3121
- },
3122
- "entity_schema": {
3123
- "type": "string"
3124
- },
3125
- "is_primary": {
3126
- "type": "boolean",
3127
- "description": "Flag to indicate if the entity is primary and should be used for evaluating the conditions of the tasks",
3128
- "default": false
3129
- }
3130
- }
3131
- },
3132
- "PhaseId": {
3133
- "type": "string"
3134
- },
3135
- "TaskId": {
3136
- "type": "string"
3137
- },
3138
- "Task": {
3139
- "oneOf": [
3140
- {
3141
- "$ref": "#/components/schemas/ManualTask"
3142
- },
3143
- {
3144
- "$ref": "#/components/schemas/AutomationTask"
3145
- },
3146
- {
3147
- "$ref": "#/components/schemas/DecisionTask"
3148
- },
3149
- {
3150
- "$ref": "#/components/schemas/AiAgentTask"
3151
- }
3152
- ]
3153
- },
3154
- "TaskType": {
3155
- "type": "string",
3156
- "enum": [
3157
- "MANUAL",
3158
- "AUTOMATION",
3159
- "DECISION",
3160
- "AI_AGENT"
3161
- ]
3162
- },
3163
- "ManualTask": {
3164
- "allOf": [
3165
- {
3166
- "$ref": "#/components/schemas/TaskBase"
3167
- },
3168
- {
3169
- "type": "object",
3170
- "properties": {
3171
- "loop_config": {
3172
- "$ref": "#/components/schemas/LoopInfo"
3173
- }
3174
- }
3175
- }
3176
- ]
3177
- },
3178
- "AutomationTask": {
3179
- "allOf": [
3180
- {
3181
- "$ref": "#/components/schemas/TaskBase"
3182
- },
3183
- {
3184
- "type": "object",
3185
- "required": [
3186
- "automation_config"
3187
- ],
3188
- "properties": {
3189
- "automation_config": {
3190
- "$ref": "#/components/schemas/AutomationInfo"
3191
- },
3192
- "automation_execution_id": {
3193
- "type": "string",
3194
- "description": "ID of the automation execution, used for tracking status updates."
3195
- },
3196
- "trigger_mode": {
3197
- "$ref": "#/components/schemas/TriggerMode"
3198
- },
3199
- "schedule": {
3200
- "$ref": "#/components/schemas/ActionSchedule"
3201
- },
3202
- "loop_config": {
3203
- "$ref": "#/components/schemas/LoopInfo"
3204
- }
3205
- }
3206
- }
3207
- ]
3208
- },
3209
- "LoopInfo": {
3210
- "type": "object",
3211
- "description": "Information about loop iterations, when task is part of a loop branch",
3212
- "properties": {
3213
- "max_iterations": {
3214
- "type": "integer",
3215
- "description": "Maximum number of iterations for the loop branch",
3216
- "default": 3,
3217
- "minimum": 1,
3218
- "maximum": 10
3219
- },
3220
- "crt_iterations": {
3221
- "type": "integer",
3222
- "description": "Current number of iterations for the loop branch",
3223
- "default": 0
3224
- }
3225
- },
3226
- "required": [
3227
- "max_iterations"
3228
- ]
3229
- },
3230
- "LoopConfig": {
3231
- "type": "object",
3232
- "properties": {
3233
- "loop_branch_id": {
3234
- "type": "string",
3235
- "description": "The id of the branch that will be looped"
3236
- },
3237
- "exit_branch_id": {
3238
- "type": "string",
3239
- "description": "The id of the branch that will be used to exit the loop"
3240
- },
3241
- "max_iterations": {
3242
- "type": "integer",
3243
- "description": "Maximum number of iterations for the loop branch",
3244
- "default": 3,
3245
- "minimum": 1,
3246
- "maximum": 10
3247
- },
3248
- "crt_iterations": {
3249
- "type": "integer",
3250
- "description": "Current number of iterations for the loop branch",
3251
- "default": 0
3252
- }
3253
- },
3254
- "required": [
3255
- "loop_branch_id",
3256
- "exit_branch_id",
3257
- "max_iterations"
3258
- ]
3259
- },
3260
- "TriggerMode": {
3261
- "type": "string",
3262
- "enum": [
3263
- "manual",
3264
- "automatic"
3265
- ]
3266
- },
3267
- "ActionSchedule": {
3268
- "anyOf": [
3269
- {
3270
- "$ref": "#/components/schemas/ImmediateSchedule"
3271
- },
3272
- {
3273
- "$ref": "#/components/schemas/DelayedSchedule"
3274
- },
3275
- {
3276
- "$ref": "#/components/schemas/RelativeSchedule"
3277
- }
3278
- ]
3279
- },
3280
- "ImmediateSchedule": {
3281
- "type": "object",
3282
- "properties": {
3283
- "mode": {
3284
- "enum": [
3285
- "immediate"
3286
- ]
3287
- }
3288
- },
3289
- "required": [
3290
- "mode"
3291
- ]
3292
- },
3293
- "DelayedSchedule": {
3294
- "type": "object",
3295
- "required": [
3296
- "mode",
3297
- "duration",
3298
- "unit"
3299
- ],
3300
- "properties": {
3301
- "mode": {
3302
- "enum": [
3303
- "delayed"
3304
- ]
3305
- },
3306
- "duration": {
3307
- "type": "number"
3308
- },
3309
- "unit": {
3310
- "$ref": "#/components/schemas/TimeUnit"
3311
- },
3312
- "schedule_id": {
3313
- "type": "string",
3314
- "description": "The id of the created schedule"
3315
- }
3316
- }
3317
- },
3318
- "RelativeSchedule": {
3319
- "type": "object",
3320
- "properties": {
3321
- "mode": {
3322
- "enum": [
3323
- "relative"
3324
- ]
3325
- },
3326
- "direction": {
3327
- "type": "string",
3328
- "enum": [
3329
- "before",
3330
- "after"
3331
- ]
3332
- },
3333
- "duration": {
3334
- "type": "number"
3335
- },
3336
- "unit": {
3337
- "$ref": "#/components/schemas/TimeUnit"
3338
- },
3339
- "reference": {
3340
- "type": "object",
3341
- "required": [
3342
- "id",
3343
- "origin"
3344
- ],
3345
- "properties": {
3346
- "id": {
3347
- "type": "string",
3348
- "description": "The id of the entity / workflow / task, based on the origin of the schedule. For all_preceding_tasks_completed, use the sentinel value 'all_preceding_tasks_completed'."
3349
- },
3350
- "origin": {
3351
- "type": "string",
3352
- "enum": [
3353
- "flow_started",
3354
- "task_completed",
3355
- "trigger_entity_attribute",
3356
- "all_preceding_tasks_completed"
3357
- ]
3358
- },
3359
- "schema": {
3360
- "type": "string",
3361
- "description": "The schema of the entity"
3362
- },
3363
- "attribute": {
3364
- "type": "string",
3365
- "description": "An entity attribute that identifies a date / datetime"
3366
- }
3367
- }
3368
- },
3369
- "schedule_id": {
3370
- "type": "string",
3371
- "description": "The id of the created schedule"
3372
- }
3373
- },
3374
- "required": [
3375
- "mode",
3376
- "direction",
3377
- "duration",
3378
- "unit",
3379
- "reference"
3380
- ]
3381
- },
3382
- "DecisionTask": {
3383
- "allOf": [
3384
- {
3385
- "$ref": "#/components/schemas/TaskBase"
3386
- },
3387
- {
3388
- "type": "object",
3389
- "properties": {
3390
- "trigger_mode": {
3391
- "$ref": "#/components/schemas/TriggerMode"
3392
- },
3393
- "conditions": {
3394
- "type": "array",
3395
- "items": {
3396
- "$ref": "#/components/schemas/Condition"
3397
- }
3398
- },
3399
- "schedule": {
3400
- "anyOf": [
3401
- {
3402
- "$ref": "#/components/schemas/DelayedSchedule"
3403
- },
3404
- {
3405
- "$ref": "#/components/schemas/RelativeSchedule"
3406
- }
3407
- ]
3408
- },
3409
- "loop_config": {
3410
- "$ref": "#/components/schemas/LoopConfig"
3411
- }
3412
- },
3413
- "required": [
3414
- "trigger_mode",
3415
- "conditions"
3416
- ]
3417
- }
3418
- ]
3419
- },
3420
- "AiAgentTask": {
3421
- "allOf": [
3422
- {
3423
- "$ref": "#/components/schemas/TaskBase"
3424
- },
3425
- {
3426
- "type": "object",
3427
- "properties": {
3428
- "agent_config": {
3429
- "$ref": "#/components/schemas/AgentConfig"
3430
- },
3431
- "loop_config": {
3432
- "$ref": "#/components/schemas/LoopInfo"
3433
- },
3434
- "agent_execution": {
3435
- "$ref": "#/components/schemas/AgentExecutionInfo"
3436
- },
3437
- "agent_execution_id": {
3438
- "type": "string",
3439
- "description": "ID of the agent execution, used for tracking status updates. This is needed as a separate field to allow indexing."
3440
- }
3441
- }
3442
- }
3443
- ]
3444
- },
3445
- "AgentConfig": {
3446
- "type": "object",
3447
- "description": "Configuration for AI Agent to run",
3448
- "required": [
3449
- "agent_id"
3450
- ],
3451
- "properties": {
3452
- "agent_id": {
3453
- "type": "string",
3454
- "description": "Id of the configured AI Agent to run"
3455
- },
3456
- "parameters": {
3457
- "type": "object",
3458
- "description": "Parameters to customize the AI Agent behavior"
3459
- }
3460
- },
3461
- "additionalProperties": true
3462
- },
3463
- "AgentExecutionInfo": {
3464
- "type": "object",
3465
- "properties": {
3466
- "execution_id": {
3467
- "type": "string",
3468
- "description": "Id of the agent execution started by this task"
3469
- },
3470
- "execution_status": {
3471
- "type": "string",
3472
- "description": "Status of the agent execution, when it already ran"
3473
- },
3474
- "error_reason": {
3475
- "type": "string"
3476
- }
3477
- }
3478
- },
3479
- "TaskBase": {
3480
- "type": "object",
3481
- "properties": {
3482
- "id": {
3483
- "$ref": "#/components/schemas/TaskId"
3484
- },
3485
- "template_id": {
3486
- "type": "string"
3487
- },
3488
- "name": {
3489
- "type": "string"
3490
- },
3491
- "description": {
3492
- "$ref": "#/components/schemas/StepDescription"
3493
- },
3494
- "status": {
3495
- "$ref": "#/components/schemas/StepStatus"
3496
- },
3497
- "journey": {
3498
- "$ref": "#/components/schemas/StepJourney"
3499
- },
3500
- "due_date": {
3501
- "type": "string",
3502
- "example": "2021-04-27T12:00:00.000Z"
3503
- },
3504
- "due_date_config": {
3505
- "$ref": "#/components/schemas/DueDateConfig"
3506
- },
3507
- "requirements": {
3508
- "type": "array",
3509
- "description": "requirements that need to be fulfilled in order to enable the task while flow instances are running",
3510
- "items": {
3511
- "$ref": "#/components/schemas/EnableRequirement"
3512
- }
3513
- },
3514
- "assigned_to": {
3515
- "$ref": "#/components/schemas/Assignees"
3516
- },
3517
- "analytics": {
3518
- "$ref": "#/components/schemas/AnalyticsInfo"
3519
- },
3520
- "created_at": {
3521
- "type": "string",
3522
- "format": "date-time",
3523
- "description": "Time when the task was created"
3524
- },
3525
- "updated_at": {
3526
- "type": "string",
3527
- "format": "date-time",
3528
- "description": "Last Update timestamp"
3529
- },
3530
- "manually_created": {
3531
- "type": "boolean",
3532
- "description": "Flag to indicate if the task was created manually"
3533
- },
3534
- "enabled": {
3535
- "type": "boolean",
3536
- "description": "enabled flag results from calculating the requirements"
3537
- },
3538
- "ecp": {
3539
- "$ref": "#/components/schemas/ECPDetails"
3540
- },
3541
- "installer": {
3542
- "$ref": "#/components/schemas/ECPDetails"
3543
- },
3544
- "taxonomies": {
3545
- "type": "array",
3546
- "items": {
3547
- "type": "string"
3548
- },
3549
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
3550
- },
3551
- "phase_id": {
3552
- "type": "string"
3553
- },
3554
- "task_type": {
3555
- "$ref": "#/components/schemas/TaskType"
3556
- }
3557
- },
3558
- "required": [
3559
- "id",
3560
- "template_id",
3561
- "name",
3562
- "task_type",
3563
- "status",
3564
- "analytics",
3565
- "enabled"
3566
- ]
3567
- },
3568
- "Phase": {
3569
- "type": "object",
3570
- "properties": {
3571
- "id": {
3572
- "$ref": "#/components/schemas/PhaseId"
3573
- },
3574
- "template_id": {
3575
- "type": "string"
3576
- },
3577
- "name": {
3578
- "type": "string"
3579
- },
3580
- "status": {
3581
- "$ref": "#/components/schemas/SectionStatus"
3582
- },
3583
- "updated_at": {
3584
- "type": "string",
3585
- "description": "Last Update timestamp"
3586
- },
3587
- "due_date": {
3588
- "type": "string",
3589
- "example": "2021-04-27T12:00:00.000Z"
3590
- },
3591
- "due_date_config": {
3592
- "$ref": "#/components/schemas/DueDateConfig"
3593
- },
3594
- "assigned_to": {
3595
- "$ref": "#/components/schemas/Assignees"
3596
- },
3597
- "analytics": {
3598
- "$ref": "#/components/schemas/AnalyticsInfo"
3599
- },
3600
- "taxonomies": {
3601
- "type": "array",
3602
- "items": {
3603
- "type": "string"
3604
- },
3605
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
3606
- },
3607
- "loop_config": {
3608
- "$ref": "#/components/schemas/LoopInfo"
3609
- }
3610
- },
3611
- "required": [
3612
- "id",
3613
- "template_id",
3614
- "name"
3615
- ]
3616
- },
3617
- "Edge": {
3618
- "type": "object",
3619
- "properties": {
3620
- "id": {
3621
- "type": "string"
3622
- },
3623
- "from_id": {
3624
- "$ref": "#/components/schemas/TaskId"
3625
- },
3626
- "to_id": {
3627
- "$ref": "#/components/schemas/TaskId"
3628
- },
3629
- "condition_id": {
3630
- "$ref": "#/components/schemas/ConditionId"
3631
- },
3632
- "none_met": {
3633
- "type": "boolean",
3634
- "description": "Indicates a default case for a decision task. Only decision task edges can have this field and the flow advances using this edge if no conditions are met."
3635
- }
3636
- },
3637
- "required": [
3638
- "id",
3639
- "from_id",
3640
- "to_id"
3641
- ]
3642
- },
3643
- "AutomationInfo": {
3644
- "type": "object",
3645
- "properties": {
3646
- "flow_id": {
3647
- "type": "string",
3648
- "description": "Id of the automation that should be run by this task"
3649
- },
3650
- "execution_id": {
3651
- "type": "string",
3652
- "description": "Id of the automation execution, when it already ran"
3653
- },
3654
- "execution_status": {
3655
- "type": "string",
3656
- "description": "Status of the automation execution, when it already ran"
3657
- },
3658
- "error_reason": {
3659
- "type": "string"
3660
- }
3661
- },
3662
- "required": [
3663
- "flow_id"
3664
- ]
3665
- },
3666
- "AnalyticsInfo": {
3667
- "type": "object",
3668
- "properties": {
3669
- "started_at": {
3670
- "type": "string",
3671
- "format": "date-time"
3672
- },
3673
- "in_progress_at": {
3674
- "type": "string",
3675
- "format": "date-time"
3676
- },
3677
- "completed_at": {
3678
- "type": "string",
3679
- "format": "date-time"
3680
- },
3681
- "status_updated_at": {
3682
- "type": "string",
3683
- "format": "date-time",
3684
- "description": "Last updated timestamp of the status"
3685
- },
3686
- "in_progress_by": {
3687
- "$ref": "#/components/schemas/UserId",
3688
- "description": "The user which moved the task/phase to IN_PROGRESS state."
3689
- },
3690
- "completed_by": {
3691
- "$ref": "#/components/schemas/UserId",
3692
- "description": "The user which moved the task/phase to COMPLETED state."
3693
- },
3694
- "skipped_by": {
3695
- "$ref": "#/components/schemas/UserId",
3696
- "description": "The user which moved the task/phase to SKIPPED state."
3697
- }
3698
- }
3699
- },
3700
- "ConditionId": {
3701
- "description": "A locally unique identifier for the condition",
3702
- "type": "string",
3703
- "example": "abc123"
3704
- },
3705
- "Condition": {
3706
- "type": "object",
3707
- "properties": {
3708
- "id": {
3709
- "$ref": "#/components/schemas/ConditionId"
3710
- },
3711
- "branch_name": {
3712
- "type": "string",
3713
- "description": "The name of the branch",
3714
- "maxLength": 255,
3715
- "example": "Branch 1"
3716
- },
3717
- "logical_operator": {
3718
- "type": "string",
3719
- "enum": [
3720
- "AND",
3721
- "OR"
3722
- ]
3723
- },
3724
- "statements": {
3725
- "type": "array",
3726
- "items": {
3727
- "$ref": "#/components/schemas/Statement"
3728
- }
3729
- },
3730
- "evaluated_at": {
3731
- "type": "string",
3732
- "format": "date-time",
3733
- "description": "Time when the condition was evaluated"
3734
- },
3735
- "is_met": {
3736
- "type": "boolean",
3737
- "description": "The result of evaluating this condition - true / false"
3738
- }
3739
- },
3740
- "required": [
3741
- "id",
3742
- "branch_name",
3743
- "logical_operator",
3744
- "statements"
3745
- ]
3746
- },
3747
- "Statement": {
3748
- "type": "object",
3749
- "properties": {
3750
- "id": {
3751
- "type": "string"
3752
- },
3753
- "source": {
3754
- "$ref": "#/components/schemas/EvaluationSource"
3755
- },
3756
- "operator": {
3757
- "$ref": "#/components/schemas/Operator"
3758
- },
3759
- "values": {
3760
- "type": "array",
3761
- "items": {
3762
- "type": "string"
3763
- }
3764
- }
3765
- },
3766
- "required": [
3767
- "id",
3768
- "source",
3769
- "operator",
3770
- "values"
3771
- ]
3772
- },
3773
- "EvaluationSource": {
3774
- "type": "object",
3775
- "properties": {
3776
- "id": {
3777
- "type": "string",
3778
- "description": "The id of the action or trigger"
3779
- },
3780
- "origin": {
3781
- "type": "string",
3782
- "enum": [
3783
- "trigger",
3784
- "action"
3785
- ]
3786
- },
3787
- "origin_type": {
3788
- "type": "string",
3789
- "enum": [
3790
- "entity",
3791
- "workflow",
3792
- "journey_block"
3793
- ]
3794
- },
3795
- "schema": {
3796
- "type": "string"
3797
- },
3798
- "attribute": {
3799
- "type": "string"
3800
- },
3801
- "attribute_type": {
3802
- "type": "string",
3803
- "enum": [
3804
- "string",
3805
- "text",
3806
- "number",
3807
- "boolean",
3808
- "date",
3809
- "datetime",
3810
- "tags",
3811
- "country",
3812
- "email",
3813
- "phone",
3814
- "product",
3815
- "price",
3816
- "status",
3817
- "relation",
3818
- "multiselect",
3819
- "select",
3820
- "radio",
3821
- "relation_user",
3822
- "purpose",
3823
- "label",
3824
- "message_email_address"
3825
- ]
3826
- },
3827
- "attribute_repeatable": {
3828
- "type": "boolean"
3829
- },
3830
- "attribute_operation": {
3831
- "enum": [
3832
- "all",
3833
- "updated",
3834
- "added",
3835
- "deleted"
3836
- ]
3837
- },
3838
- "attribute_sub_field": {
3839
- "type": "string",
3840
- "description": "For complex attribute types, specifies which sub-field to extract (e.g., 'address', 'name', 'email_type')"
3841
- }
3842
- }
3843
- },
3844
- "Operator": {
3845
- "type": "string",
3846
- "enum": [
3847
- "equals",
3848
- "not_equals",
3849
- "any_of",
3850
- "none_of",
3851
- "contains",
3852
- "not_contains",
3853
- "starts_with",
3854
- "ends_with",
3855
- "greater_than",
3856
- "less_than",
3857
- "greater_than_or_equals",
3858
- "less_than_or_equals",
3859
- "is_empty",
3860
- "is_not_empty"
3861
- ]
3862
- },
3863
- "DueDateConfig": {
3864
- "description": "Set due date for the task based on a dynamic condition",
3865
- "type": "object",
3866
- "properties": {
3867
- "duration": {
3868
- "type": "number"
3869
- },
3870
- "unit": {
3871
- "$ref": "#/components/schemas/TimeUnit"
3872
- },
3873
- "type": {
3874
- "type": "string",
3875
- "enum": [
3876
- "WORKFLOW_STARTED",
3877
- "TASK_FINISHED",
3878
- "PHASE_FINISHED",
3879
- "A_PRECEDING_TASK_COMPLETED",
3880
- "ALL_PRECEDING_TASKS_COMPLETED"
3881
- ]
3882
- },
3883
- "task_id": {
3884
- "type": "string"
3885
- },
3886
- "phase_id": {
3887
- "type": "string"
3888
- }
3889
- },
3890
- "required": [
3891
- "duration",
3892
- "unit",
3893
- "type"
3894
- ]
3895
- },
3896
- "TimeUnit": {
3897
- "type": "string",
3898
- "enum": [
3899
- "minutes",
3900
- "hours",
3901
- "days",
3902
- "weeks",
3903
- "months"
3904
- ]
3905
- },
3906
- "EnableRequirement": {
3907
- "description": "describe the requirement for a task to be enabled",
3908
- "type": "object",
3909
- "properties": {
3910
- "task_id": {
3911
- "type": "string",
3912
- "description": "The template_id of the task that this requirement points to"
3913
- },
3914
- "phase_id": {
3915
- "type": "string",
3916
- "description": "The template_id of the phase that this requirement points to"
3917
- },
3918
- "when": {
3919
- "type": "string",
3920
- "enum": [
3921
- "TASK_FINISHED",
3922
- "PHASE_FINISHED"
3923
- ]
3924
- }
3925
- },
3926
- "required": [
3927
- "when"
3928
- ]
3929
- },
3930
- "FlowTemplateId": {
3931
- "type": "string"
3932
- },
3933
- "FlowExecutionId": {
3934
- "type": "string"
3935
- },
3936
- "UserId": {
3937
- "type": "string",
3938
- "description": "The user id"
3939
- },
3940
- "VariableAssignment": {
3941
- "type": "object",
3942
- "description": "Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.",
3943
- "properties": {
3944
- "variable": {
3945
- "type": "string",
3946
- "description": "The variable expression, e.g., \"{{entity.owner}}\"",
3947
- "example": "{{entity.owner}}"
3948
- },
3949
- "value": {
3950
- "type": "array",
3951
- "items": {
3952
- "type": "string"
3953
- },
3954
- "description": "The resolved values after variable evaluation (populated during execution)",
3955
- "example": [
3956
- "user_12345"
3957
- ]
3958
- }
3959
- },
3960
- "required": [
3961
- "variable"
3962
- ]
3963
- },
3964
- "Assignees": {
3965
- "type": "array",
3966
- "items": {
3967
- "oneOf": [
3968
- {
3969
- "type": "string"
3970
- },
3971
- {
3972
- "$ref": "#/components/schemas/VariableAssignment"
3973
- }
3974
- ]
3975
- },
3976
- "description": "The user ids or variable assignments"
3977
- },
3978
- "PatchTaskReq": {
3979
- "type": "object",
3980
- "properties": {
3981
- "name": {
3982
- "type": "string"
3983
- },
3984
- "status": {
3985
- "$ref": "#/components/schemas/StepStatus"
3986
- },
3987
- "due_date": {
3988
- "type": "string",
3989
- "example": "2021-04-27T12:00:00.000Z"
3990
- },
3991
- "due_date_config": {
3992
- "$ref": "#/components/schemas/DueDateConfig"
3993
- },
3994
- "assigned_to": {
3995
- "$ref": "#/components/schemas/Assignees"
3996
- },
3997
- "enabled": {
3998
- "type": "boolean",
3999
- "description": "flag for controlling enabled/disabled state of the task"
4000
- },
4001
- "automation_config": {
4002
- "$ref": "#/components/schemas/AutomationInfo"
4003
- },
4004
- "description": {
4005
- "$ref": "#/components/schemas/StepDescription"
4006
- },
4007
- "ecp": {
4008
- "$ref": "#/components/schemas/ECPDetails"
4009
- },
4010
- "installer": {
4011
- "$ref": "#/components/schemas/ECPDetails"
4012
- },
4013
- "next_condition_id": {
4014
- "type": "string",
4015
- "description": "Condition to evaluate as true for a decision task with a manual trigger mode"
4016
- },
4017
- "revert_execution": {
4018
- "type": "boolean",
4019
- "description": "When patching an already completed/skipped task that comes before the current task, this flag controls whether to revert the execution:\n- `true`: The patched task becomes the current task AND all succeeding tasks are reset to PENDING (full revert)\n- `false` or omitted (undefined): The task is updated but the current task does not change and no downstream tasks are affected\nThis parameter is silently ignored when patching the current task or future tasks.\n",
4020
- "default": false
4021
- }
4022
- }
4023
- },
4024
- "PatchPhaseReq": {
4025
- "type": "object",
4026
- "properties": {
4027
- "name": {
4028
- "type": "string"
4029
- },
4030
- "due_date": {
4031
- "type": "string",
4032
- "example": "2021-04-27T12:00:00.000Z"
4033
- },
4034
- "due_date_config": {
4035
- "$ref": "#/components/schemas/DueDateConfig"
4036
- },
4037
- "assigned_to": {
4038
- "$ref": "#/components/schemas/Assignees"
4039
- }
4040
- }
4041
- },
4042
- "AddTaskReq": {
4043
- "type": "object",
4044
- "properties": {
4045
- "previous_task_id": {
4046
- "type": "string",
4047
- "description": "Source node id for the edge to this task",
4048
- "format": "uuid"
4049
- },
4050
- "next_task_id": {
4051
- "type": "string",
4052
- "description": "Target node id for the edge from this task",
4053
- "format": "uuid"
4054
- },
4055
- "task": {
4056
- "type": "object",
4057
- "properties": {
4058
- "id": {
4059
- "type": "string",
4060
- "description": "Id of the task",
4061
- "format": "uuid"
4062
- },
4063
- "name": {
4064
- "type": "string"
4065
- },
4066
- "status": {
4067
- "$ref": "#/components/schemas/StepStatus"
4068
- },
4069
- "due_date": {
4070
- "type": "string",
4071
- "example": "2021-04-27T12:00:00.000Z"
4072
- },
4073
- "due_date_config": {
4074
- "$ref": "#/components/schemas/DueDateConfig"
4075
- },
4076
- "assigned_to": {
4077
- "$ref": "#/components/schemas/Assignees"
4078
- },
4079
- "enabled": {
4080
- "type": "boolean",
4081
- "description": "flag for controlling enabled/disabled state of the task"
4082
- },
4083
- "automation_config": {
4084
- "$ref": "#/components/schemas/AutomationInfo"
4085
- },
4086
- "phase_id": {
4087
- "type": "string"
4088
- },
4089
- "task_type": {
4090
- "$ref": "#/components/schemas/TaskType"
4091
- }
4092
- },
4093
- "required": [
4094
- "name"
4095
- ]
4096
- }
4097
- },
4098
- "required": [
4099
- "previous_task_id",
4100
- "next_task_id",
4101
- "task"
4102
- ]
4103
- }
4104
- }
4105
- }
4106
- }