-
JSON Schema Validation
-
JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applyingMore...
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
v5.1.0 filtered by tag: JSON-Schema-Validation (6 APIs)
Create a JSON Schema Validation
Create a JSON Schema Validation.
Please supply a json-schema as request body.
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON request body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
maxLength: maxLength
minLength: minLength
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
JSON response body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
json_schema: json_schema
maxLength: maxLength
minLength: minLength
operation_id: OBPv4.0.0-getBanks
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
{
"operation_id":"OBPv4.0.0-createXxx",
"json_schema":{
"$schema":"http://json-schema.org/draft-07/schema",
"description":"The demo json-schema",
"title":"The demo schema",
"required":["xxx_id"],
"type":"object",
"properties":{
"xxx_id":{
"type":"string",
"minLength":2,
"maxLength":50,
"examples":["xxx_id_demo_value"]
}
},
"additionalProperties":true
}
}
-
CanCreateJsonSchemaValidation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete a JSON Schema Validation
Delete a JSON Schema Validation by operation_id.
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
true
-
CanDeleteJsonSchemaValidation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get a JSON Schema Validation
Get a JSON Schema Validation by operation_id.
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
json_schema: json_schema
maxLength: maxLength
minLength: minLength
operation_id: OBPv4.0.0-getBanks
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
{
"operation_id":"OBPv4.0.0-createXxx",
"json_schema":{
"$schema":"http://json-schema.org/draft-07/schema",
"description":"The demo json-schema",
"title":"The demo schema",
"required":["xxx_id"],
"type":"object",
"properties":{
"xxx_id":{
"type":"string",
"minLength":2,
"maxLength":50,
"examples":["xxx_id_demo_value"]
}
},
"additionalProperties":true
}
}
-
CanGetJsonSchemaValidation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get all JSON Schema Validations
Get all JSON Schema Validations.
Authentication is Mandatory
JSON response body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
json_schema: json_schema
maxLength: maxLength
minLength: minLength
operation_id: OBPv4.0.0-getBanks
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
{
"json_schema_validations":[{
"operation_id":"OBPv4.0.0-createXxx",
"json_schema":{
"$schema":"http://json-schema.org/draft-07/schema",
"description":"The demo json-schema",
"title":"The demo schema",
"required":["xxx_id"],
"type":"object",
"properties":{
"xxx_id":{
"type":"string",
"minLength":2,
"maxLength":50,
"examples":["xxx_id_demo_value"]
}
},
"additionalProperties":true
}
}]
}
-
CanGetJsonSchemaValidation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get all JSON Schema Validations - public
Get all JSON Schema Validations - public.
Authentication is Optional
JSON response body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
json_schema: json_schema
maxLength: maxLength
minLength: minLength
operation_id: OBPv4.0.0-getBanks
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
{
"json_schema_validations":[{
"operation_id":"OBPv4.0.0-createXxx",
"json_schema":{
"$schema":"http://json-schema.org/draft-07/schema",
"description":"The demo json-schema",
"title":"The demo schema",
"required":["xxx_id"],
"type":"object",
"properties":{
"xxx_id":{
"type":"string",
"minLength":2,
"maxLength":50,
"examples":["xxx_id_demo_value"]
}
},
"additionalProperties":true
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update a JSON Schema Validation
Update a JSON Schema Validation.
Please supply a json-schema as request body
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
$schema: $schema
additionalProperties: additionalProperties
description: This an optional field. Maximum length is 2000. It can be any characters here.
examples: examples
json_schema: json_schema
maxLength: maxLength
minLength: minLength
operation_id: OBPv4.0.0-getBanks
properties: properties
required: required
title: Dr.
type:
xxx_id: xxx_id
{
"operation_id":"OBPv4.0.0-createXxx",
"json_schema":{
"$schema":"http://json-schema.org/draft-07/schema",
"description":"The demo json-schema",
"title":"The demo schema",
"required":["xxx_id"],
"type":"object",
"properties":{
"xxx_id":{
"type":"string",
"minLength":2,
"maxLength":50,
"examples":["xxx_id_demo_value"]
}
},
"additionalProperties":true
}
}
-
CanUpdateJsonSchemaValidation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.