API Explorer

v5.1.0 (578 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create a JSON Schema Validation

Create a JSON Schema Validation.

Introduction:

JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".

By applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.

See JSONSchema.org for more information about the JSON Schema standard.

To create a JSON Schema from an any JSON Request body you can use JSON Schema Net

(The video link below shows how to use that)

Note: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.

You can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.

PLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities

To use this endpoint, please supply a valid json-schema in the request body.

Note: It might take a few minutes for the newly created JSON Schema to take effect!

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

Typical Successful Response:

								
									
{ "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 Roles:
  • CanCreateJsonSchemaValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createJsonSchemaValidation, operation_id: OBPv4.0.0-createJsonSchemaValidation Tags: JSON-Schema-Validation,

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:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteJsonSchemaValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteJsonSchemaValidation, operation_id: OBPv4.0.0-deleteJsonSchemaValidation Tags: JSON-Schema-Validation,

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

Typical Successful Response:

								
									
{ "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 Roles:
  • CanGetJsonSchemaValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getJsonSchemaValidation, operation_id: OBPv4.0.0-getJsonSchemaValidation Tags: JSON-Schema-Validation,

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

Typical Successful Response:

								
									
{ "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 Roles:
  • CanGetJsonSchemaValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllJsonSchemaValidations, operation_id: OBPv4.0.0-getAllJsonSchemaValidations Tags: JSON-Schema-Validation,

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

Typical Successful Response:

								
									
{ "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 } }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllJsonSchemaValidationsPublic, operation_id: OBPv4.0.0-getAllJsonSchemaValidationsPublic Tags: JSON-Schema-Validation,

Update a JSON Schema Validation

Update a JSON Schema Validation.

Introduction:

JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".

By applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.

See JSONSchema.org for more information about the JSON Schema standard.

To create a JSON Schema from an any JSON Request body you can use JSON Schema Net

(The video link below shows how to use that)

Note: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.

You can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.

PLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities

To use this endpoint, please supply a valid json-schema in the 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

Typical Successful Response:

								
									
{ "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 Roles:
  • CanUpdateJsonSchemaValidation - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateJsonSchemaValidation, operation_id: OBPv4.0.0-updateJsonSchemaValidation Tags: JSON-Schema-Validation,