-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathmaestro.rest.swagger-v1.0.0.json
More file actions
1515 lines (1515 loc) · 75.7 KB
/
maestro.rest.swagger-v1.0.0.json
File metadata and controls
1515 lines (1515 loc) · 75.7 KB
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.1.0",
"info": {
"title": "Maestro API",
"version": "1.0.7",
"description": "API for triggering and managing automated workflows",
"termsOfService": "https://www.docusign.com/legal/terms-and-conditions/developers",
"license": {
"name": "",
"url": "https://www.docusign.com/legal/terms-and-conditions/developers"
},
"contact": {
"name": "Docusign Developer Center",
"email": "devcenter@docusign.com",
"url": "https://developers.docusign.com"
}
},
"servers": [
{
"url": "https://api.docusign.com",
"description": "Production server"
},
{
"url": "https://api-d.docusign.com",
"description": "Demo server"
}
],
"security": [
{
"MaestroOAuth2": [
"adm_store_unified_repo_read",
"aow_manage",
"signature"
]
}
],
"paths": {
"/v1/accounts/{accountId}/workflows": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"example": "ae232f1f-8efc-4b8c-bb08-626847fad8bb",
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
},
{
"in": "query",
"name": "status",
"required": false,
"example": "active",
"schema": {
"type": "string",
"enum": [
"active",
"inactive",
"publishing",
"unpublishing",
"archived",
"archiving"
]
},
"description": "Filter workflows by their status. If provided, only workflows with the specified status will be returned.\n- `active`: Returns only active workflows.\n- `inactive`: Returns only inactive workflows.\n- `publishing`: Returns workflows currently being published.\n- `unpublishing`: Returns workflows currently being unpublished.\n- `archived`: Returns workflows that have been archived.\n- `archiving`: Returns workflows currently being archived. \n"
}
],
"get": {
"operationId": "GetWorkflowsList",
"summary": "Retrieve a list of available Maestro workflows",
"description": "This operation retrieves a list of all available Maestro workflows. It returns basic information\nabout each workflow, including its unique identifier (`id`), name, description, and the input\nschema required to trigger the workflow.\n\nThe response provides key details that help users identify which workflows are available\nand understand the input requirements for triggering each one. Each workflow entry also includes\nmetadata, such as when it was created, last modified, and by whom.\n\nThis operation is useful for obtaining an overview of all workflows within the system, helping\nusers and systems know what workflows are defined, what inputs they require, and how they can\nbe triggered.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Listing all available workflows in a system for manual or automated workflow initiation.\n- Reviewing the input requirements for a workflow before triggering it programmatically.\n- Gathering basic metadata about workflows for auditing, logging, or reporting purposes.\n\n### Key Features:\n- **Comprehensive Workflow Overview**: Provides a full list of workflows, giving visibility\n into all the automated processes available within the Maestro platform.\n- **Input Schema Information**: Each workflow includes its trigger input schema, showing\n what data must be provided when triggering the workflow.\n- **Metadata for Tracking**: Useful metadata like creation time, last modification date,\n and user details are included to support tracking and auditing workflows.\n- **Future-Proof**: The operation is designed to be expandable as more workflows are added\n or the platform grows, ensuring scalability in the workflow management process.\n",
"x-ds-methodname": "getWorkflowsList",
"tags": [
"Workflows"
],
"responses": {
"200": {
"$ref": "#/components/responses/WorkflowsListSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "getWorkflowsList",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/trigger-requirements": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"example": "ae232f1f-8efc-4b8c-bb08-626847fad8bb",
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
}
],
"get": {
"operationId": "GetWorkflowTriggerRequirements",
"summary": "Retrieve trigger requirements for a specific Maestro workflow",
"description": "This operation retrieves the configuration and input requirements necessary to trigger a specific\nMaestro workflow. It provides detailed information about the `trigger_event_type`, such as HTTP\nor other supported types, and specifies the required input schema, including field names, data types,\nand any default values.\n\nThis information is essential for understanding the data and parameters required to initiate the\nworkflow. It enables developers to prepare the necessary inputs and configuration before triggering\nthe workflow instance, ensuring seamless execution and compliance with workflow requirements.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Identifying the required input fields and their data types to successfully trigger the workflow.\n- Reviewing the trigger configuration for validation and compliance with expected input.\n- Preparing and validating data in advance of triggering the workflow, minimizing runtime errors.\n\n### Key Features:\n- **Detailed Trigger Input Requirements**: Provides an exhaustive schema of required fields,\n their data types, and optional default values for easy reference and data validation.\n- **Trigger Event Type Information**: Specifies the type of event required to initiate the workflow\n (e.g., HTTP), helping developers configure their systems to invoke the workflow appropriately.\n- **Configurable for Custom Triggers**: Suitable for custom configurations, enabling flexibility\n in how workflows can be triggered according to system needs.\n",
"x-ds-methodname": "getWorkflowTriggerRequirements",
"tags": [
"Workflows"
],
"parameters": [
{
"$ref": "#/components/parameters/WorkflowId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/WorkflowTriggerRequirementsSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "getWorkflowTriggerRequirements",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/trigger": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"example": "ae232f1f-8efc-4b8c-bb08-626847fad8bb",
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
}
],
"post": {
"operationId": "TriggerWorkflow",
"summary": "Trigger a new instance of a Maestro workflow",
"description": "This operation triggers a new instance of a specified Maestro workflow. When invoked,\nthe workflow is started based on the provided input data, and the workflow instance\nbegins executing according to its defined logic and configuration.\n\nThe request requires an `instance_name` and any input data necessary to start the workflow,\nas described by the workflow's `trigger_input_schema`. The `instance_name` is a user-defined\nlabel for tracking the workflow run, while the input data fields should match the schema defined\nin the workflow.\n\nThe operation is event-driven and typically triggered by an external HTTP event or system call,\nallowing for the automatic execution of complex processes that span multiple systems or components.\n\nUpon successful execution, the response returns the unique identifier (`id`) for the newly\ncreated workflow instance, along with a URL (`workflow_instance_url`) that can be used to\ninteract with or track the running instance.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Automating user registration workflows where input fields like `name` and `email` are provided.\n- Processing financial transactions where details such as `amount` and `currency` are required.\n- Sending notifications based on user interactions in other systems.\n\n### Key Features:\n- **Automated Execution**: Once triggered, the workflow runs until a step requires manual intervention.\n- **Input-Driven**: Workflow execution is based on the provided input data, which is validated\n against the workflow's input schema.\n- **Real-Time Triggering**: Designed to be invoked as part of an event-driven architecture,\n allowing for workflows to respond to external events.\n- **Tracking and Interaction**: The response includes a URL that allows users to check the status\n of the workflow instance or take further actions while it runs.\n",
"x-ds-methodname": "triggerWorkflow",
"tags": [
"Workflows"
],
"parameters": [
{
"$ref": "#/components/parameters/WorkflowId"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/TriggerWorkflowRequest"
},
"responses": {
"201": {
"$ref": "#/components/responses/TriggerWorkflowSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "triggerWorkflow",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/instances": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
}
],
"get": {
"summary": "Retrieve All Workflow Instances",
"description": "This operation retrieves a list of all available Maestro workflow instances. It returns basic information\nabout each workflow instance, including its unique identifier (`id`), name, status, timestamps, and\nadditional metadata.\n\nThe response provides key details that help users understand what workflow instances are in progress\nor completed, and the relevant data for each. Each workflow instance entry also includes metadata, such\nas who started it, when it was last modified, and how many steps have been completed.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Listing all available workflow instances for manual or automated review\n- Monitoring which workflow instances are currently running or have finished\n- Gathering basic metadata about workflow instances for auditing, logging, or reporting purposes\n\n### Key Features:\n- **Comprehensive Instance Overview**: Provides a full list of workflow instances, giving visibility\n into all ongoing and completed workflows within the Maestro platform\n- **Metadata for Tracking**: Includes helpful metadata like creation time, last modification date,\n and user details to support audit trails\n- **Scalable and Future-Proof**: Designed to handle growing numbers of workflow instances as the\n platform scales\n",
"operationId": "getWorkflowInstancesList",
"x-ds-methodname": "getWorkflowInstancesList",
"tags": [
"WorkflowInstanceManagement"
],
"parameters": [
{
"$ref": "#/components/parameters/WorkflowId"
}
],
"responses": {
"200": {
"description": "Successful response containing a list of workflow instances",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowInstanceCollection"
},
"examples": {
"multipleWorkflowInstances": {
"$ref": "#/components/examples/WorkflowInstanceCollectionExample"
}
}
}
}
}
},
"x-ds-method": "getWorkflowInstancesList",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/pause": {
"post": {
"summary": "Pause an Active Workflow",
"description": "This operation pauses new workflow instances from being created. Any running workflows instances will be unaffected.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n",
"operationId": "pauseNewWorkflowInstances",
"x-ds-methodname": "pauseNewWorkflowInstances",
"tags": [
"Workflows"
],
"parameters": [
{
"$ref": "#/components/parameters/AccountId"
},
{
"$ref": "#/components/parameters/WorkflowId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PauseNewWorkflowInstancesSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "pauseNewWorkflowInstances",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/actions/resume": {
"post": {
"summary": "Resume a Paused Workflow",
"description": "This operation enables new workflow instances to be created.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`",
"operationId": "resumePausedWorkflow",
"x-ds-methodname": "resumePausedWorkflow",
"tags": [
"Workflows"
],
"parameters": [
{
"$ref": "#/components/parameters/AccountId"
},
{
"$ref": "#/components/parameters/WorkflowId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ResumeNewWorkflowInstancesSuccess"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "resumePausedWorkflow",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
}
],
"get": {
"summary": "Retrieve a Workflow Instance",
"description": "This operation retrieves a single Maestro workflow instance by its unique identifier (`id`).\nIt returns the primary details of the workflow instance, including its name, status,\nstarting information, and other metadata.\n\nThe response provides key details that help users understand the current state of the workflow\ninstance, when it was started, and who initiated it. Additional metadata is included to support\nauditing and reporting within the system.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Getting the details of a specific workflow instance for further processing or review\n- Monitoring the status of a running workflow instance to determine completion or cancellation\n- Accessing metadata for auditing, logging, or reporting on a single workflow instance\n\n### Key Features:\n- **Single Workflow Instance**: Provides direct access to a specific workflow instance by `id`\n- **Detailed Status Information**: Includes the workflow's start and end times, status, and other lifecycle timestamps\n- **Metadata for Tracking**: Useful metadata like who initiated the workflow (`started_by`) and versioning details\n- **Future-Proof**: Designed to be extensible if additional fields or nested information are required over time\n",
"operationId": "getWorkflowInstance",
"x-ds-methodname": "getWorkflowInstance",
"tags": [
"WorkflowInstanceManagement"
],
"parameters": [
{
"$ref": "#/components/parameters/WorkflowId"
},
{
"$ref": "#/components/parameters/InstanceId"
}
],
"responses": {
"200": {
"description": "Successful response containing the workflow instance details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowInstance"
},
"examples": {
"workflowInstance": {
"$ref": "#/components/examples/WorkflowInstanceExample"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "getWorkflowInstance",
"x-ds-service": "Maestro"
}
},
"/v1/accounts/{accountId}/workflows/{workflowId}/instances/{instanceId}/actions/cancel": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
}
],
"post": {
"summary": "Cancel a Running Workflow Instance",
"description": "This operation cancels a running Maestro workflow instance by its unique identifier (`instanceId`).\nOnce canceled, the workflow instance will no longer continue executing any remaining steps.\n\n[Required scopes](/docs/maestro-api/auth/): `signature`, `aow_manage`\n\n### Use Cases:\n- Stopping a workflow execution when it is no longer needed or relevant\n- Manually intervening in a workflow to prevent it from reaching completion if conditions change\n\n### Key Features:\n- **Immediate Termination**: Ensures the workflow instance no longer processes subsequent steps\n- **Clear Feedback**: Returns a confirmation message including both the instance and workflow identifiers\n",
"operationId": "cancelWorkflowInstance",
"x-ds-methodname": "cancelWorkflowInstance",
"tags": [
"WorkflowInstanceManagement"
],
"parameters": [
{
"$ref": "#/components/parameters/WorkflowId"
},
{
"$ref": "#/components/parameters/InstanceId"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CancelWorkflowInstanceResponse"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
},
"x-ds-method": "cancelWorkflowInstance",
"x-ds-service": "Maestro"
}
}
},
"components": {
"parameters": {
"AccountId": {
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
},
"description": "The unique identifier of the account."
},
"WorkflowId": {
"name": "workflowId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/UUID"
}
},
"InstanceId": {
"name": "instanceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Unique identifier for the workflow instance"
}
},
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "A message describing the error.",
"examples": [
"An unexpected error occurred on the server."
]
},
"code": {
"type": "string",
"description": "HTTP status code for the error.",
"examples": [
500
]
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the error occurred.",
"examples": [
"2023-01-01T12:00:00Z"
]
}
},
"x-ds-definition-name": "Error"
},
"ResourceId": {
"$ref": "#/components/schemas/UUID",
"x-ds-definition-name": "ResourceId"
},
"ResourceMetadata": {
"type": "object",
"properties": {
"created_at": {
"description": "Timestamp when the agreement document was created.",
"type": "string",
"format": "date-time",
"x-docusign-adm-model": "com.docusign.platform@1.1.0.{Metadata.createdAt}"
},
"created_by": {
"description": "User ID of the person who created the agreement document.",
"type": "string",
"x-docusign-adm-model": "com.docusign.platform@1.1.0.{Metadata.createdBy}"
},
"modified_at": {
"description": "Timestamp when the agreement document was last modified.",
"type": "string",
"format": "date-time",
"x-docusign-adm-model": "com.docusign.platform@1.1.0.{Metadata.updatedAt}"
},
"modified_by": {
"description": "User ID of the person who last modified the agreement document.",
"type": "string",
"x-docusign-adm-model": "com.docusign.platform@1.1.0.{Metadata.updatedBy}"
}
},
"x-docusign-adm-model": "com.docusign.platform@1.1.0.{Metadata}",
"x-ds-definition-name": "ResourceMetadata"
},
"RequestId": {
"description": "Unique identifier for the request, useful for tracking and debugging.",
"type": "string",
"format": "uuid",
"examples": [
"3f7c9e4b-851c-4f9b-89e7-123456789abc"
],
"x-ds-definition-name": "RequestId"
},
"ResponseMetadata": {
"description": "Additional server-side metadata for a given response",
"type": "object",
"properties": {
"response_timestamp": {
"$ref": "#/components/schemas/ResponseTimestamp"
},
"response_duration_ms": {
"$ref": "#/components/schemas/ResponseDurationMs"
},
"request_id": {
"$ref": "#/components/schemas/RequestId"
}
},
"x-ds-definition-name": "ResponseMetadata"
},
"ResponseTimestamp": {
"description": "The timestamp indicating when the response was generated.",
"type": "string",
"format": "date-time",
"examples": [
"2024-10-17T14:30:00Z"
],
"x-ds-definition-name": "ResponseTimestamp"
},
"ResponseDurationMs": {
"description": "The duration of time, in milliseconds, that the server took to process and respond\nto the request. This is measured from the time the server received the request\nuntil the time the response was sent.\n",
"type": "integer",
"format": "int32",
"examples": [
150
],
"minimum": 0,
"x-ds-definition-name": "ResponseDurationMs"
},
"URL": {
"type": "string",
"format": "uri",
"maxLength": 1024,
"x-docusign-adm-model": "com.docusign.scalars@1.1.0.{URL}",
"examples": [
"https://example.com/resource/123"
],
"x-ds-definition-name": "URL"
},
"UUID": {
"type": "string",
"pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$",
"default": "00000000-0000-0000-0000-000000000000",
"examples": [
"adf8c455-de2f-4119-b183-d952d649e87c"
],
"x-docusign-adm-model": "concerto.platform.scalar@1.0.0.{UUID}",
"description": "A universally unique identifier (UUID) in standard 8-4-4-4-12 format.",
"x-ds-definition-name": "UUID"
},
"TriggerInputs": {
"type": "object",
"description": "Key-value pairs representing the input data required to trigger the workflow.\nThe keys correspond to the `field_name` values defined in the `trigger_input_schema` of the workflow definition.\nThe values should match the specified `field_data_type` (e.g., string, number, boolean).\nExample: {\"name\": \"John Doe\", \"email\": \"johndoe@example.com\"}\n",
"additionalProperties": {
"description": "A key-value pair where the key is the `field_name` defined in the `trigger_input_schema` of the workflow definition,\nand the value is the actual input data. Supported types include string, number, boolean, object, or array.\n",
"oneOf": [
{
"type": "string",
"description": "String input, e.g., names, emails, etc.",
"examples": [
"John Doe"
]
},
{
"type": "number",
"description": "Numeric input, e.g., ages, IDs, etc.",
"examples": [
30
]
},
{
"type": "boolean",
"description": "Boolean input for true/false values.",
"examples": [
true
]
},
{
"type": "object",
"description": "Nested object input, if a complex structure is required.",
"additionalProperties": true,
"examples": [
{
"address": {
"street": "123 Main St",
"city": "Metropolis"
}
}
]
},
{
"type": "array",
"description": "An array of values if the input expects multiple items.",
"items": {},
"examples": [
[
"item1",
"item2",
"item3"
]
]
}
]
},
"x-ds-definition-name": "TriggerInputs"
},
"TriggerWorkflow": {
"description": "The input information needed to trigger a new instance of a Maestro workflow.\nThis request body contains the metadata to describe the instance being created,\nalong with the input data required to trigger the workflow.\n\n- `instance_name` provides a user-defined name for the workflow instance.\n- `trigger_inputs` contains the key-value pairs corresponding to the inputs required by the workflow, as described in the `trigger_input_schema` from the workflow definition.\n",
"type": "object",
"properties": {
"instance_name": {
"type": "string",
"description": "A descriptive name for the specific instance of the workflow being triggered.\nThis is typically used for identification and tracking purposes.\nExample: \"User Registration Workflow Instance\"\n",
"examples": [
"Sample Workflow Run"
]
},
"trigger_inputs": {
"$ref": "#/components/schemas/TriggerInputs"
}
},
"required": [
"instance_name",
"trigger_inputs"
],
"examples": [
{
"instance_name": "My Instance",
"trigger_inputs": {
"name": "Jon Doe",
"email": "jdoe@example.com"
}
}
],
"x-ds-definition-name": "TriggerWorkflow"
},
"WorkflowTriggerRequirements": {
"description": "Information about the input requirements and configuration necessary to trigger a specific workflow.\n",
"type": "object",
"properties": {
"trigger_id": {
"$ref": "#/components/schemas/UUID"
},
"trigger_event_type": {
"type": "string",
"const": "HTTP",
"description": "The type of event that triggers the workflow. In this case, the workflow is initiated\nby an HTTP request. Future iterations may support additional event types beyond HTTP.\n",
"examples": [
"HTTP"
]
},
"trigger_http_config": {
"type": "object",
"description": "Configuration details specific to HTTP-triggered workflows. This object describes the\nHTTP method and URL that will trigger the workflow, providing the endpoint and method\nthat should be used to initiate the workflow.\n",
"properties": {
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"description": "The HTTP method used to trigger the workflow. This defines the type of request\nthat will initiate the workflow (e.g., GET, POST).\n",
"examples": [
"GET"
]
},
"url": {
"allOf": [
{
"$ref": "#/components/schemas/URL"
}
],
"description": "The URL that is associated with the trigger event. This is the endpoint that must be\ncalled using the specified HTTP method to start the workflow.\n"
}
}
},
"trigger_input_schema": {
"type": "array",
"description": "A list of input fields that define the structure of the data required to trigger the workflow.\nEach item describes a field that must be included in the request when the workflow is triggered.\nThe schema includes the field name, expected data type, and any default values for the input.\n",
"items": {
"type": "object",
"description": "Array of fields required as inputs to trigger the workflow, including field names, data types, and default values.",
"properties": {
"field_name": {
"type": "string",
"description": "The name of the input field expected by the workflow. This key must match the name\nprovided in the `trigger_inputs` when triggering the workflow.\n",
"examples": [
"name"
]
},
"field_data_type": {
"type": "string",
"description": "The data type expected for the input field. This indicates whether the input should\nbe a string, number, boolean, object, or array, ensuring the data is passed in the\ncorrect format.\n",
"examples": [
"string"
]
},
"default_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
}
],
"description": "The default value for the input field if one is provided. This can be a string, number,\nboolean, object, or array. If no value is provided during the trigger, the workflow may\nuse this default value.\n",
"example": ""
}
}
}
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceMetadata"
}
],
"description": "Metadata related to the workflow definition, including details about when the workflow was\ncreated, who created it, when it was last modified, and by whom. This information is useful\nfor tracking changes to the workflow over time and identifying the user or system responsible\nfor creating or modifying the workflow.\n",
"example": {
"created_at": "2024-07-01T00:00:00+02:00",
"created_by": "8ade6915-d04b-40d6-bb6f-9c6ba6aa1bb5",
"modified_at": "2024-07-01T00:00:00+02:00",
"modified_by": "Bob Smith"
}
}
},
"examples": [
{
"trigger_id": "00000000-0000-0000-0000-000000000001",
"trigger_event_type": "HTTP",
"trigger_http_config": {
"method": "POST",
"url": "http://www.example.com"
},
"trigger_input_schema": [
{
"field_name": "name",
"field_data_type": "string"
},
{
"field_name": "email",
"field_data_type": "string"
}
],
"metadata": {
"created_at": "2023-01-19T15:30:00+02:00",
"created_by": "00000000-0000-0000-0000-000000000003",
"modified_at": "2024-07-01T00:00:00+02:00",
"modified_by": "Bob Smith",
"request_id": "00000000-0000-0000-0000-000000000002",
"response_timestamp": "2024-06-20T15:30:00+02:00",
"response_duration_ms": 100
}
}
],
"x-ds-definition-name": "WorkflowTriggerRequirements"
},
"Workflow": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/UUID"
}
],
"description": "A unique ID for this workflow"
},
"name": {
"description": "A user-provided name for this workflow",
"type": "string"
},
"account_id": {
"allOf": [
{
"$ref": "#/components/schemas/UUID"
}
],
"description": "A unique ID for the account associated with the workflow"
},
"status": {
"description": "Indicates the readiness and deployment status of a workflow",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/ResourceMetadata"
}
},
"x-ds-definition-name": "Workflow"
},
"WorkflowList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workflow"
},
"description": "A list of workflows",
"x-ds-definition-name": "WorkflowList"
},
"WorkflowId": {
"$ref": "#/components/schemas/UUID",
"x-ds-definition-name": "WorkflowId"
},
"WorkflowInstance": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the workflow instance"
},
"name": {
"type": "string",
"description": "Human-readable name for the workflow instance"
},
"workflow_status": {
"type": "string",
"description": "Current status of the workflow (e.g. In Progress, Completed, Canceled)"
},
"template_id": {
"type": "string",
"format": "uuid",
"description": "Identifier linking this instance to a workflow template"
},
"account_id": {
"type": "string",
"format": "uuid",
"description": "Account under which this workflow instance was initiated"
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the workflow was started"
},
"started_by": {
"type": "string",
"format": "uuid",
"description": "User or system identifier that started this workflow"
},
"started_by_name": {
"type": "string",
"description": "Display name of the user who started this workflow"
},
"started_by_role": {
"type": "string",
"description": "Role of the user who started this workflow (e.g. Preparer)"
},
"ended_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the workflow completed",
"nullable": true
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Date and time after which the workflow expires",
"nullable": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the workflow instance was last modified"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the workflow was canceled (if applicable)",
"nullable": true
},
"canceled_by": {
"type": "string",
"description": "User or system identifier that canceled this workflow (if applicable)",
"nullable": true
},
"trigger_inputs": {
"$ref": "#/components/schemas/TriggerInputs"
},
"total_steps": {
"type": "integer",
"description": "Total number of steps configured in the workflow"
},
"last_completed_step": {
"type": "integer",
"description": "The index of the most recently completed step"
},
"last_completed_step_name": {
"type": "string",
"description": "The name of the most recently completed step",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom tags for organization or filtering"
},
"metadata": {
"type": "object",
"description": "Additional metadata related to this workflow instance",
"properties": {
"workflow_created_by": {
"type": "string",
"format": "uuid",
"description": "Identifier of the user who originally created the workflow definition"
},
"workflow_version": {
"type": "string",
"description": "Version string of the deployed workflow"
},
"workflow_metadata_id": {
"type": "string",
"description": "Identifier for workflow definition metadata in the system"
}
}
}
},
"x-ds-definition-name": "WorkflowInstance"
},
"WorkflowInstanceCollection": {
"type": "object",