{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/management/webui_props":{"get":{"tags":["WebUi-Props"],"summary":"Get WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
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://apisandbox.openbankproject.com/obp/v3.1.0/management/webui_props
https://apisandbox.openbankproject.com/obp/v3.1.0/management/webui_props?active=true
Authentication is Mandatory
","operationId":"getWebUiProps","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["webui_props"],"properties":{"webui_props":{"type":"array","items":{"$ref":"#/definitions/WebUiPropsCommons"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["WebUi-Props"],"summary":"Create WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a WebUiProps.
Authentication is Mandatory
Explaination of Fields:
The line break and double quotations should do escape, example:
{"name": "webui_some", "value": "this valuehave "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="" />"}
","operationId":"createWebUiProps","parameters":[{"in":"body","name":"body","description":"WebUiPropsCommons object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/WebUiPropsCommons"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/WebUiPropsCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/webui_props/{WEB_UI_PROPS_ID}":{"delete":{"tags":["WebUi-Props"],"summary":"Delete WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.
Authentication is Mandatory
","operationId":"deleteWebUiProps","parameters":[{"in":"path","name":"WEB_UI_PROPS_ID","description":"the web ui props id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"WebUiPropsCommons":{"required":["name","value"],"properties":{"name":{"type":"string","example":"webui_api_explorer_url"},"value":{"type":"string","example":"https://apiexplorer.openbankproject.com"},"web_ui_props_id":{"type":"string"}}}}}