openapi: 3.0.2
info:
title: ''
version: V1.0
description: |
API Details
- Component:
- Reference: export-component
- Enviroment: dev
- Version: V1.0
- Repository: [online](https://github.com/ConductionNL/export-component) / [zip](https://github.com/ConductionNL/export-component/archive/master.zip)
- Docker Image: [online]()
- Datamodel: [postman](schema/export-component.postman_collection.json) / [oas](schema/openapi.yaml) / [pdf](schema/datamodel.pdf) / [modelio (zip)](schema/Datamodel_Modelio.zip)
Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.
paths:
/audit_trails:
get:
tags:
- AuditTrail
operationId: getAuditTrailCollection
summary: 'Retrieves the collection of AuditTrail resources.'
responses:
200:
description: 'AuditTrail collection response'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/AuditTrail:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/json+ld:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/AuditTrail:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/json+hal:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/json+vnd.api:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/health+json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/json+health:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
application/x-yaml:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/AuditTrail-read'
parameters:
-
name: 'order[application]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[request]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[user]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[subject]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[resource]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[resourceType]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[endpoint]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[contentType]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[content]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[session]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateCreated]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateModified]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: request
in: query
required: false
schema:
type: string
-
name: 'request[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: user
in: query
required: false
schema:
type: string
-
name: 'user[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: subject
in: query
required: false
schema:
type: string
-
name: 'subject[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: resource
in: query
required: false
schema:
type: string
-
name: 'resource[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: resourceType
in: query
required: false
schema:
type: string
-
name: endpoint
in: query
required: false
schema:
type: string
-
name: 'endpoint[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: contentType
in: query
required: false
schema:
type: string
-
name: 'contentType[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: content
in: query
required: false
schema:
type: string
-
name: 'content[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: session
in: query
required: false
schema:
type: string
-
name: 'session[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: 'dateCreated[before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[after]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_after]'
in: query
required: false
schema:
type: string
-
name: page
in: query
required: false
description: 'The collection page number'
schema:
type: integer
default: 1
-
name: limit
in: query
required: false
description: 'The number of items per page'
schema:
type: integer
default: 30
minimum: 0
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
produces:
- application/health+json
post:
tags:
- AuditTrail
operationId: postAuditTrailCollection
summary: 'Creates a AuditTrail resource.'
responses:
201:
description: 'AuditTrail resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-read'
links:
GetAuditTrailItem:
parameters:
id: '$response.body#/id'
operationId: getAuditTrailItem
description: 'The `id` value returned in the response can be used as the `id` parameter in `GET /audit_trails/{id}`.'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-write'
description: 'The new AuditTrail resource'
parameters:
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
'/audit_trails/{id}':
get:
tags:
- AuditTrail
operationId: getAuditTrailItem
summary: 'Retrieves a AuditTrail resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'AuditTrail resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-read'
404:
description: 'Resource not found'
produces:
- application/health+json
delete:
tags:
- AuditTrail
operationId: deleteAuditTrailItem
summary: 'Removes the AuditTrail resource.'
responses:
204:
description: 'AuditTrail resource deleted'
404:
description: 'Resource not found'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
put:
tags:
- AuditTrail
operationId: putAuditTrailItem
summary: 'Replaces the AuditTrail resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
responses:
200:
description: 'AuditTrail resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-read'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-write'
description: 'The updated AuditTrail resource'
patch:
tags:
- AuditTrail
operationId: patchAuditTrailItem
summary: 'Updates the AuditTrail resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
responses:
200:
description: 'AuditTrail resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+hal:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/health+json:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/json+health:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-read'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-read'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/AuditTrail:jsonld-write'
application/json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/hal+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AuditTrail-write'
application/xml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
applications/x-yaml:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/csv:
schema:
$ref: '#/components/schemas/AuditTrail-write'
text/html:
schema:
$ref: '#/components/schemas/AuditTrail-write'
description: 'The updated AuditTrail resource'
/change_logs:
get:
tags:
- ChangeLog
operationId: getChangeLogCollection
summary: 'Retrieves the collection of ChangeLog resources.'
responses:
200:
description: 'ChangeLog collection response'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/ChangeLog:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/json+ld:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/ChangeLog:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/json+hal:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/json+vnd.api:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/health+json:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/json+health:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
application/x-yaml:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeLog-read'
parameters:
-
name: 'order[action]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[objectId]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[objectClass]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[version]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[username]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateCreated]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateModified]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: action
in: query
required: false
schema:
type: string
-
name: 'action[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: objectId
in: query
required: false
schema:
type: string
-
name: 'objectId[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: objectClass
in: query
required: false
schema:
type: string
-
name: 'objectClass[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: version
in: query
required: false
schema:
type: integer
-
name: 'version[]'
in: query
required: false
schema:
type: array
items:
type: integer
style: form
explode: true
-
name: 'dateCreated[before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[after]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_after]'
in: query
required: false
schema:
type: string
-
name: page
in: query
required: false
description: 'The collection page number'
schema:
type: integer
default: 1
-
name: limit
in: query
required: false
description: 'The number of items per page'
schema:
type: integer
default: 30
minimum: 0
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
produces:
- application/health+json
post:
tags:
- ChangeLog
operationId: postChangeLogCollection
summary: 'Creates a ChangeLog resource.'
responses:
201:
description: 'ChangeLog resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-read'
links:
GetChangeLogItem:
parameters:
id: '$response.body#/id'
operationId: getChangeLogItem
description: 'The `id` value returned in the response can be used as the `id` parameter in `GET /change_logs/{id}`.'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-write'
description: 'The new ChangeLog resource'
parameters:
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
'/change_logs/{id}':
get:
tags:
- ChangeLog
operationId: getChangeLogItem
summary: 'Retrieves a ChangeLog resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'ChangeLog resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-read'
404:
description: 'Resource not found'
produces:
- application/health+json
delete:
tags:
- ChangeLog
operationId: deleteChangeLogItem
summary: 'Removes the ChangeLog resource.'
responses:
204:
description: 'ChangeLog resource deleted'
404:
description: 'Resource not found'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
put:
tags:
- ChangeLog
operationId: putChangeLogItem
summary: 'Replaces the ChangeLog resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
responses:
200:
description: 'ChangeLog resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-read'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-write'
description: 'The updated ChangeLog resource'
patch:
tags:
- ChangeLog
operationId: patchChangeLogItem
summary: 'Updates the ChangeLog resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
responses:
200:
description: 'ChangeLog resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+hal:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/health+json:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/json+health:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-read'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-read'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/ChangeLog:jsonld-write'
application/json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/hal+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/ChangeLog-write'
application/xml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
applications/x-yaml:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/csv:
schema:
$ref: '#/components/schemas/ChangeLog-write'
text/html:
schema:
$ref: '#/components/schemas/ChangeLog-write'
description: 'The updated ChangeLog resource'
/exports:
get:
tags:
- Export
operationId: getExportCollection
summary: 'Retrieves the collection of Export resources.'
responses:
200:
description: 'Export collection response'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/Export:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/json+ld:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/Export:jsonld-read' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/Export-read'
parameters:
-
name: 'order[id]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[name]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[description]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[content]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[contentType]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateCreated]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'order[dateModified]'
in: query
required: false
schema:
type: string
enum:
- asc
- desc
-
name: 'dateCreated[before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[after]'
in: query
required: false
schema:
type: string
-
name: 'dateCreated[strictly_after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_before]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[after]'
in: query
required: false
schema:
type: string
-
name: 'dateModified[strictly_after]'
in: query
required: false
schema:
type: string
-
name: id
in: query
required: false
schema:
type: string
-
name: 'id[]'
in: query
required: false
schema:
type: array
items:
type: string
style: form
explode: true
-
name: name
in: query
required: false
schema:
type: string
-
name: description
in: query
required: false
schema:
type: string
-
name: page
in: query
required: false
description: 'The collection page number'
schema:
type: integer
default: 1
-
name: limit
in: query
required: false
description: 'The number of items per page'
schema:
type: integer
default: 30
minimum: 0
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
produces:
- application/health+json
post:
tags:
- Export
operationId: postExportCollection
summary: 'Creates a Export resource.'
responses:
201:
description: 'Export resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
links:
GetExportItem:
parameters:
id: '$response.body#/id'
operationId: getExportItem
description: 'The `id` value returned in the response can be used as the `id` parameter in `GET /exports/{id}`.'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-write'
application/json:
schema:
$ref: '#/components/schemas/Export-write'
application/health+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+health:
schema:
$ref: '#/components/schemas/Export-write'
application/xml:
schema:
$ref: '#/components/schemas/Export-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-write'
text/csv:
schema:
$ref: '#/components/schemas/Export-write'
text/html:
schema:
$ref: '#/components/schemas/Export-write'
description: 'The new Export resource'
parameters:
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
'/exports/{id}':
get:
tags:
- Export
operationId: getExportItem
summary: 'Retrieves a Export resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'Export resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
404:
description: 'Resource not found'
produces:
- application/health+json
put:
tags:
- Export
operationId: putExportItem
summary: 'Replaces the Export resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
responses:
200:
description: 'Export resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
400:
description: 'Invalid input'
404:
description: 'Resource not found'
requestBody:
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-write'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-write'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-write'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-write'
application/json:
schema:
$ref: '#/components/schemas/Export-write'
application/health+json:
schema:
$ref: '#/components/schemas/Export-write'
application/json+health:
schema:
$ref: '#/components/schemas/Export-write'
application/xml:
schema:
$ref: '#/components/schemas/Export-write'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-write'
text/csv:
schema:
$ref: '#/components/schemas/Export-write'
text/html:
schema:
$ref: '#/components/schemas/Export-write'
description: 'The updated Export resource'
delete:
tags:
- Export
operationId: deleteExportItem
summary: 'Removes the Export resource.'
responses:
204:
description: 'Export resource deleted'
404:
description: 'Resource not found'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
'/exports/{id}/audit_trail':
get:
tags:
- Export
operationId: get_audit_trailExportItem
summary: 'Retrieves a Export resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'Export resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
404:
description: 'Resource not found'
produces:
- application/health+json
'/exports/{id}/change_log':
get:
tags:
- Export
operationId: get_change_logsExportItem
summary: 'Retrieves a Export resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'Export resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
404:
description: 'Resource not found'
produces:
- application/health+json
'/exports/{id}/render':
get:
tags:
- Export
operationId: render_exportExportItem
summary: 'Retrieves a Export resource.'
parameters:
-
name: id
in: path
required: true
schema:
type: string
-
name: Authorization
description: 'The JWT of the entity performing the request'
in: header
-
name: API-Version
description: 'The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)'
example: 1.0.1
in: header
-
name: X-NLX-Logrecord-ID
description: 'A globally unique id of the request, which makes a request traceable throughout the network.'
in: header
-
name: X-NLX-Request-Process-Id
description: 'A process id for purpose registration (doelbinding)'
in: header
-
name: X-NLX-Request-Data-Elements
description: 'A list of requested data elements'
in: header
-
name: X-NLX-Request-Data-Subject
description: 'A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`'
in: header
-
name: X-NLX-Audit-Clarification
description: 'A clarification as to why a request has been made (doelbinding)'
in: header
-
name: Link
description: 'A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel="hub"'
in: header
-
name: 'extend[]'
required: false
description: 'An array of nested objects to include in the return object'
in: query
schema:
type: array
-
name: 'fields[]'
required: false
description: 'An array of fields to return in output, wil return all fields is not supplied'
in: query
schema:
type: array
-
name: validOn
required: false
description: 'Returns object as valid on a given date time'
schema:
type: string
format: date-time
in: query
-
name: validFrom
required: false
description: 'Returns objects valid from a given date time'
schema:
type: string
format: date-time
in: query
-
name: validUntil
required: false
description: 'Returns objects valid until a given date time'
schema:
type: string
format: date-time
in: query
responses:
200:
description: 'Export resource response'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/json+ld:
schema:
$ref: '#/components/schemas/Export:jsonld-read'
application/hal+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+hal:
schema:
$ref: '#/components/schemas/Export-read'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+vnd.api:
schema:
$ref: '#/components/schemas/Export-read'
application/json:
schema:
$ref: '#/components/schemas/Export-read'
application/health+json:
schema:
$ref: '#/components/schemas/Export-read'
application/json+health:
schema:
$ref: '#/components/schemas/Export-read'
application/xml:
schema:
$ref: '#/components/schemas/Export-read'
application/x-yaml:
schema:
$ref: '#/components/schemas/Export-read'
text/csv:
schema:
$ref: '#/components/schemas/Export-read'
text/html:
schema:
$ref: '#/components/schemas/Export-read'
404:
description: 'Resource not found'
produces:
- application/health+json
components:
schemas:
AuditTrail-read:
type: object
description: 'An resource representing a log line.'
properties:
id:
readOnly: true
description: 'The UUID identifier of this object'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
application:
writeOnly: true
description: 'The application that made the request'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
request:
description: 'The id of the request within that application'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
user:
description: 'The user on behalf of wich the request was made'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
subject:
description: '???'
type: string
nullable: true
process:
description: 'The procces on behalf of wich the request was made'
type: string
nullable: true
dataElements:
description: 'The moment this request was created'
type: array
items:
type: string
nullable: true
dataSubjects:
description: 'The moment this request was created'
type: array
items:
type: string
nullable: true
resource:
description: 'The resource that was requested'
type: string
nullable: true
resourceType:
description: 'The type of the resource that was requested'
type: string
nullable: true
route:
description: 'The moment this request was created'
type: string
nullable: true
endpoint:
description: 'The endpoint that the request was made to'
type: string
nullable: true
method:
description: 'The method that was used'
type: string
nullable: true
accept:
description: 'The contentType that was reqousted'
type: string
nullable: true
contentType:
description: 'The contentType that was suplieds'
type: string
nullable: true
content:
description: 'The moment this request was created'
type: string
nullable: true
ip:
description: 'The moment this request was created'
type: string
nullable: true
session:
description: 'The moment this request was created'
type: string
headers:
description: 'The headers supplied by client'
type: array
items:
type: string
statusCode:
description: 'The status code returned to client'
type: integer
nullable: true
notFound:
description: 'Whether or not the reqousted endpoint was found'
type: boolean
nullable: true
forbidden:
description: 'Whether or not the client was allowed to the reqousted endpoint'
type: boolean
nullable: true
ok:
description: 'Whether or not there where any problems'
type: boolean
nullable: true
dateCreated:
description: 'The moment this request was created'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
AuditTrail-write:
type: object
description: 'An resource representing a log line.'
'AuditTrail:jsonld-read':
type: object
description: 'An resource representing a log line.'
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
id:
readOnly: true
description: 'The UUID identifier of this object'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
application:
writeOnly: true
description: 'The application that made the request'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
request:
description: 'The id of the request within that application'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
user:
description: 'The user on behalf of wich the request was made'
externalDocs:
url: 'http://schema.org/url'
type: string
nullable: true
subject:
description: '???'
type: string
nullable: true
process:
description: 'The procces on behalf of wich the request was made'
type: string
nullable: true
dataElements:
description: 'The moment this request was created'
type: array
items:
type: string
nullable: true
dataSubjects:
description: 'The moment this request was created'
type: array
items:
type: string
nullable: true
resource:
description: 'The resource that was requested'
type: string
nullable: true
resourceType:
description: 'The type of the resource that was requested'
type: string
nullable: true
route:
description: 'The moment this request was created'
type: string
nullable: true
endpoint:
description: 'The endpoint that the request was made to'
type: string
nullable: true
method:
description: 'The method that was used'
type: string
nullable: true
accept:
description: 'The contentType that was reqousted'
type: string
nullable: true
contentType:
description: 'The contentType that was suplieds'
type: string
nullable: true
content:
description: 'The moment this request was created'
type: string
nullable: true
ip:
description: 'The moment this request was created'
type: string
nullable: true
session:
description: 'The moment this request was created'
type: string
headers:
description: 'The headers supplied by client'
type: array
items:
type: string
statusCode:
description: 'The status code returned to client'
type: integer
nullable: true
notFound:
description: 'Whether or not the reqousted endpoint was found'
type: boolean
nullable: true
forbidden:
description: 'Whether or not the client was allowed to the reqousted endpoint'
type: boolean
nullable: true
ok:
description: 'Whether or not there where any problems'
type: boolean
nullable: true
dateCreated:
description: 'The moment this request was created'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
'AuditTrail:jsonld-write':
type: object
description: 'An resource representing a log line.'
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
ChangeLog-read:
type: object
description: 'An resource representing a log line.'
properties:
id:
readOnly: true
description: 'The UUID identifier of this object'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
action:
type: string
objectId:
type: string
nullable: true
objectClass:
type: string
version:
type: integer
data:
type: array
items:
type: string
nullable: true
username:
type: string
nullable: true
session:
description: 'The moment this request was created'
type: string
nullable: true
dateCreated:
description: 'The moment this request was created'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
ChangeLog-write:
type: object
description: 'An resource representing a log line.'
'ChangeLog:jsonld-read':
type: object
description: 'An resource representing a log line.'
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
id:
readOnly: true
description: 'The UUID identifier of this object'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
action:
type: string
objectId:
type: string
nullable: true
objectClass:
type: string
version:
type: integer
data:
type: array
items:
type: string
nullable: true
username:
type: string
nullable: true
session:
description: 'The moment this request was created'
type: string
nullable: true
dateCreated:
description: 'The moment this request was created'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
externalDocs:
url: 'http://schema.org/DateTime'
type: string
format: date-time
nullable: true
'ChangeLog:jsonld-write':
type: object
description: 'An resource representing a log line.'
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
Export-read:
type: object
description: 'An export is a easey twig based way to create files from commonground resources.'
properties:
id:
readOnly: true
description: 'The UUID identifier of this resource'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
name:
description: 'The name of this menu'
type: string
description:
description: 'The description of this menuItems'
type: string
nullable: true
content:
description: 'The actual content of the export'
type: string
contentType:
description: 'the conent type of the return file'
type: string
nullable: true
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
nullable: true
required:
- name
- content
Export-write:
type: object
description: 'An export is a easey twig based way to create files from commonground resources.'
required:
- name
- content
properties:
name:
description: 'The name of this menu'
type: string
description:
description: 'The description of this menuItems'
type: string
nullable: true
content:
description: 'The actual content of the export'
type: string
contentType:
description: 'the conent type of the return file'
type: string
nullable: true
'Export:jsonld-read':
type: object
description: 'An export is a easey twig based way to create files from commonground resources.'
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
id:
readOnly: true
description: 'The UUID identifier of this resource'
externalDocs:
url: 'http://schema.org/identifier'
type: string
format: uuid
name:
description: 'The name of this menu'
type: string
description:
description: 'The description of this menuItems'
type: string
nullable: true
content:
description: 'The actual content of the export'
type: string
contentType:
description: 'the conent type of the return file'
type: string
nullable: true
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
nullable: true
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
nullable: true
required:
- name
- content
'Export:jsonld-write':
type: object
description: 'An export is a easey twig based way to create files from commonground resources.'
required:
- name
- content
properties:
'@context':
readOnly: true
type: string
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
name:
description: 'The name of this menu'
type: string
description:
description: 'The description of this menuItems'
type: string
nullable: true
content:
description: 'The actual content of the export'
type: string
contentType:
description: 'the conent type of the return file'
type: string
nullable: true
definitions:
Export-read:
properties:
id:
description: 'The UUID identifier of this resource'
type: string
example: e2984465-190a-4562-829e-a8cca81aa35d
format: uuid
name:
description: 'The name of this menu'
type: string
example: 'webshop menu'
maxLength: 255
description:
description: 'The description of this menuItems'
type: string
example: 'This menuItems links to the about page'
maxLength: 2555
content:
description: 'The actual content of the export'
type: string
example: 'This menuItems links to the about page'
maxLength: 2555
contentType:
description: 'the conent type of the return file'
type: string
example: slug
maxLength: 255
dateCreated:
description: 'The moment this request was created'
type: \Datetime
dateModified:
description: 'The moment this request last Modified'
type: \Datetime
required:
- name
- content
Export-write:
properties:
name:
description: 'The name of this menu'
type: string
example: 'webshop menu'
maxLength: 255
description:
description: 'The description of this menuItems'
type: string
example: 'This menuItems links to the about page'
maxLength: 2555
content:
description: 'The actual content of the export'
type: string
example: 'This menuItems links to the about page'
maxLength: 2555
contentType:
description: 'the conent type of the return file'
type: string
example: slug
maxLength: 255
required:
- name
- content
AuditTrail-read:
properties:
id:
description: 'The UUID identifier of this object'
type: string
example: e2984465-190a-4562-829e-a8cca81aa35d
format: uuid
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line looks suspicius'
maxLength: 2555
application:
description: 'The application that made the request'
type: string
format: url
maxLength: 255
request:
description: 'The id of the request within that application'
type: string
format: url
maxLength: 255
user:
description: 'The user on behalf of wich the request was made'
type: string
format: url
maxLength: 255
subject:
description: '???'
type: string
maxLength: 255
process:
description: 'The procces on behalf of wich the request was made'
type: string
maxLength: 255
dataElements:
description: 'The moment this request was created'
type: array
dataSubjects:
description: 'The moment this request was created'
type: array
resource:
description: 'The resource that was requested'
type: string
maxLength: 255
resourceType:
description: 'The type of the resource that was requested'
type: string
maxLength: 255
route:
description: 'The moment this request was created'
type: string
maxLength: 255
endpoint:
description: 'The endpoint that the request was made to'
type: string
maxLength: 255
method:
description: 'The method that was used'
type: string
maxLength: 255
accept:
description: 'The contentType that was reqousted'
type: string
maxLength: 255
contentType:
description: 'The contentType that was suplieds'
type: string
maxLength: 255
content:
description: 'The moment this request was created'
type: string
maxLength: 2555
ip:
description: 'The moment this request was created'
type: string
maxLength: 255
session:
description: 'The moment this request was created'
type: string
maxLength: 255
headers:
description: 'The headers supplied by client'
type: array
statusCode:
description: 'The status code returned to client'
type: int
example: '200'
notFound:
description: 'Whether or not the reqousted endpoint was found'
type: bool
example: 'false'
forbidden:
description: 'Whether or not the client was allowed to the reqousted endpoint'
type: bool
example: 'false'
ok:
description: 'Whether or not there where any problems'
type: bool
example: 'true'
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
example: '2021-02-19 14:36:43'
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
example: '2021-02-19 14:36:43'
required: []
AuditTrail-write:
properties:
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line looks suspicius'
maxLength: 2555
required: []
ChangeLog-read:
properties:
id:
description: 'The UUID identifier of this object'
type: string
example: e2984465-190a-4562-829e-a8cca81aa35d
format: uuid
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
action:
description: ''
type: string
objectId:
description: ''
type: string
objectClass:
description: ''
type: string
version:
description: ''
type: int
data:
description: ''
type: array
username:
description: ''
type: string
session:
description: 'The moment this request was created'
type: string
maxLength: 255
dateCreated:
description: 'The moment this request was created'
type: string
format: date-time
example: '2021-02-19 14:36:43'
dateModified:
description: 'The moment this request last Modified'
type: string
format: date-time
example: '2021-02-19 14:36:43'
required: []
ChangeLog-write:
properties:
note:
description: 'A note conserning this log lin'
type: string
example: 'This log line is suspicius'
maxLength: 2555
required: []
tags:
-
name: Export
description: |
An export is a easey twig based way to create files from commonground resources.
-
name: AuditTrail
description: |
An resource representing a log line.
This entity represents a product that can be ordered via the OrderRegistratieComponent.
-
name: ChangeLog
description: |
An resource representing a log line.
This entity represents a product that can be ordered via the OrderRegistratieComponent.
securityDefinitions:
JWT-Oauth:
type: oauth2
authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
flow: implicit
scopes:
read: 'read right to the ChangeLog resource'
write: 'write right to the ChangeLog resource'
JWT-Token:
type: apiKey
in: header
name: Authorization
scopes:
read: 'read right to the ChangeLog resource'
write: 'write right to the ChangeLog resource'
host: irc.zaakonline.nl
servers:
-
name: zuid-drecht.nl
url: export-component.dev.zuid-drecht.nl
externalDocs:
-
description: 'OAS Documentatie'
url: 'http://proto.demo.common-ground.dev'
x-commonground:
type: service
developers:
-
name: Conduction
url: 'https://github.com/ConductionNL'
email: info@conduction.nl
-
name: 'Gemeente "s-Hertogenbosch'
url: 'https://github.com/gemeenteshertogenbosch'
email: info@s-hertogenbosch.nl/
-
name: 'Gemeente Utrecht'
url: 'https://github.com/GemeenteUtrecht'
email: info@utrecht.nl
builds:
-
name: travis
logo: 'https://travis-ci.org/api-platform/core.svg?branch=master'
url: 'https://travis-ci.org/api-platform/core'
-
name: appveyor
logo: 'https://ci.appveyor.com/api/projects/status/grwuyprts3wdqx5l?svg=true'
url: 'https://ci.appveyor.com/project/dunglas/dunglasapibundle'
-
name: codecov
logo: 'https://codecov.io/gh/api-platform/core/branch/master/graph/badge.svg'
url: 'https://codecov.io/gh/api-platform/core'
-
name: SensioLabsInsight
logo: 'https://insight.sensiolabs.com/projects/92d78899-946c-4282-89a3-ac92344f9a93/mini.png'
url: 'https://insight.sensiolabs.com/projects/92d78899-946c-4282-89a3-ac92344f9a93'
-
name: 'Scrutinizer Code Quality'
logo: 'https://scrutinizer-ci.com/g/api-platform/core/badges/quality-score.png?b=master'
url: 'https://scrutinizer-ci.com/g/api-platform/core/?branch=master'