Summary
Validate JSON data with schema.
Description
Perform a JSON Schema validation.
Route
No Northbound API Available
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| jsonData |
object |
yes |
JSON data to validate |
| schema |
object |
yes |
JSON schema used for validation |
Copied to Clipboard
{
"schema": {
"$id": "example",
"type": "object",
"properties": {
"exampleId": {
"type": "string"
},
"type": "object",
"description": "Description example."
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"jsonData": {
"title": "jsonData",
"type": "object",
"properties": {}
},
"schema": {
"title": "schema",
"type": "object",
"description": "JSON schema",
"properties": {
"properties": {
"type": "object"
},
"type": {
"type": "string"
}
},
"examples": [
{
"$id": "example",
"type": "object",
"properties": {
"exampleId": {
"type": "string"
},
"type": "object",
"description": "Description example."
}
}
]
}
},
"required": [
"jsonData",
"schema"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
JSON schema validation results |
Copied to Clipboard
{
"valid": true
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"valid": {
"type": "boolean"
}
},
"examples": [
{
"valid": true
}
]
}
