{"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":{"/test1":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get Test1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get Test1 List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /test1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Test1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_createtest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/test1/TEST1_ID":{"delete":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Delete Test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Test1 by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_deletetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get Test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Test1 by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_getSingletest1_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Update Test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Test1.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"test1" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"dynamicEntity_updatetest1_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1Id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1Id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}}}}