@@ -3795,13 +3795,95 @@ paths:
3795
3795
$ref : ' #/components/headers/X-Is-Form-Designer'
3796
3796
Content-Language :
3797
3797
$ref : ' #/components/headers/Content-Language'
3798
+ /api/v2/registration/catalogus :
3799
+ get :
3800
+ operationId : registration_catalogus_list
3801
+ description : List the available Catalogus based on the provided API group.
3802
+ summary : List available Catalogus
3803
+ parameters :
3804
+ - in : query
3805
+ name : objects_api_group
3806
+ schema :
3807
+ type : integer
3808
+ description : The primary key of the Objects API group to use. The informatieobjecttypen
3809
+ from the Catalogi API in this group will be returned.
3810
+ - in : query
3811
+ name : registration_backend
3812
+ schema :
3813
+ enum :
3814
+ - zgw-create-zaak
3815
+ - email
3816
+ - stuf-zds-create-zaak
3817
+ - objects_api
3818
+ - microsoft-graph
3819
+ - camunda
3820
+ type : string
3821
+ title : Registration backend ID
3822
+ minLength : 1
3823
+ description : |-
3824
+ The ID of the registration backend to use.
3825
+
3826
+ * `zgw-create-zaak` - ZGW API's
3827
+ * `email` - Email registration
3828
+ * `stuf-zds-create-zaak` - StUF-ZDS
3829
+ * `objects_api` - Objects API registration
3830
+ * `microsoft-graph` - Microsoft Graph (OneDrive/SharePoint)
3831
+ * `camunda` - Camunda
3832
+ required : true
3833
+ - in : query
3834
+ name : zgw_api_group
3835
+ schema :
3836
+ type : integer
3837
+ title : ZGW API set
3838
+ description : The primary key of the ZGW API set to use. The informatieobjecttypen
3839
+ from the Catalogi API in this set will be returned.
3840
+ tags :
3841
+ - registration
3842
+ security :
3843
+ - cookieAuth : []
3844
+ responses :
3845
+ ' 200 ' :
3846
+ content :
3847
+ application/json :
3848
+ schema :
3849
+ type : array
3850
+ items :
3851
+ $ref : ' #/components/schemas/CatalogusDomain'
3852
+ description : ' '
3853
+ headers :
3854
+ X-Session-Expires-In :
3855
+ $ref : ' #/components/headers/X-Session-Expires-In'
3856
+ X-CSRFToken :
3857
+ $ref : ' #/components/headers/X-CSRFToken'
3858
+ X-Is-Form-Designer :
3859
+ $ref : ' #/components/headers/X-Is-Form-Designer'
3860
+ Content-Language :
3861
+ $ref : ' #/components/headers/Content-Language'
3798
3862
/api/v2/registration/informatieobjecttypen :
3799
3863
get :
3800
3864
operationId : registration_informatieobjecttypen_list
3801
- description : List the available InformatieObjectTypen based on the configured
3802
- registration backend and ZGW APIs services.
3865
+ description : |-
3866
+ List the available InformatieObjectTypen based on the configured registration backend and ZGW APIs services.
3867
+
3868
+ Each InformatieObjectType is uniquely identified by its 'omschrijving', 'catalogus',
3869
+ and beginning and end date. If multiple same InformatieObjectTypen exist for different dates,
3870
+ only one entry is returned.
3803
3871
summary : List available InformatieObjectTypen
3804
3872
parameters :
3873
+ - in : query
3874
+ name : catalogus_domein
3875
+ schema :
3876
+ type : string
3877
+ minLength : 1
3878
+ description : Filter informatieobjecttypen against this catalogus domein.If
3879
+ provided, the RSIN should also be present.
3880
+ - in : query
3881
+ name : catalogus_rsin
3882
+ schema :
3883
+ type : string
3884
+ minLength : 1
3885
+ description : Filter informatieobjecttypen against this catalogus RSIN.If provided,
3886
+ the RSIN should also be present.
3805
3887
- in : query
3806
3888
name : objects_api_group
3807
3889
schema :
@@ -6773,8 +6855,11 @@ components:
6773
6855
properties :
6774
6856
domein :
6775
6857
type : string
6858
+ rsin :
6859
+ type : string
6776
6860
required :
6777
6861
- domein
6862
+ - rsin
6778
6863
Category :
6779
6864
type : object
6780
6865
properties :
0 commit comments