- SourceMeta name
- audittrail
- Base dialect
- https://json-schema.org/draft/2020-12/schema
- SourceMeta dialect
- https://json-schema.org/draft/2020-12/schema
- Bytes
- 4.089 bytes
- Bytes bundled
- 4.966 bytes
- Health
- 12%
- Dependencies
- 1
Dependencies
- At
- /properties/wijzigingen/$ref
Health issues
- Name
- top_level_title
- Message
- Set a concise non-empty title at the top level of the schema to explain what the definition is about
- Pointers
- Name
- top_level_description
- Message
- Set a non-empty description at the top level of the schema to explain what the definition is about in detail
- Pointers
- Name
- top_level_examples
- Message
- Set a non-empty examples array at the top level of the schema to illustrate the expected data
- Pointers
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/aanmaakdatum/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/actieWeergave/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/applicatieId/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/applicatieWeergave/description
- Name
- enum_with_type
- Message
- Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types
- Pointers
- /properties/bron/enum - /properties/bron/type
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/gebruikersId/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/gebruikersWeergave/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/hoofdObject/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/resource/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/resourceUrl/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/resourceWeergave/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/resultaat/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/toelichting/description
- Name
- description_trailing_period
- Message
- Descriptions should not end with a period to give user interfaces flexibility in presenting the text
- Pointers
- /properties/uuid/description
{
"$id": "https://schemas.don.projects.digilab.network/schemas/api-register/vng/besluiten-api-jaeffu6hr/audittrail",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"aanmaakdatum": {
"description": "De datum waarop de handeling is gedaan.",
"format": "date-time",
"readOnly": true,
"title": "Aanmaakdatum",
"type": "string"
},
"actie": {
"description": "De uitgevoerde handeling.\n\nDe bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan\n\nUitleg bij mogelijke waarden:\n\n* `create` - Object aangemaakt\n* `list` - Lijst van objecten opgehaald\n* `retrieve` - Object opgehaald\n* `destroy` - Object verwijderd\n* `update` - Object bijgewerkt\n* `partial_update` - Object deels bijgewerkt",
"maxLength": 50,
"minLength": 1,
"title": "Actie",
"type": "string"
},
"actieWeergave": {
"description": "Vriendelijke naam van de actie.",
"maxLength": 200,
"title": "Actie weergave",
"type": "string"
},
"applicatieId": {
"description": "Unieke identificatie van de applicatie, binnen de organisatie.",
"maxLength": 100,
"title": "Applicatie id",
"type": "string"
},
"applicatieWeergave": {
"description": "Vriendelijke naam van de applicatie.",
"maxLength": 200,
"title": "Applicatie weergave",
"type": "string"
},
"bron": {
"description": "De naam van het component waar de wijziging in is gedaan.\n\nUitleg bij mogelijke waarden:\n\n* `ac` - Autorisaties API\n* `nrc` - Notificaties API\n* `zrc` - Zaken API\n* `ztc` - Catalogi API\n* `drc` - Documenten API\n* `brc` - Besluiten API\n* `cmc` - Contactmomenten API\n* `kc` - Klanten API\n* `vrc` - Verzoeken API",
"enum": [
"ac",
"nrc",
"zrc",
"ztc",
"drc",
"brc",
"cmc",
"kc",
"vrc"
],
"title": "Bron",
"type": "string"
},
"gebruikersId": {
"description": "Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon.",
"maxLength": 255,
"title": "Gebruikers id",
"type": "string"
},
"gebruikersWeergave": {
"description": "Vriendelijke naam van de gebruiker.",
"maxLength": 255,
"title": "Gebruikers weergave",
"type": "string"
},
"hoofdObject": {
"description": "De URL naar het hoofdobject van een component.",
"format": "uri",
"maxLength": 1000,
"minLength": 1,
"title": "Hoofd object",
"type": "string"
},
"resource": {
"description": "Het type resource waarop de actie gebeurde.",
"maxLength": 50,
"minLength": 1,
"title": "Resource",
"type": "string"
},
"resourceUrl": {
"description": "De URL naar het object.",
"format": "uri",
"maxLength": 1000,
"minLength": 1,
"title": "Resource url",
"type": "string"
},
"resourceWeergave": {
"description": "Vriendelijke identificatie van het object.",
"maxLength": 200,
"minLength": 1,
"title": "Resource weergave",
"type": "string"
},
"resultaat": {
"description": "HTTP status code van de API response van de uitgevoerde handeling.",
"maximum": 599,
"minimum": 100,
"title": "Resultaat",
"type": "integer"
},
"toelichting": {
"description": "Toelichting waarom de handeling is uitgevoerd.",
"title": "Toelichting",
"type": "string"
},
"uuid": {
"description": "Unieke identificatie van de audit regel.",
"format": "uuid",
"title": "Uuid",
"type": "string"
},
"wijzigingen": {
"$ref": "./wijzigingen"
}
},
"required": [
"bron",
"actie",
"resultaat",
"hoofdObject",
"resource",
"resourceUrl",
"resourceWeergave",
"wijzigingen"
],
"type": "object",
"x-derived-from": [
"https://besluiten-api.vng.cloud/api/v1/schema/openapi.json#/components/schemas/AuditTrail"
]
}