API Explorer

v4.0.0 (381 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create a Validation

Create a Validation.

Please supply a json-schema as request body.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "operationId":"OBPv4.0.0-createXxx", "jsonSchema":{ "$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:
  • CanCreateValidation - Please login to request this Role
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:
Implemented in OBPv4.0.0 by createValidation, operation_id: OBPv4.0.0-createValidation

Delete a Validation

Delete a Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteCanCreateValidation - Please login to request this Role
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:
Implemented in OBPv4.0.0 by deleteValidation, operation_id: OBPv4.0.0-deleteValidation

Get a Validation

Get a Validation by operation_id.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operationId":"OBPv4.0.0-createXxx", "jsonSchema":{ "$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:
  • CanGetValidation - Please login to request this Role
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:
Implemented in OBPv4.0.0 by getValidation, operation_id: OBPv4.0.0-getValidation

Get all Validations

Get all Validations.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
[{ "operationId":"OBPv4.0.0-createXxx", "jsonSchema":{ "$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:
  • CanGetValidation - Please login to request this Role
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:
Implemented in OBPv4.0.0 by getAllValidation, operation_id: OBPv4.0.0-getAllValidation

Update a Validation

Update a Validation.

Please supply a json-schema as request body

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "operationId":"OBPv4.0.0-createXxx", "jsonSchema":{ "$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:
  • CanUpdateValidation - Please login to request this Role
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:
Implemented in OBPv4.0.0 by updateValidation, operation_id: OBPv4.0.0-updateValidation