API Explorer

v4.0.0 (490 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new D Entity1

Create new D Entity1.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"fe1109e4-65cd-4753-8f5b-a908590d6e0a", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_D-Entity1 - 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_createD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_createD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Delete D Entity1 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"1636d77d-4b0c-4af9-92cf-6b663cd415fd", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_D-Entity1 - 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_deleteD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_deleteD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Get D Entity1 List

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

Authentication is Mandatory

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

								
									
{ "bank-id":"gh.29.uk", "d-entity1_list":[{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"61d1de6c-00ee-40a7-97ac-2bb53f94c184", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_D-Entity1 - 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_getD-Entity1List, operation_id: OBPv4.0.0-dynamicEntity_getD-Entity1List Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Get D Entity1 by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"e4dbdebf-f6d3-467f-b946-2fefec7ec7ed", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_D-Entity1 - 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_getSingleD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_getSingleD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,

Update D Entity1

Update D Entity1.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "d-entity1":{ "d-Entity1Id":"c3e7230c-dd2e-4a5c-ade5-f64a3f555c8e", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_D-Entity1 - 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_updateD-Entity1, operation_id: OBPv4.0.0-dynamicEntity_updateD-Entity1 Tags: _D Entity1, New-Style, Dynamic-Entity, Dynamic,