API Explorer

v4.0.0 (422 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Piano

Create new Piano.

This stores Pianos the instrument

Property List:

  • brand: This is the manufacturer field, can be markdown text.
  • age: the age.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Piano"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "piano":{ "pianoId":"6c62debe-371c-4250-a87b-b005d6d3d6d2", "brand":"Bechstein", "age":100 } }
Required Roles:
  • CanCreateDynamicEntity_Piano - 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:
Implemented in OBPv4.0.0 by dynamicEntity_createPiano, operation_id: OBPv4.0.0-dynamicEntity_createPiano

Delete Piano by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "piano":{ "pianoId":"ce00950c-ebfc-41a2-8696-c05762a338e1", "brand":"Bechstein", "age":100 } }
Required Roles:
  • CanDeleteDynamicEntity_Piano - 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:
Implemented in OBPv4.0.0 by dynamicEntity_deletePiano, operation_id: OBPv4.0.0-dynamicEntity_deletePiano

Get Piano List

Get Piano List.

This stores Pianos the instrument

Property List:

  • brand: This is the manufacturer field, can be markdown text.
  • age: the age.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Piano"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /Piano?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", "piano_list":[{ "bank-id":"gh.29.uk", "piano":{ "pianoId":"76d64b3d-1e15-4820-b47e-cd7bc131b8fc", "brand":"Bechstein", "age":100 } }] }
Required Roles:
  • CanGetDynamicEntity_Piano - 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:
Implemented in OBPv4.0.0 by dynamicEntity_getPianoList, operation_id: OBPv4.0.0-dynamicEntity_getPianoList

Get Piano by id

Get Piano by id.

This stores Pianos the instrument

Property List:

  • brand: This is the manufacturer field, can be markdown text.
  • age: the age.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Piano"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "piano":{ "pianoId":"677f863f-afcd-4933-a9b2-da683324e2ea", "brand":"Bechstein", "age":100 } }
Required Roles:
  • CanGetDynamicEntity_Piano - 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:
Implemented in OBPv4.0.0 by dynamicEntity_getSinglePiano, operation_id: OBPv4.0.0-dynamicEntity_getSinglePiano

Update Piano

Update Piano.

This stores Pianos the instrument

Property List:

  • brand: This is the manufacturer field, can be markdown text.
  • age: the age.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"Piano"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "piano":{ "pianoId":"5dd95ba0-7fc2-4408-9718-436fdef53a3f", "brand":"Bechstein", "age":100 } }
Required Roles:
  • CanUpdateDynamicEntity_Piano - 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:
Implemented in OBPv4.0.0 by dynamicEntity_updatePiano, operation_id: OBPv4.0.0-dynamicEntity_updatePiano