v5.1.0 filtered by tag: WebUi-Props (3 APIs)
Create WebUiProps
Create a WebUiProps.
Authentication is Mandatory
Explaination of Fields:
- name is required String value
- value is required String value
The line break and double quotations should do escape, example:
{"name": "webui_some", "value": "this value
have "line break" and double quotations."}
should do escape like this:
{"name": "webui_some", "value": "this value\nhave \"line break\" and double quotations."}
Insert image examples:
// 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="" />"}
JSON request body fields:
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
{
"name":"webui_api_explorer_url",
"value":"https://apiexplorer.openbankproject.com",
"web_ui_props_id":"some-web-ui-props-id"
}
-
CanCreateWebUiProps
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Delete WebUiProps
Delete a WebUiProps specified by WEB_UI_PROPS_ID.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
CanDeleteWebUiProps
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get WebUiProps
Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.
url query parameter:
active: It must be a boolean string. and If active = true, it will show
combination of explicit (inserted) + implicit (default) method_routings.
eg:
https://api-explorer.ttk.com.mk/obp/v3.1.0/management/webui_props
https://api-explorer.ttk.com.mk/obp/v3.1.0/management/webui_props?active=true
Authentication is Mandatory
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
{
"webui_props":[{
"name":"webui_api_explorer_url",
"value":"https://apiexplorer.openbankproject.com",
"web_ui_props_id":"web-ui-props-id"
}]
}
-
CanGetWebUiProps
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.