right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

删除WebUiProps

删除由WEB_UI_PROPS_ID指定的WebUiProps。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteWebUiProps - 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: OBPv3.1.0, function_name: by deleteWebUiProps, operation_id: OBPv3.1.0-deleteWebUiProps Tags: WebUi-Props, API, New-Style,

添加WebUiProps

添加一个WebUiProps。

身份验证是强制性的

领域解释：

  • 名称为必填字符串值
  • 值是必需的字符串值

换行符和双引号应该可以转义，例如： 

 {"name": "webui_some", "value": "this value have "line break" and double quotations."}

应该这样逃避： 

 {"name": "webui_some", "value": "this value\nhave \"line break\" and double quotations."}

插入图片示例： 

 // set width=100 and height=50 {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"} // only set height=50 {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"} // only width=20% {"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}
Typical Successful Response: 

								
									
{
  "name":"webui_api_explorer_url",
  "value":"https://apiexplorer.openbankproject.com",
  "web_ui_props_id":"some-web-ui-props-id"
}
Required Roles:
  • CanCreateWebUiProps - 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: OBPv3.1.0, function_name: by createWebUiProps, operation_id: OBPv3.1.0-createWebUiProps Tags: WebUi-Props, API, New-Style,

获取WebUiProps

获取所有WebUiProps键值，带有“ webui_”的那些props键可以存储在DB中，此端点从DB获取所有。

网址查询参数：
active：必须为布尔字符串。如果active = true，它将显示
显式（插入）+隐式（默认）method_routings的组合。

例如：
http：// localhost：8080 / obp / v3.1.0 / management / webui_props
http：// localhost：8080 / obp / v3.1.0 / management / webui_props？active = true

Typical Successful Response: 

								
									
{
  "webui_props":[{
    "name":"webui_api_explorer_url",
    "value":"https://apiexplorer.openbankproject.com",
    "web_ui_props_id":"web-ui-props-id"
  }]
}
Required Roles:
  • CanGetWebUiProps - 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: OBPv3.1.0, function_name: by getWebUiProps, operation_id: OBPv3.1.0-getWebUiProps Tags: WebUi-Props, API, New-Style,