v5.1.0 filtered by tag: _Test1 (5 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Create new Test1
Create new Test1.
Description of this entity, can be markdown text.
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
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
Typical Successful Response:
{
"test1":{
"test1Id":"76e41d06-1c25-4434-9d92-643161bb39aa",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanCreateDynamicEntity_Systemtest1
- 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: OBPv4.0.0,
function_name: by dynamicEntity_createtest1_, operation_id: OBPv4.0.0-dynamicEntity_createtest1_
Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,
Delete Test1 by id
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
Typical Successful Response:
{
"test1":{
"test1Id":"9487202f-cc32-408f-bdbd-feab4ac6c86c",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanDeleteDynamicEntity_Systemtest1
- 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: OBPv4.0.0,
function_name: by dynamicEntity_deletetest1_, operation_id: OBPv4.0.0-dynamicEntity_deletetest1_
Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,
Get Test1 List
Get Test1 List.
Description of this entity, can be markdown text.
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
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)
Typical Successful Response:
{
"test1_list":[{
"test1":{
"test1Id":"aee05ec4-ee24-4a0b-9428-30b343f4a391",
"name":"James Brown",
"number":698761728
}
}]
}
Required Roles:
-
CanGetDynamicEntity_Systemtest1
- 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: OBPv4.0.0,
function_name: by dynamicEntity_gettest1List_, operation_id: OBPv4.0.0-dynamicEntity_gettest1List_
Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,
Get Test1 by id
Get Test1 by id.
Description of this entity, can be markdown text.
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
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
Typical Successful Response:
{
"test1":{
"test1Id":"3542565e-6831-48bb-b8e8-483e3fd9b888",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanGetDynamicEntity_Systemtest1
- 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: OBPv4.0.0,
function_name: by dynamicEntity_getSingletest1_, operation_id: OBPv4.0.0-dynamicEntity_getSingletest1_
Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,
Update Test1
Update Test1.
Description of this entity, can be markdown text.
Property List:
- name: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
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
Typical Successful Response:
{
"test1":{
"test1Id":"45155fc5-c69c-4b69-9fb8-ccfd3ad05c4b",
"name":"James Brown",
"number":698761728
}
}
Required Roles:
-
CanUpdateDynamicEntity_Systemtest1
- 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: OBPv4.0.0,
function_name: by dynamicEntity_updatetest1_, operation_id: OBPv4.0.0-dynamicEntity_updatetest1_
Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,