API Explorer

v4.0.0 (404 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Dynamic Message Doc

Create a Dynamic Message Doc.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "outbound_avro_schema":"no-example-provided", "inbound_avro_schema":"no-example-provided", "adapter_implementation":"no-example-provided", "dynamic_message_doc_id":"no-example-provided", "description":"no-example-provided", "process":"obp.getBank", "outbound_topic":"no-example-provided", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29", "message_format":"no-example-provided", "example_outbound_message":{ }, "inbound_topic":"no-example-provided", "example_inbound_message":{ } }
Required Roles:
  • CanCreateDynamicMessageDoc - 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 createDynamicMessageDoc, operation_id: OBPv4.0.0-createDynamicMessageDoc Tags: Dynamic-Message-Doc-Manage, New-Style,

Delete Dynamic Message Doc

Delete a Dynamic Message Doc.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
true
Required Roles:
  • CanDeleteDynamicMessageDoc - 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 deleteDynamicMessageDoc, operation_id: OBPv4.0.0-deleteDynamicMessageDoc Tags: Dynamic-Message-Doc-Manage, New-Style,

Get Dynamic Message Doc by Id

Get a Dynamic Message Doc by DYNAMIC-MESSAGE-DOC-ID.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "outbound_avro_schema":"no-example-provided", "inbound_avro_schema":"no-example-provided", "adapter_implementation":"no-example-provided", "dynamic_message_doc_id":"no-example-provided", "description":"no-example-provided", "process":"obp.getBank", "outbound_topic":"no-example-provided", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29", "message_format":"no-example-provided", "example_outbound_message":{ }, "inbound_topic":"no-example-provided", "example_inbound_message":{ } }
Required Roles:
  • CanGetDynamicMessageDoc - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getDynamicMessageDoc, operation_id: OBPv4.0.0-getDynamicMessageDoc Tags: Dynamic-Message-Doc-Manage, New-Style,

Get all Dynamic Message Docs

Get all Dynamic Message Docs.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "dynamic-message-docs":[{ "outbound_avro_schema":"no-example-provided", "inbound_avro_schema":"no-example-provided", "adapter_implementation":"no-example-provided", "dynamic_message_doc_id":"no-example-provided", "description":"no-example-provided", "process":"obp.getBank", "outbound_topic":"no-example-provided", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29", "message_format":"no-example-provided", "example_outbound_message":{ }, "inbound_topic":"no-example-provided", "example_inbound_message":{ } }] }
Required Roles:
  • CanGetAllDynamicMessageDocs - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getAllDynamicMessageDocs, operation_id: OBPv4.0.0-getAllDynamicMessageDocs Tags: Dynamic-Message-Doc-Manage, New-Style,

Update Dynamic Message Doc

Update a Dynamic Message Doc.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "outbound_avro_schema":"no-example-provided", "inbound_avro_schema":"no-example-provided", "adapter_implementation":"no-example-provided", "dynamic_message_doc_id":"no-example-provided", "description":"no-example-provided", "process":"obp.getBank", "outbound_topic":"no-example-provided", "method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29", "message_format":"no-example-provided", "example_outbound_message":{ }, "inbound_topic":"no-example-provided", "example_inbound_message":{ } }
Required Roles:
  • CanUpdateDynamicMessageDoc - 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 updateDynamicMessageDoc, operation_id: OBPv4.0.0-updateDynamicMessageDoc Tags: Dynamic-Message-Doc-Manage, New-Style,