API Explorer

v1 (524 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Obp Activity

Create new Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"f0fdcbd3-3056-47d1-8e55-64abe57e66d6", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanCreateDynamicEntity_ObpActivity - 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_createObpActivity, operation_id: OBPv4.0.0-dynamicEntity_createObpActivity Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,

Delete Obp Activity by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"0d305127-fc1b-4707-9deb-c36f28c754c6", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanDeleteDynamicEntity_ObpActivity - 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_deleteObpActivity, operation_id: OBPv4.0.0-dynamicEntity_deleteObpActivity Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,

Get Obp Activity List

Get Obp Activity List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /ObpActivity?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", "obp_activity_list":[{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"a2758ad9-e5b8-49bf-982e-c8f8a57b7d4d", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }] }
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getObpActivityList, operation_id: OBPv4.0.0-dynamicEntity_getObpActivityList Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,

Get Obp Activity by id

Get Obp Activity by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"e442ec85-32cf-49eb-9316-fd67270f9115", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getSingleObpActivity, operation_id: OBPv4.0.0-dynamicEntity_getSingleObpActivity Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,

Update Obp Activity

Update Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"bd51f99e-8b0d-4a0b-aa89-477bf5a16f67", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanUpdateDynamicEntity_ObpActivity - 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_updateObpActivity, operation_id: OBPv4.0.0-dynamicEntity_updateObpActivity Tags: _ObpActivity, New-Style, Dynamic-Entity, Dynamic,