API Explorer

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

								
									
{ "sustrans":{ "sustransId":"700a17fb-9f46-4fd5-9430-840b7a181ec0", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_sustrans - 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_createsustrans, operation_id: OBPv4.0.0-dynamicEntity_createsustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

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:

								
									
{ "sustrans":{ "sustransId":"e6622c95-6f8c-44c7-af1f-0638f997473a", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_sustrans - 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_deletesustrans, operation_id: OBPv4.0.0-dynamicEntity_deletesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

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":[{ "sustrans":{ "sustransId":"280bd04c-4a8d-4073-8b5b-fc3e5b0c5b84", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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_getsustransList, operation_id: OBPv4.0.0-dynamicEntity_getsustransList Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

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:

								
									
{ "sustrans":{ "sustransId":"ac059a50-189d-4e9d-9a85-cbaeadfb3b6e", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_sustrans - 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_getSinglesustrans, operation_id: OBPv4.0.0-dynamicEntity_getSinglesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,

Update Sustrans

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

								
									
{ "sustrans":{ "sustransId":"71bfe85d-f8db-49dc-9540-55e23a08cc99", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_sustrans - 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_updatesustrans, operation_id: OBPv4.0.0-dynamicEntity_updatesustrans Tags: _Sustrans, New-Style, Dynamic-Entity, Dynamic,