API Explorer 935 endpoints

Update Dynamic Message Doc

PUT /obp/v7.0.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID

OBPv4.0.0-updateDynamicMessageDoc Roles: CanUpdateDynamicMessageDoc Dynamic-Message-Doc

Update a Dynamic Message Doc.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

DYNAMIC_MESSAGE_DOC_ID:

JSON response body fields (2)
description
Description of the object. Maximum length is 2000. It can be any characters here.
process
obp.getBank
Example request body
{
  "adapter_implementation": "",
  "example_inbound_message": {},
  "message_format": "",
  "programming_lang": "Scala",
  "example_outbound_message": {},
  "bank_id": "gh.29.uk",
  "inbound_avro_schema": "",
  "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",
  "outbound_topic": "",
  "inbound_topic": "",
  "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
  "process": "obp.getBank",
  "outbound_avro_schema": ""
}
Example success response
{
  "adapter_implementation": "",
  "example_inbound_message": {},
  "message_format": "",
  "programming_lang": "Scala",
  "example_outbound_message": {},
  "bank_id": "gh.29.uk",
  "dynamic_message_doc_id": "",
  "inbound_avro_schema": "",
  "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",
  "outbound_topic": "",
  "inbound_topic": "",
  "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
  "process": "obp.getBank",
  "outbound_avro_schema": ""
}
Possible errors (4)
  • 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.
Implemented by OBPv4.0.0 updateDynamicMessageDoc Originally /obp/v4.0.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID