-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathopenapi.yaml
9807 lines (9625 loc) · 320 KB
/
openapi.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.3
info:
title: Open Forms API
version: 2.5.0
description: |2
Open Forms provides an API to manage multi-page or multi-step forms.
It supports listing and retrieving forms, which are made up of form steps. Each form
step has a form definition driven by [FormIO.js](https://github.com/formio/formio.js/)
definitions.
Submissions of forms are supported, where each form step can be submitted individually.
Complete submissions are sent to the configured backend, which is a pluggable system
to hook into [Open Zaak](https://openzaak.org), [Camunda](https://camunda.com/) or
other systems.
Open Forms fits in the [Common Ground](https://commonground.nl) vision and architecture,
and it plays nice with other available components.
contact:
url: https://github.com/maykinmedia/open-forms
email: support@maykinmedia.nl
license:
name: UNLICENSED
paths:
/api/v2/analytics/analytics_tools_config_info:
get:
operationId: analytics_analytics_tools_config_info_retrieve
description: Haal informatie op over de analytics-tools voor de frontend.
summary: Analytics tools-configuratie
tags:
- analytics
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsToolsConfig'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/{submission_uuid}/cancel:
post:
operationId: appointments_cancel_create
summary: Cancel an appointment
parameters:
- in: path
name: submission_uuid
schema:
type: string
format: uuid
required: true
- in: header
name: X-CSRFToken
schema:
type: string
required: true
tags:
- appointments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelAppointmentInput'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CancelAppointmentInput'
multipart/form-data:
schema:
$ref: '#/components/schemas/CancelAppointmentInput'
required: true
security:
- cookieAuth: []
responses:
'204':
description: No response body
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: Unable to verify ownership of the appointment.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'502':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: Unable to cancel appointment.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/appointments:
post:
operationId: appointments_appointments_create
summary: Create an appointment
tags:
- appointments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Appointment'
required: true
security:
- cookieAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Appointment'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: Invalid submission data.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: Invalid or missing submission in session.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
5XX:
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: Unable to cancel appointment.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
parameters:
- in: header
name: X-CSRFToken
schema:
type: string
required: true
/api/v2/appointments/customer-fields:
get:
operationId: appointments_customer_fields_retrieve
description: |-
Retrieve the customer fields required for the appointment.
Note that this requires valid querystring parameters to get results. You will get
an HTTP 400 on invalid input parameters.
The required fields are returned as an array of Form.io component definitions,
with ready to use component keys, labels and relevant validators.
summary: Get required customer field details for a given product
parameters:
- in: query
name: product_id
schema:
type: array
items:
type: string
minLength: 1
description: ID of the product, repeat for multiple products.
required: true
explode: true
style: form
tags:
- appointments
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
description: Een Form.io componentdefinitie. De `type`-, `key`-
en `label`-eigenschappen zijn gegarandeerd aanwezig en niet-leeg.
properties:
type:
type: string
description: Component type
key:
type: string
description: Form field name
label:
type: string
description: Form field label
additionalProperties: {}
title: Form.io component
minLength: 1
description: Customer fields list as Form.io components.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: Invalid input parameters.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: Insufficient permissions.
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/dates:
get:
operationId: appointments_dates_list
description: |-
List all dates for a given product.
Note that you must include valid querystring parameters to get actual results. If
you don't, then an empty list is returned.
summary: List available dates for a given location and product
parameters:
- in: query
name: location_id
schema:
type: string
description: ID of the location
required: true
- in: query
name: product_id
schema:
type: array
items:
type: string
minLength: 1
description: ID of the product, repeat for multiple products.
required: true
explode: true
style: form
tags:
- appointments
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Date'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/locations:
get:
operationId: appointments_locations_list
description: |-
List all locations for a given product.
Note that you must include valid querystring parameters to get actual results. If
you don't, then an empty list is returned.
summary: List available locations for a given product
parameters:
- in: query
name: product_id
schema:
type: array
items:
type: string
minLength: 1
description: ID of the product, repeat for multiple products.
required: true
explode: true
style: form
tags:
- appointments
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Location'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/products:
get:
operationId: appointments_products_list
description: List all products a user can choose when making an appointment.
summary: List available products
parameters:
- in: query
name: product_id
schema:
type: array
items:
type: string
minLength: 1
description: ID of the product, repeat for multiple products.
explode: true
style: form
tags:
- appointments
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppointmentProduct'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/appointments/times:
get:
operationId: appointments_times_list
description: |-
List all times for a given product.
Note that you must include valid querystring parameters to get actual results. If
you don't, then an empty list is returned.
summary: List available times for a given location, product, and date
parameters:
- in: query
name: date
schema:
type: string
format: date
description: The date
required: true
- in: query
name: location_id
schema:
type: string
description: ID of the location
required: true
- in: query
name: product_id
schema:
type: array
items:
type: string
minLength: 1
description: ID of the product, repeat for multiple products.
required: true
explode: true
style: form
tags:
- appointments
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Time'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/authentication/{uuid}/session:
delete:
operationId: submission_session_destroy
description: 'Calling this endpoint will clear the current form and submission
from the session. This also clears the form authentication state and calls
the authentication plugin logout handler, if authenticated. '
summary: Delete form session
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
- in: header
name: X-CSRFToken
schema:
type: string
required: true
tags:
- authentication
security:
- cookieAuth: []
responses:
'204':
description: No response body
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/authentication/plugins:
get:
operationId: authentication_plugins_list
description: |-
List all authentication plugins that have been registered.
Each authentication plugin is tied to a particular (third-party) authentication
provider. An authentication plugin usually provides a particular authentication
attribute, such as the ``BSN`` or Chamber of Commerce number. A plugin may provide
zero, one or multiple authentication attributes.
summary: List available authentication plugins
tags:
- authentication
security:
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuthPlugin'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/categories:
get:
operationId: categories_list
tags:
- categories
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Category'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/categories/{uuid}:
get:
operationId: categories_retrieve
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- categories
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/config/privacy_policy_info:
get:
operationId: config_privacy_policy_info_retrieve
summary: Privacybeleid informatie
tags:
- config
security:
- tokenAuth: []
- cookieAuth: []
deprecated: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrivacyPolicyInfo'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/dmn/decision-definitions:
get:
operationId: dmn_decision_definitions_list
description: List the available decision definitions for a given plugin.
summary: List available decision definitions
parameters:
- in: query
name: engine
schema:
type: string
enum:
- camunda7
description: Identifier of the decision engine to query. Note that some engines
may be disabled at runtime.
required: true
tags:
- dmn
security:
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DecisionDefinition'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/dmn/decision-definitions/versions:
get:
operationId: dmn_decision_definitions_versions_list
description: |-
List the available versions of a given definition.
If the selected engine supports multiple versions of decision definitions, they can
be retrieved through this endpoint. You must specify the engine and selected
definition ID.
summary: List available decision definition versions
parameters:
- in: query
name: definition
schema:
type: string
description: Identifier of the definition to retrieve available versions for.
required: true
- in: query
name: engine
schema:
type: string
enum:
- camunda7
description: Identifier of the decision engine to query. Note that some engines
may be disabled at runtime.
required: true
tags:
- dmn
security:
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DecisionDefinitionVersion'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/dmn/decision-definitions/xml:
get:
operationId: dmn_decision_definitions_xml_retrieve
summary: Retrieve the decision definition XML
parameters:
- in: query
name: definition
schema:
type: string
description: Identifier of the definition to retrieve available versions for.
required: true
- in: query
name: engine
schema:
type: string
enum:
- camunda7
description: Identifier of the decision engine to query. Note that some engines
may be disabled at runtime.
required: true
- in: query
name: version
schema:
type: string
tags:
- dmn
security:
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionDefinitionXML'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/dmn/plugins:
get:
operationId: dmn_plugins_list
description: List all decision plugins that have been registered.
summary: List available decision plugins
tags:
- dmn
security:
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DecisionPlugin'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Exception'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/form-definitions:
get:
operationId: form_definitions_list
description: |-
Geef een lijst van bestaande formulierdefinities waarin één enkele definitie herbruikbaar of voor éénmalig gebruik kan zijn. Dit is inclusief definities die in geen enkel formulier gebruikt zijn.
Je kan deze lijst filteren op enkel herbruikbare definities of definities die in een specifiek formulier gebruikt worden.
**Merk op**: tegelijk filteren op `is_reusable` en `used_in` is geïmplementeerd als een OF-filter - je krijgt dus beide resultaten terug.
**Waarschuwing: de gegevens in het antwoord zijn afhankelijk van je gebruikersrechten**
Gebruikers die geen beheerder zijn, ontvangen maar een deel van de gedocumenteerde velden. De velden die enkel voor beheerders beschikbaar zijn, zijn voor interne formulierconfiguratie. Het gaat om de velden:
- `translations`
summary: List form step definitions
parameters:
- in: query
name: is_reusable
schema:
type: boolean
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: used_in
schema:
type: string
format: uuid
tags:
- forms
- form-definitions
security:
- tokenAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFormDefinitionList'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
post:
operationId: form_definitions_create
description: |-
**Warning: the response data depends on user permissions**
Non-staff users receive a subset of the documented fields which are used
for internal form configuration. These fields are:
- `translations`
summary: Create a form definition
tags:
- forms
- form-definitions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FormDefinition'
required: true
security:
- tokenAuth: []
- cookieAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FormDefinition'
description: ''
headers:
X-Session-Expires-In:
$ref: '#/components/headers/X-Session-Expires-In'
X-CSRFToken:
$ref: '#/components/headers/X-CSRFToken'
X-Is-Form-Designer:
$ref: '#/components/headers/X-Is-Form-Designer'
Content-Language:
$ref: '#/components/headers/Content-Language'
/api/v2/form-definitions/{uuid}:
get:
operationId: form_definitions_retrieve
description: |-
**Warning: the response data depends on user permissions**
Non-staff users receive a subset of the documented fields which are used
for internal form configuration. These fields are:
- `translations`
summary: Retrieve form step definition details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags:
- forms
- form-definitions
security: