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