API Explorer

v4.0.0 (319 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Sustrans

Create new Sustrans.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustransId":"39cc8258-057e-4445-a613-8252d1e12e15", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanCreateDynamicEntity_sustrans - 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 createsustrans

Delete Sustrans by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustransId":"595fa54e-d16c-4ccb-a6b7-053f250eb3f8", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanDeleteDynamicEntity_sustrans - 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 deletesustrans

Get Sustrans List

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

Authentication is Mandatory

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

								
									
{ "sustrans_list":[{ "sustransId":"4c59861d-f489-4da6-b7f3-b751d4a309ae", "name":"James Brown", "number":698761728 }] }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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 getsustransList

Get Sustrans by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustransId":"65704706-c176-41dc-9e03-9a4b6dfffb9b", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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 getSinglesustrans

Update exists Sustrans

Update exists Sustrans.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "sustransId":"eeb51ec8-bc1f-4255-9136-2e469a8d21f8", "name":"James Brown", "number":698761728 }
Required Roles:
  • CanUpdateDynamicEntity_sustrans - 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 updatesustrans