-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoriginal_modified.yaml
1604 lines (1604 loc) · 46.8 KB
/
original_modified.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Workflows Definitions
version: 1.0.0
description: |
Service for Workflow Definitions for different processes inside of an Organization
servers:
- url: https://workflows-definition.sls.epilot.io
security:
- BearerAuth: []
paths:
/v1/workflows/limits/max-allowed:
get:
operationId: getMaxAllowedLimit
summary: getMaxAllowedLimit
description: Get limits and number of created executions for an Organization.
tags:
- Workflows
responses:
200:
description: A combo of current number of workflows, and the max allowed number of workflows.
content:
application/json:
schema:
$ref: "#/components/schemas/MaxAllowedLimit"
example:
currentNoOfWorkflows: 5
maxAllowed: 7
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
/v1/workflows/definitions:
get:
operationId: getDefinitions
summary: getDefinitions
description: Retrieve all Workflow Definitions from an Organization
tags:
- Workflows
responses:
200:
description: Success - definitions loaded with success. Empty array if org has no definitions.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/WorkflowDefinition"
example:
- id: 25n2k52ja
name: Lead Qualification
assignedTo:
- "18625"
- "90252"
description: Lead Qualification description
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
dueDate: "2021-08-04T21:13:50.373Z"
flow:
- id: 5892na2
name: Initial Information Gathering
order: 1
type: SECTION
steps:
- id: 2hja82a
name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["123482"]
- id: ga92ha2
name: "Check product availability"
type: STEP
order: 2
assignedTo: ["123482"]
- id: jga92ha
name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["123482"]
- id: 0a7g22a
name: Print and send catalog
type: STEP
order: 2
assignedTo: ["123482"]
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
post:
operationId: createDefinition
summary: createDefinition
description: Create a Workflow Definition.
tags:
- Workflows
requestBody:
description: Workflow Definition payload
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowDefinition"
example:
name: Lead Qualification
description: Lead Qualification description
dueDate: "2022-08-04T12:00:00.000Z"
assignedTo:
- "952802"
- "80225"
flow:
- name: Initial Information Gathering
order: 1
type: SECTION
steps:
- name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["123482"]
- name: "Check product availability"
type: STEP
order: 2
assignedTo: ["123482"]
- name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["123482"]
- name: Print and send catalog
type: STEP
order: 2
assignedTo: ["123482"]
responses:
201:
description: Success - if the definition is created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowDefinition"
example:
id: 25n2k52ja
name: Lead Qualification
description: Lead Qualification description
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
dueDate: "2022-08-04T12:00:00.000Z"
assignedTo:
- "952802"
- "80225"
flow:
- id: 5892na2
name: Initial Information Gathering
order: 1
type: SECTION
steps:
- id: 2hja82a
name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["48829"]
- id: ga92ha2
name: "Check product availability"
type: STEP
order: 2
assignedTo: ["45390"]
- id: jga92ha
name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["8230"]
- id: 0a7g22a
name: Print and send catalog
type: STEP
order: 2
assignedTo: ["8239"]
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
x-speakeasy-entity-operation: WorkflowDefinition#create
/v2/flows/templates:
get:
operationId: listFlowTemplates
summary: listFlowTemplates
description: List all Flow Templates for a customer
tags:
- Flows V2
responses:
200:
description: Success - flow templates loaded with success. Empty array if customer has no flows defined.
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplatesList"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
post:
operationId: createFlowTemplate
summary: createFlowTemplate
description: Create a new Flow Template.
tags:
- Flows V2
requestBody:
description: Flow Template payload
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplate"
responses:
201:
description: Success - if the flow template is created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplate"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
/v2/flows/templates/{flowId}:
get:
operationId: getFlowTemplate
summary: getFlowTemplate
description: Get specific FLow template for a customer
tags:
- Flows V2
parameters:
- in: path
name: flowId
schema:
$ref: "#/components/schemas/FlowTemplateId"
required: true
responses:
200:
description: Returns the Flow Template
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplate"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Definition Not found
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionNotFoundResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
put:
operationId: updateFlowTemplate
summary: updateFlowTemplate
description: Update Flow Template.
tags:
- Flows V2
parameters:
- in: path
name: flowId
schema:
$ref: "#/components/schemas/FlowTemplateId"
required: true
requestBody:
description: Flow Template payload
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplate"
responses:
200:
description: Flow template has been updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/FlowTemplate"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
delete:
operationId: deleteFlowTemplate
summary: deleteFlowTemplate
description: Delete Flow Template.
tags:
- Flows V2
parameters:
- in: path
name: flowId
schema:
$ref: "#/components/schemas/FlowTemplateId"
required: true
description: Id of the flow template to de deleted.
responses:
204:
description: Flow template has been deleted successfully
401:
description: Failed to authenticate
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: No definition found
/v1/workflows/definitions/{definitionId}:
get:
operationId: getDefinition
summary: getDefinition
description: Get specific Definition by id from the Organization.
tags:
- Workflows
parameters:
- in: path
name: definitionId
schema:
type: string
required: true
description: Short uuid (length 8) to identify the Workflow Definition.
example: 7hj28a
x-speakeasy-match: id
responses:
200:
description: Returns the Workflow definition
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowDefinition"
example:
id: 25n2k52ja
name: Lead Qualification
dueDate: "2022-08-04T12:00:00.000Z"
assignedTo:
- "952802"
- "80225"
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
flow:
- id: 5892na2
name: Initial Information Gathering
order: 1
type: SECTION
steps:
- id: 2hja82a
name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["923432"]
- id: ga92ha2
name: "Check product availability"
type: STEP
order: 2
assignedTo: ["45488"]
- id: jga92ha
name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["45488"]
- id: 0a7g22a
name: Print and send catalog
type: STEP
order: 2
assignedTo: ["8988"]
closingReasons: [{id: ffoowef, title: test}, {id: "hebwoeu", title: Closing because all}, {id: "mbnoenq", title: Better offer}]
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Definition Not found
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionNotFoundResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
x-speakeasy-entity-operation: WorkflowDefinition#get
put:
operationId: updateDefinition
summary: updateDefinition
description: Update Workflow Definition.
tags:
- Workflows
parameters:
- in: path
name: definitionId
schema:
type: string
required: true
description: Short uuid (length 8) to identify the Workflow Definition.
example: 7hj28a
x-speakeasy-match: id
requestBody:
description: Workflow Definition payload
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowDefinition"
example:
id: 25n2k52ja
name: Lead Qualification
dueDate: "2022-08-04T12:00:00.000Z"
assignedTo:
- "952802"
- "80225"
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
flow:
- id: 5892na2
name: Initial Information Gathering
order: 1
type: SECTION
steps:
- id: 2hja82a
name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["8988"]
- id: ga92ha2
name: "Check product availability"
type: STEP
order: 2
assignedTo: ["8988"]
- id: jga92ha
name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["8988"]
- id: 0a7g22a
name: Print and send catalog
type: STEP
order: 2
assignedTo: ["8988"]
responses:
200:
description: Success - if the definition is updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowDefinition"
example:
id: 25n2k52ja
name: Lead Qualification
dueDate: "2022-08-04T12:00:00.000Z"
assignedTo:
- "952802"
- "80225"
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
flow:
- id: 5892na2
name: Initial Information Gathering
order: 1
type: SECTION
steps:
- id: 2hja82a
name: "Call client and confirm address and product"
type: STEP
order: 1
assignedTo: ["1"]
- id: ga92ha2
name: "Check product availability"
type: STEP
order: 2
assignedTo: ["56645"]
- id: jga92ha
name: "Send email confirming contact with the client"
type: STEP
order: 3
assignedTo: ["949923"]
- id: 0a7g22a
name: Print and send catalog
type: STEP
order: 2
assignedTo: ["156645"]
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
x-speakeasy-entity-operation: WorkflowDefinition#update
delete:
operationId: deleteDefinition
summary: deleteDefinition
description: Delete Workflow Definition.
tags:
- Workflows
parameters:
- in: path
name: definitionId
schema:
type: string
required: true
description: Id of the definition to de deleted.
example: CustomerRequest
x-speakeasy-match: id
# jsonencode workflows definiton flows due to type incompatibilities
responses:
204:
description: Success - if the definition is deleted successfully
401:
description: Failed to authenticate
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: No definition found
x-speakeasy-entity-operation: WorkflowDefinition#delete
/v1/workflows/closing-reasons:
get:
operationId: getAllClosingReasons
summary: getAllClosingReasons
description: Get all Closing Reasons defined in the organization by default all Active.
parameters:
- in: query
name: includeInactive
schema:
type: boolean
required: false
description: Filter Closing Reasons by status like active inactiv
example: true
tags:
- Closing Reason
responses:
200:
description: Returns the entire catalog of closing reasons per organization
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasons"
post:
operationId: createClosingReason
summary: createClosingReason
description: A created Closing Reason is stored for the organization and will be displayed in the library of reasons.
tags:
- Closing Reason
requestBody:
description: closing reason to store
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
example:
title: better offer
description: A customer closes the process because he found something better
responses:
201:
description: closing reason is stored successfully in the repository
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
x-speakeasy-entity-operation: ClosingReason#create
/v2/workflows/closing-reasons/{reasonId}:
get:
operationId: getClosingReason
summary: getClosingReason
description: Get specific closing reason by id from the organisation.
tags:
- Closing Reason
parameters:
- in: path
name: reasonId
schema:
type: string
example: "x739cew"
required: true
description: unique id to identify the closing reason.
x-speakeasy-match: id
responses:
200:
description: Returns the closing reason
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
403:
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Closing reason not found
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonNotFoundResp"
x-speakeasy-entity-operation: ClosingReason#get
patch:
operationId: updateClosingReason
summary: updateClosingReason
description: Update an existing closing reason
tags:
- Closing Reason
parameters:
- in: path
name: reasonId
schema:
type: string
example: "x739cew"
required: true
description: unique id to identify the closing reason.
x-speakeasy-match: id
requestBody:
description: Updated closing reason fields
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
responses:
200:
description: Closing reason updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
403:
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Closing reason not found
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonNotFoundResp"
x-speakeasy-entity-operation: ClosingReason#update
delete:
operationId: deleteClosingReason
summary: deleteClosingReason
description: Permanently delete a closing reason (Using INACTIVE status is recommended instead)
tags:
- Closing Reason
parameters:
- in: path
name: reasonId
schema:
type: string
example: "x739cew"
required: true
description: unique id to identify the closing reason.
x-speakeasy-match: id
responses:
204:
description: Closing reason deleted successfully
403:
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Closing reason not found
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonNotFoundResp"
x-speakeasy-entity-operation: ClosingReason#delete
/v1/workflows/closing-reasons/{reasonId}:
get:
deprecated: true
operationId: getClosingReasonV1
summary: getClosingReasonV1
description: Get specific closing reason by id from the organisation.
tags:
- Closing Reason
parameters:
- in: path
name: reasonId
schema:
type: string
required: true
description: uuid to identify the closing reason.
example: -poOAPBa-jFZA_AWV3zN0
responses:
200:
description: Returns the closing reason
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReason"
example:
id: -poOAPBa-jFZA_AWV3zN0
title: Closing due to example reason
status: "ACTIVE"
lastUpdateTime: "2021-08-04T21:13:50.373Z"
creationTime: "2021-08-04T21:13:50.373Z"
400:
description: Validation Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
404:
description: Closing reason not found
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonNotFoundResp"
401:
description: Authentication Errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Other errors
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
patch:
operationId: changeReasonStatus
summary: changeReasonStatus
description: Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).
tags:
- Closing Reason
parameters:
- in: path
name: reasonId
required: true
schema:
type: string
requestBody:
description: change the status of a closing reason
content:
application/json:
schema:
$ref: "#/components/schemas/ChangeReasonStatusReq"
responses:
202:
description: The status change was accepted
400:
description: bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
500:
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResp"
/v1/workflows/definitions/{definitionId}/closing-reasons:
get:
operationId: getWorkflowClosingReasons
summary: getWorkflowClosingReasons
description: Returns all closing reasons defined for the workflow.
parameters:
- in: path
name: definitionId
schema:
type: string
required: true
description: ID of a workflow definition
example: fxcwfw
tags:
- Workflows
responses:
200:
description: Returns the entire catalog of closing reasons for a specific workflow
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonsIds"
patch:
operationId: setWorkflowClosingReasons
summary: setWorkflowClosingReasons
description: Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.
tags:
- Workflows
parameters:
- in: path
name: definitionId
schema:
type: string
required: true
description: ID of a workflow definition
example: 7889
requestBody:
description: set all closing reasons for a specific definition
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClosingReasonsIds"
responses:
201:
description: closing reasons are set for this workflow
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
# ------------------------- #
# V2 data structures
# ------------------------- #
FlowTemplate:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
created_at:
type: string
description: ISO String Date & Time
example: "2021-04-27T12:01:13.000Z"
enabled:
type: boolean
description: Whether the workflow is enabled or not
default: true
updated_at:
type: string
description: ISO String Date & Time
example: "2021-04-27T12:01:13.000Z"
due_date:
type: string
example: "2021-04-27T12:00:00.000Z"
due_date_config:
$ref: "#/components/schemas/DueDateConfig"
assigned_to:
type: array
items:
type: string
available_in_ecp:
type: boolean
description: Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
phases:
type: array
items:
$ref: "#/components/schemas/Phase"
tasks:
type: array
items:
$ref: "#/components/schemas/Task"
edges:
type: array
items:
$ref: "#/components/schemas/Edge"
closing_reasons:
type: array
items:
$ref: "#/components/schemas/ClosingReasonId"
update_entity_attributes:
type: array
items:
$ref: "#/components/schemas/UpdateEntityAttributes"
taxonomies:
type: array
items:
type: string
description: Taxonomy ids that are associated with this workflow and used for filtering
required:
- name
- tasks
- edges
FlowTemplatesList:
type: object
properties:
results:
type: array
items:
$ref: "#/components/schemas/FlowTemplate"
required:
- results
FlowTemplateId:
type: string
description: Short unique id (length 8) to identify the Flow Template.
example: 7hj28akg
Task:
anyOf:
- $ref: "#/components/schemas/ManualTask"
- $ref: "#/components/schemas/AutomationTask"
- $ref: "#/components/schemas/DecisionTask"
ManualTask:
allOf:
- $ref: "#/components/schemas/TaskBase"
AutomationTask:
allOf:
- $ref: "#/components/schemas/TaskBase"
- type: object
required:
- automation_config
properties:
automation_config:
type: object
properties:
flow_id:
type: string
description: Id of the configured automation to run