Gemma Architectuur (1.0)

Download OpenAPI specification:Download

VNG realisatie: info@vng.nl URL: https://vng.nl/artikelen/vng-realisatie License: EUPL 1.2 Terms of Service

An api for questinging the gemma software

Gemma is the dutch manuciaply ecosystem

Gemma

All of the Gemma architecture

Get the complete architecture model

Get the complete architecture model including all elements, relations, views, and property definitions

Responses

Response samples

200

Content type

application/json

{"id": "gemma-3.0",
"name": "GEMMA 3.0",
"version": "3.0",
"description": "Gemeentelijke Model Architectuur versie 3.0",
"organization": {"id": "vng-realisatie",
"name": "VNG Realisatie"
},
"elements": [{"id": "e1",
"name": "Zaakafhandelcomponent",
"type": "ApplicationComponent",
"documentation": "Een component voor het afhandelen van zaken binnen de gemeentelijke dienstverlening.",
"properties": {"status": "Actief",
"releaseDate": "2022-01-15"
}
},
{"id": "e2",
"name": "Zaakregistratiecomponent",
"type": "ApplicationComponent",
"documentation": "Een component voor het registreren van zaken binnen de gemeentelijke dienstverlening.",
"properties": {"status": "Actief",
"releaseDate": "2022-01-15"
}
},
{"id": "e3",
"name": "Zaaktype",
"type": "BusinessObject",
"documentation": "Een categorie van zaken met gelijke karakteristieken.",
"properties": {"status": "Actief",
"domein": "Dienstverlening"
}
},
{"id": "e4",
"name": "Burger",
"type": "BusinessActor",
"documentation": "Een natuurlijk persoon in de rol van inwoner van een gemeente.",
"properties": {"domein": "Dienstverlening"
}
}
],
"relations": [{"id": "r1",
"name": "gebruikt",
"type": "UsedBy",
"source": "e1",
"target": "e2",
"properties": {"status": "Actief"
}
},
{"id": "r2",
"name": "realiseert",
"type": "Realization",
"source": "e1",
"target": "e3",
"properties": {"status": "Actief"
}
},
{"id": "r3",
"name": "gebruikt",
"type": "UsedBy",
"source": "e4",
"target": "e1",
"properties": {"status": "Actief"
}
}
],
"views": [{"id": "v1",
"name": "Zaakgericht werken",
"viewpoint": "Application",
"documentation": "Overzicht van de componenten voor zaakgericht werken",
"properties": {"status": "Actief",
"domein": "Dienstverlening"
},
"nodes": [{"id": 1,
"identifier": "node_e1",
"elementRef": "e1",
"position": {"x": 100,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
},
{"id": 2,
"identifier": "node_e2",
"elementRef": "e2",
"position": {"x": 300,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
},
{"id": 3,
"identifier": "node_e3",
"elementRef": "e3",
"position": {"x": 100,
"y": 250,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 255,
"g": 255,
"b": 181,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
},
{"id": 4,
"identifier": "node_e4",
"elementRef": "e4",
"position": {"x": 100,
"y": 0,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 255,
"g": 213,
"b": 181,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
}
],
"connections": [{"id": "c1",
"relationRef": "r1",
"source": "1",
"target": "2",
"style": {"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"lineWidth": 1,
"lineStyle": "solid"
}
},
{"id": "c2",
"relationRef": "r2",
"source": "1",
"target": "3",
"style": {"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"lineWidth": 1,
"lineStyle": "dashed"
}
},
{"id": "c3",
"relationRef": "r3",
"source": "4",
"target": "1",
"style": {"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"lineWidth": 1,
"lineStyle": "solid"
}
}
]
}
],
"propertyDefinitions": [{"id": "pd1",
"identifier": "status",
"name": "Status",
"type": "string",
"description": "De status van het element in de architectuur",
"defaultValue": "Concept",
"applicableElements": ["ApplicationComponent",
"BusinessObject",
"BusinessActor"
]
},
{"id": "pd2",
"identifier": "releaseDate",
"name": "Release datum",
"type": "date",
"description": "De datum waarop het element is vrijgegeven",
"applicableElements": ["ApplicationComponent"
]
},
{"id": "pd3",
"identifier": "domein",
"name": "Domein",
"type": "string",
"description": "Het domein waartoe het element behoort",
"applicableElements": ["BusinessObject",
"BusinessActor"
]
}
]
}

Get all views

Get all available views

Responses

Response samples

200

Content type

application/json

{"count": 0,
"results": [{"id": "v1",
"name": "Zaakgericht werken",
"viewpoint": "Application",
"documentation": "Overzicht van de componenten voor zaakgericht werken",
"properties": {"status": "Actief",
"domein": "Dienstverlening"
},
"nodes": [{"id": 1,
"identifier": "node_e1",
"elementRef": "e1",
"position": {"x": 100,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
},
{"id": 2,
"identifier": "node_e2",
"elementRef": "e2",
"position": {"x": 300,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
}
],
"connections": [{"id": "c1",
"relationRef": "r1",
"source": "1",
"target": "2",
"style": {"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"lineWidth": 1,
"lineStyle": "solid"
}
}
]
}
]
}

Get a single view

Get a specific view by its identivier

path Parameters

id

required

string

THe id of the view requested

query Parameters

id	string The identivier of the specif view requested

Responses

Response samples

200

Content type

application/json

{"id": "v1",
"name": "Zaakgericht werken",
"viewpoint": "Application",
"documentation": "Overzicht van de componenten voor zaakgericht werken",
"properties": {"status": "Actief",
"domein": "Dienstverlening"
},
"nodes": [{"id": 1,
"identifier": "node_e1",
"elementRef": "e1",
"position": {"x": 100,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
},
{"id": 2,
"identifier": "node_e2",
"elementRef": "e2",
"position": {"x": 300,
"y": 100,
"w": 120,
"h": 60
},
"style": {"fillColor": {"r": 181,
"g": 255,
"b": 255,
"a": 255
},
"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"font": {"name": "Arial",
"size": 12
},
"color": {"r": 0,
"g": 0,
"b": 0
}
}
}
],
"connections": [{"id": "c1",
"relationRef": "r1",
"source": "1",
"target": "2",
"style": {"lineColor": {"r": 0,
"g": 0,
"b": 0,
"a": 255
},
"lineWidth": 1,
"lineStyle": "solid"
}
}
]
}

Get all elements

Get all available ArchiMate elements

Responses

Response samples

200

Content type

application/json

{"count": 0,
"results": [{"id": "e1",
"name": "Zaakafhandelcomponent",
"type": "ApplicationComponent",
"documentation": "Een component voor het afhandelen van zaken binnen de gemeentelijke dienstverlening.",
"properties": {"status": "Actief",
"releaseDate": "2022-01-15"
}
}
]
}

Get a single element

Get a specific ArchiMate element by its identifier

path Parameters

id

required

string

The id of the element requested

Responses

Response samples

200

Content type

application/json

{"id": "e1",
"name": "Zaakafhandelcomponent",
"type": "ApplicationComponent",
"documentation": "Een component voor het afhandelen van zaken binnen de gemeentelijke dienstverlening.",
"properties": {"status": "Actief",
"releaseDate": "2022-01-15"
}
}

Get all relations

Get all available ArchiMate relations

Responses

Response samples

200

Content type

application/json

{"count": 0,
"results": [{"id": "r1",
"name": "gebruikt",
"type": "UsedBy",
"source": "e1",
"target": "e2",
"identifier": "rel_gebruikt_e1_e2",
"accessType": "Read",
"properties": {"status": "Actief"
}
}
]
}

Get a single relation

Get a specific ArchiMate relation by its identifier

path Parameters

id

required

string

The id of the relation requested

Responses

Response samples

200

Content type

application/json

{"id": "r1",
"name": "gebruikt",
"type": "UsedBy",
"source": "e1",
"target": "e2",
"identifier": "rel_gebruikt_e1_e2",
"accessType": "Read",
"properties": {"status": "Actief"
}
}

Get all property definitions

Get all available property definitions

Responses

Response samples

200

Content type

application/json

{"count": 0,
"results": [{"id": "pd1",
"identifier": "status",
"name": "Status",
"type": "string",
"description": "De status van het element in de architectuur",
"defaultValue": "Concept",
"applicableElements": ["ApplicationComponent",
"BusinessObject",
"BusinessActor"
]
}
]
}

Get a single property definition

Get a specific property definition by its identifier

path Parameters

id

required

string

The id of the property definition requested

Responses

Response samples

200

Content type

application/json

{"id": "pd1",
"identifier": "status",
"name": "Status",
"type": "string",
"description": "De status van het element in de architectuur",
"defaultValue": "Concept",
"applicableElements": ["ApplicationComponent",
"BusinessObject",
"BusinessActor"
]
}

Software Catalogus

Endpoints voor de Softwarecatalogus objecten

Haal alle leveranciersorganisaties op

Geeft een lijst van alle leveranciersorganisaties terug

query Parameters

kvk-nummer	string Filter op KvK-nummer
organisatienaam	string Filter op organisatienaam

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}
]

Maak een nieuwe leveranciersorganisatie aan

Maakt een nieuwe leveranciersorganisatie aan

Request Body schema: application/json
required

id required	string Unieke identificatie voor de leveranciersorganisatie
naam required	string Naam van de leveranciersorganisatie
type	string Type organisatie (overheid, leverancier, etc.)
kvkNummer	string KvK-nummer van de leveranciersorganisatie
oidn	string Organisatie Identificatienummer (voor overheden)
moederOrganisatie	string ID van de bovenliggende organisatie
sector	string Sector waartoe de organisatie behoort
organisatietype	string Type van de organisatie
website	string <uri> Website van de organisatie
	object Adresgegevens van de organisatie
	object Contactgegevens van de organisatie
beschrijving	string Beschrijving van de organisatie
logo	string <uri> URL naar het logo van de organisatie
voorzieningen	Array of objects Lijst van voorzieningen van deze organisatie
gebruik	Array of objects Lijst van voorzieningGebruik door deze organisatie
deelnemerIn	Array of objects Lijst van organisaties waarin deze organisatie deelneemt

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}

Response samples

201

Content type

application/json

{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}

Haal een specifieke leveranciersorganisatie op

Geeft details van een specifieke leveranciersorganisatie terug

path Parameters

id

required

string

ID van de leveranciersorganisatie

Responses

Response samples

200

Content type

application/json

{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}

Werk een leveranciersorganisatie bij

Werkt een bestaande leveranciersorganisatie bij

path Parameters

id

required

string

ID van de leveranciersorganisatie

Request Body schema: application/json
required

id required	string Unieke identificatie voor de leveranciersorganisatie
naam required	string Naam van de leveranciersorganisatie
type	string Type organisatie (overheid, leverancier, etc.)
kvkNummer	string KvK-nummer van de leveranciersorganisatie
oidn	string Organisatie Identificatienummer (voor overheden)
moederOrganisatie	string ID van de bovenliggende organisatie
sector	string Sector waartoe de organisatie behoort
organisatietype	string Type van de organisatie
website	string <uri> Website van de organisatie
	object Adresgegevens van de organisatie
	object Contactgegevens van de organisatie
beschrijving	string Beschrijving van de organisatie
logo	string <uri> URL naar het logo van de organisatie
voorzieningen	Array of objects Lijst van voorzieningen van deze organisatie
gebruik	Array of objects Lijst van voorzieningGebruik door deze organisatie
deelnemerIn	Array of objects Lijst van organisaties waarin deze organisatie deelneemt

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}

Response samples

200

Content type

application/json

{"id": "string",
"naam": "string",
"type": "string",
"kvkNummer": "string",
"oidn": "string",
"moederOrganisatie": "string",
"sector": "string",
"organisatietype": "string",
"website": "http://example.com",
"adres": {"straat": "string",
"huisnummer": "string",
"postcode": "string",
"plaats": "string",
"land": "string"
},
"contactgegevens": {"telefoon": "string",
"email": "user@example.com",
"contactpersoon": "string"
},
"beschrijving": "string",
"logo": "http://example.com",
"voorzieningen": [{ }
],
"gebruik": [{ }
],
"deelnemerIn": [{ }
]
}

Verwijder een leveranciersorganisatie

Verwijdert een bestaande leveranciersorganisatie

path Parameters

id

required

string

ID van de leveranciersorganisatie

Responses

Haal alle voorzieningen op

Geeft een lijst van alle voorzieningen terug

query Parameters

naam	string Filter op naam van de voorziening
leverancier	string Filter op leverancier ID

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]

Maak een nieuwe voorziening aan

Maakt een nieuwe voorziening aan

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor de voorziening
naam required	string Naam van de voorziening
beschrijving required	string Beschrijving van de voorziening
voorzieningstypeId	string <uuid> ID van het type van de voorziening
categorie	string Categorie waartoe de voorziening behoort
functionaliteiten	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar de functionaliteiten die de voorziening biedt
doelgroep	Array of strings Items Enum: "Gemeente" "Waterschap" "Provincie" "Ministerie" "Uitvoeringsorganisatie" "Samenwerkingsverband" "Leverancier" Doelgroepen waarvoor de voorziening is bedoeld
referentieComponenten	Array of strings <uuid> [ items <uuid > ] GEMMA referentiecomponenten die de voorziening implementeert
standaarden	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar de standaarden die de voorziening ondersteunt

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Haal een specifieke voorziening op

Geeft details van een specifieke voorziening terug

path Parameters

id

required

string

ID van de voorziening

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Werk een voorziening bij

Werkt een bestaande voorziening bij

path Parameters

id

required

string

ID van de voorziening

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor de voorziening
naam required	string Naam van de voorziening
beschrijving required	string Beschrijving van de voorziening
voorzieningstypeId	string <uuid> ID van het type van de voorziening
categorie	string Categorie waartoe de voorziening behoort
functionaliteiten	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar de functionaliteiten die de voorziening biedt
doelgroep	Array of strings Items Enum: "Gemeente" "Waterschap" "Provincie" "Ministerie" "Uitvoeringsorganisatie" "Samenwerkingsverband" "Leverancier" Doelgroepen waarvoor de voorziening is bedoeld
referentieComponenten	Array of strings <uuid> [ items <uuid > ] GEMMA referentiecomponenten die de voorziening implementeert
standaarden	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar de standaarden die de voorziening ondersteunt

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"beschrijving": "string",
"voorzieningstypeId": "05be8aba-2ec8-49cc-b5b4-adead1a869c5",
"categorie": "string",
"functionaliteiten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"doelgroep": ["Gemeente"
],
"referentieComponenten": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"standaarden": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Verwijder een voorziening

Verwijdert een bestaande voorziening

path Parameters

id

required

string

ID van de voorziening

Responses

Haal alle voorzieningaanbiedingen op

Geeft een lijst van alle voorzieningaanbiedingen terug

query Parameters

voorziening	string Filter op voorziening ID
leverancier	string Filter op leverancier ID

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]

Maak een nieuwe voorzieningaanbieding aan

Maakt een nieuwe voorzieningaanbieding aan

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor het voorzieningaanbod
naam required	string Naam van het voorzieningaanbod
omschrijving required	string Beschrijving van het voorzieningaanbod
type required	Array of strings Items Enum: "Hosting" "Beheer" "(door)ontwikkeling" "Implementatie" "Migratie" "Consultancy" Type van het voorzieningaanbod
voorzieningId required	string <uuid> ID van de voorziening die wordt aangeboden
organisatieId required	string <uuid> ID van de organisatie die de voorziening aanbiedt
productpagina	string <uri> URL naar de productpagina van de leverancier
ondersteuningsmodel	string Beschrijving van het ondersteuningsmodel
licentiemodel	string Beschrijving van het licentiemodel
hostingopties	Array of strings Items Enum: "on-premises" "SaaS" "PaaS" "hybride" Beschikbare hostingopties
versies	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar specifieke versies van dit voorzieningaanbod

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Haal een specifieke voorzieningaanbieding op

Geeft details van een specifieke voorzieningaanbieding terug

path Parameters

id

required

string

ID van de voorzieningaanbieding

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Werk een voorzieningaanbieding bij

Werkt een bestaande voorzieningaanbieding bij

path Parameters

id

required

string

ID van de voorzieningaanbieding

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor het voorzieningaanbod
naam required	string Naam van het voorzieningaanbod
omschrijving required	string Beschrijving van het voorzieningaanbod
type required	Array of strings Items Enum: "Hosting" "Beheer" "(door)ontwikkeling" "Implementatie" "Migratie" "Consultancy" Type van het voorzieningaanbod
voorzieningId required	string <uuid> ID van de voorziening die wordt aangeboden
organisatieId required	string <uuid> ID van de organisatie die de voorziening aanbiedt
productpagina	string <uri> URL naar de productpagina van de leverancier
ondersteuningsmodel	string Beschrijving van het ondersteuningsmodel
licentiemodel	string Beschrijving van het licentiemodel
hostingopties	Array of strings Items Enum: "on-premises" "SaaS" "PaaS" "hybride" Beschikbare hostingopties
versies	Array of strings <uuid> [ items <uuid > ] Array van UUID's die verwijzen naar specifieke versies van dit voorzieningaanbod

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"naam": "string",
"omschrijving": "string",
"type": ["Hosting"
],
"voorzieningId": "cb58f286-e3d1-41f1-b805-b6e58ed9041b",
"organisatieId": "d736ec7a-143a-4869-ae9b-79213407e7ca",
"productpagina": "http://example.com",
"ondersteuningsmodel": "string",
"licentiemodel": "string",
"hostingopties": ["on-premises"
],
"versies": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Verwijder een voorzieningaanbieding

Verwijdert een bestaande voorzieningaanbieding

path Parameters

id

required

string

ID van de voorzieningaanbieding

Responses

Haal alle voorzieningversies op

Geeft een lijst van alle voorzieningversies terug

query Parameters

voorzieningaanbieding	string Filter op voorzieningaanbieding ID
versienummer	string Filter op versienummer

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}
]

Maak een nieuwe voorzieningversie aan

Maakt een nieuwe voorzieningversie aan

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor de voorzieningversie
voorzieningaanbodId required	string <uuid> ID van het voorzieningaanbod
omschrijving required	string Beschrijving van deze specifieke versie en de belangrijkste kenmerken
naam required	string Naam van de versie zoals deze door de leverancier wordt gebruikt
nummer required	string Versienummer van de voorziening volgens Semantic Versioning standaard
releaseNotes	string Release notes voor deze versie
productieDatum required	string <date> Datum waarop deze versie is uitgebracht
eindeDatum	string <date> Datum waarop de ondersteuning voor deze versie eindigt
status required	string Enum: "ontwikkeling" "actief" "onderhoud" "einde-ondersteuning" Status van deze versie

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}

Haal een specifieke voorzieningversie op

Geeft details van een specifieke voorzieningversie terug

path Parameters

id

required

string

ID van de voorzieningversie

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}

Werk een voorzieningversie bij

Werkt een bestaande voorzieningversie bij

path Parameters

id

required

string

ID van de voorzieningversie

Request Body schema: application/json
required

id required	string <uuid> Unieke identificatie voor de voorzieningversie
voorzieningaanbodId required	string <uuid> ID van het voorzieningaanbod
omschrijving required	string Beschrijving van deze specifieke versie en de belangrijkste kenmerken
naam required	string Naam van de versie zoals deze door de leverancier wordt gebruikt
nummer required	string Versienummer van de voorziening volgens Semantic Versioning standaard
releaseNotes	string Release notes voor deze versie
productieDatum required	string <date> Datum waarop deze versie is uitgebracht
eindeDatum	string <date> Datum waarop de ondersteuning voor deze versie eindigt
status required	string Enum: "ontwikkeling" "actief" "onderhoud" "einde-ondersteuning" Status van deze versie

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"voorzieningaanbodId": "e6202572-c435-4118-8402-4480af2e3b5d",
"omschrijving": "string",
"naam": "string",
"nummer": "string",
"releaseNotes": "string",
"productieDatum": "2019-08-24",
"eindeDatum": "2019-08-24",
"status": "ontwikkeling"
}

Verwijder een voorzieningversie

Verwijdert een bestaande voorzieningversie

path Parameters

id

required

string

ID van de voorzieningversie

Responses

Haal alle kwetsbaarheden op

Geeft een lijst van alle kwetsbaarheden terug

query Parameters

voorzieningversie	string Filter op voorzieningversie ID
cve	string Filter op CVE-nummer
ernst	string Enum: "laag" "gemiddeld" "hoog" "kritiek" Filter op ernst

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}
]

Maak een nieuwe kwetsbaarheid aan

Maakt een nieuwe kwetsbaarheid aan

Request Body schema: application/json
required

id required	string Unieke identificatie voor de kwetsbaarheid
voorzieningversieId required	string ID van de voorzieningversie waarin de kwetsbaarheid is gevonden
cveNummer	string CVE-nummer van de kwetsbaarheid
titel required	string Titel van de kwetsbaarheid
beschrijving	string Beschrijving van de kwetsbaarheid
ernst required	string Enum: "laag" "gemiddeld" "hoog" "kritiek" Ernst van de kwetsbaarheid
ontdektOp	string <date> Datum waarop de kwetsbaarheid is ontdekt
gepubliceerdOp	string <date> Datum waarop de kwetsbaarheid is gepubliceerd
opgelostIn	string Versie waarin de kwetsbaarheid is opgelost
mitigatie	string Beschrijving van mogelijke mitigatiemaatregelen
referenties	Array of strings <uri> [ items <uri > ] Referenties naar meer informatie over de kwetsbaarheid

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}

Response samples

201

Content type

application/json

{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}

Haal een specifieke kwetsbaarheid op

Geeft details van een specifieke kwetsbaarheid terug

path Parameters

id

required

string

ID van de kwetsbaarheid

Responses

Response samples

200

Content type

application/json

{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}

Werk een kwetsbaarheid bij

Werkt een bestaande kwetsbaarheid bij

path Parameters

id

required

string

ID van de kwetsbaarheid

Request Body schema: application/json
required

id required	string Unieke identificatie voor de kwetsbaarheid
voorzieningversieId required	string ID van de voorzieningversie waarin de kwetsbaarheid is gevonden
cveNummer	string CVE-nummer van de kwetsbaarheid
titel required	string Titel van de kwetsbaarheid
beschrijving	string Beschrijving van de kwetsbaarheid
ernst required	string Enum: "laag" "gemiddeld" "hoog" "kritiek" Ernst van de kwetsbaarheid
ontdektOp	string <date> Datum waarop de kwetsbaarheid is ontdekt
gepubliceerdOp	string <date> Datum waarop de kwetsbaarheid is gepubliceerd
opgelostIn	string Versie waarin de kwetsbaarheid is opgelost
mitigatie	string Beschrijving van mogelijke mitigatiemaatregelen
referenties	Array of strings <uri> [ items <uri > ] Referenties naar meer informatie over de kwetsbaarheid

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"voorzieningversieId": "string",
"cveNummer": "string",
"titel": "string",
"beschrijving": "string",
"ernst": "laag",
"ontdektOp": "2019-08-24",
"gepubliceerdOp": "2019-08-24",
"opgelostIn": "string",
"mitigatie": "string",
"referenties": ["http://example.com"
]
}

Verwijder een kwetsbaarheid

Verwijdert een bestaande kwetsbaarheid

path Parameters

id

required

string

ID van de kwetsbaarheid

Responses

Beheer

Haal alle gebruikers op

Geeft een lijst van alle gebruikers terug

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}
]

Maak een nieuwe gebruiker aan

Maakt een nieuwe gebruiker aan

Request Body schema: application/json
required

id required	string Unieke identificatie voor de gebruiker
username required	string Gebruikersnaam voor inloggen
email required	string <email> E-mailadres van de gebruiker
voornaam	string Voornaam van de gebruiker
achternaam	string Achternaam van de gebruiker
functie	string Functie van de gebruiker binnen de organisatie
organisatie	string Organisatie waartoe de gebruiker behoort
telefoonnummer	string Telefoonnummer van de gebruiker
rollen	Array of strings Items Enum: "admin" "editor" "viewer" Rollen die de gebruiker heeft in het systeem
actief	boolean Default: true Geeft aan of het gebruikersaccount actief is
laatsteInlogdatum	string <date-time> Datum en tijd van de laatste inlog
aanmaakdatum	string <date-time> Datum en tijd waarop het account is aangemaakt
wijzigingsdatum	string <date-time> Datum en tijd van de laatste wijziging aan het account
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}

Response samples

201

Content type

application/json

{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}

Haal een specifieke gebruiker op

Geeft details van een specifieke gebruiker terug

path Parameters

id

required

string

ID van de gebruiker

Responses

Response samples

200

Content type

application/json

{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}

Werk een gebruiker bij

Werkt een bestaande gebruiker bij

path Parameters

id

required

string

ID van de gebruiker

Request Body schema: application/json
required

id required	string Unieke identificatie voor de gebruiker
username required	string Gebruikersnaam voor inloggen
email required	string <email> E-mailadres van de gebruiker
voornaam	string Voornaam van de gebruiker
achternaam	string Achternaam van de gebruiker
functie	string Functie van de gebruiker binnen de organisatie
organisatie	string Organisatie waartoe de gebruiker behoort
telefoonnummer	string Telefoonnummer van de gebruiker
rollen	Array of strings Items Enum: "admin" "editor" "viewer" Rollen die de gebruiker heeft in het systeem
actief	boolean Default: true Geeft aan of het gebruikersaccount actief is
laatsteInlogdatum	string <date-time> Datum en tijd van de laatste inlog
aanmaakdatum	string <date-time> Datum en tijd waarop het account is aangemaakt
wijzigingsdatum	string <date-time> Datum en tijd van de laatste wijziging aan het account
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"username": "string",
"email": "user@example.com",
"voornaam": "string",
"achternaam": "string",
"functie": "string",
"organisatie": "string",
"telefoonnummer": "string",
"rollen": ["admin"
],
"actief": true,
"laatsteInlogdatum": "2019-08-24T14:15:22Z",
"aanmaakdatum": "2019-08-24T14:15:22Z",
"wijzigingsdatum": "2019-08-24T14:15:22Z",
"voorkeuren": {"taal": "nl",
"thema": "licht"
}
}

Verwijder een gebruiker

Verwijdert een bestaande gebruiker

path Parameters

id

required

string

ID van de gebruiker

Gemma Architectuur (1.0)

Gemma

Get the complete architecture model

Responses

Response samples

Get all views

Responses

Response samples

Get a single view

path Parameters

query Parameters

Responses

Response samples

Get all elements

Responses

Response samples

Get a single element

path Parameters

Responses

Response samples

Get all relations

Responses

Response samples

Get a single relation

path Parameters

Responses

Response samples

Get all property definitions

Responses

Response samples

Get a single property definition

path Parameters

Responses

Response samples

Software Catalogus

Haal alle leveranciersorganisaties op

query Parameters

Responses

Response samples

Maak een nieuwe leveranciersorganisatie aan

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Haal een specifieke leveranciersorganisatie op

path Parameters

Responses

Response samples

Werk een leveranciersorganisatie bij

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verwijder een leveranciersorganisatie

path Parameters

Responses

Haal alle voorzieningen op

query Parameters

Responses

Response samples

Maak een nieuwe voorziening aan

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Haal een specifieke voorziening op

path Parameters

Responses

Response samples

Werk een voorziening bij

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verwijder een voorziening

path Parameters

Responses

Haal alle voorzieningaanbiedingen op

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required