API Explorer

v4.0.0 (531 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Fish Port

Create new Fish Port.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response

								
									
{ "fish_port":{ "fishPortId":"476e1150-c5ad-4b52-9828-ecd89954d2b3", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanCreateDynamicEntity_FishPort - 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_createFishPort_, operation_id: OBPv4.0.0-dynamicEntity_createFishPort_ Tags: _Fish Port, New-Style, Dynamic-Entity, Dynamic,

Delete Fish Port by id

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

Authentication is Mandatory

Typical Successful Response

								
									
{ "fish_port":{ "fishPortId":"d75dadfe-66b7-4d66-b46b-c1d06de1f7cb", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanDeleteDynamicEntity_FishPort - 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_deleteFishPort_, operation_id: OBPv4.0.0-dynamicEntity_deleteFishPort_ Tags: _Fish Port, New-Style, Dynamic-Entity, Dynamic,

Get Fish Port List

Get Fish Port List.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

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

								
									
{ "fish_port_list":[{ "fish_port":{ "fishPortId":"22da544c-d672-4783-bd67-2cb13d9e0cb0", "fish":"James Brown", "number":6987233228 } }] }
Required Roles:
  • CanGetDynamicEntity_FishPort - 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_getFishPortList_, operation_id: OBPv4.0.0-dynamicEntity_getFishPortList_ Tags: _Fish Port, New-Style, Dynamic-Entity, Dynamic,

Get Fish Port by id

Get Fish Port by id.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response

								
									
{ "fish_port":{ "fishPortId":"848ccc12-f0c8-4a86-a3f3-535ec13d916f", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanGetDynamicEntity_FishPort - 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_getSingleFishPort_, operation_id: OBPv4.0.0-dynamicEntity_getSingleFishPort_ Tags: _Fish Port, New-Style, Dynamic-Entity, Dynamic,

Update Fish Port

Update Fish Port.

Portfolio of fishbased values

Property List:

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

Authentication is Mandatory

Typical Successful Response

								
									
{ "fish_port":{ "fishPortId":"ae6de99f-0f30-4dd4-a33d-73b71d8057e9", "fish":"James Brown", "number":6987233228 } }
Required Roles:
  • CanUpdateDynamicEntity_FishPort - 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_updateFishPort_, operation_id: OBPv4.0.0-dynamicEntity_updateFishPort_ Tags: _Fish Port, New-Style, Dynamic-Entity, Dynamic,