API Explorer

v4.0.0 (329 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Foo Bar

Create new Foo Bar.

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":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fooBarId":"b1f9fd58-3b76-4113-99d9-2997bb90c85d", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanCreateDynamicEntity_FooBar - Please login to request this Role
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.
Implemented in OBPv4.0.0 by createFooBar

Delete Foo Bar by id

Delete Foo Bar 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":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fooBarId":"cbeac4a9-068e-48a6-a168-cacddf68d5db", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanDeleteDynamicEntity_FooBar - Please login to request this Role
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.
Implemented in OBPv4.0.0 by deleteFooBar

Get Foo Bar List

Get Foo Bar 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":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?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:

								
									
{ "foo_bar_list":[{ "fooBarId":"a8a7b1c3-1f8a-4344-a57f-7a6b643af5c6", "name":"James Brown", "number":698761728 }] }
Required Roles:
  • CanGetDynamicEntity_FooBar - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getFooBarList

Get Foo Bar by id

Get Foo Bar 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":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fooBarId":"b0c80d85-ff3a-4857-8b7b-b31ed5611919", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanGetDynamicEntity_FooBar - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getSingleFooBar

Update exists Foo Bar

Update exists Foo Bar.

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":"FooBar"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "fooBarId":"6cb05c89-bdbb-4e42-b39d-51eed3d3da86", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanUpdateDynamicEntity_FooBar - Please login to request this Role
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.
Implemented in OBPv4.0.0 by updateFooBar