API Explorer

v4.0.0 (361 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:

								
									
{ "foo_bar":{ "fooBarId":"56b1c260-6cc4-4bd5-b07b-e235f6397442", "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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_createFooBar, operation_id: OBPv4.0.0-dynamicEntity_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:

								
									
{ "foo_bar":{ "fooBarId":"08f092aa-e03e-4d92-92f2-4331ddf306cc", "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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_deleteFooBar, operation_id: OBPv4.0.0-dynamicEntity_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":[{ "foo_bar":{ "fooBarId":"d1dd1a78-e9be-4b08-8d4e-1e649bbc58f4", "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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_getFooBarList, operation_id: OBPv4.0.0-dynamicEntity_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:

								
									
{ "foo_bar":{ "fooBarId":"d911d522-07a6-4a38-8d30-8ecfde4bf2f5", "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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_getSingleFooBar, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar

Update Foo Bar

Update 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:

								
									
{ "foo_bar":{ "fooBarId":"369eea95-8c54-4a0f-a461-6f3dd17cbc39", "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.
Connector Methods:
Implemented in OBPv4.0.0 by dynamicEntity_updateFooBar, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar