API Explorer

v4.0.0 (439 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Foo Bar2

Create new Foo Bar2.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar2":{ "fooBar2Id":"ec27cb20-15ce-466d-8a58-a5d0ef6a8694", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_FooBar2 - 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_createFooBar2, operation_id: OBPv4.0.0-dynamicEntity_createFooBar2 Tags: _FooBar2, New-Style, Dynamic-Endpoint, Dynamic,

Delete Foo Bar2 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar2":{ "fooBar2Id":"868d27ae-d60e-4a89-960f-da3819bdb3a9", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_FooBar2 - 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_deleteFooBar2, operation_id: OBPv4.0.0-dynamicEntity_deleteFooBar2 Tags: _FooBar2, New-Style, Dynamic-Endpoint, Dynamic,

Get Foo Bar2 List

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

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar2?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_bar2_list":[{ "foo_bar2":{ "fooBar2Id":"58ddc31d-58c4-4030-a394-77e4712a674f", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_FooBar2 - 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_getFooBar2List, operation_id: OBPv4.0.0-dynamicEntity_getFooBar2List Tags: _FooBar2, New-Style, Dynamic-Endpoint, Dynamic,

Get Foo Bar2 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar2":{ "fooBar2Id":"c198c3e2-f8c0-4cd6-a183-8f9eafc52680", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_FooBar2 - 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_getSingleFooBar2, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar2 Tags: _FooBar2, New-Style, Dynamic-Endpoint, Dynamic,

Update Foo Bar2

Update Foo Bar2.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar2":{ "fooBar2Id":"308623f8-ec60-4f8f-b48c-8db22c8aed85", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_FooBar2 - 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_updateFooBar2, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar2 Tags: _FooBar2, New-Style, Dynamic-Endpoint, Dynamic,