right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v5.1.0 (592 APIs)

Anfitrión de la API: https://obp-apisandbox.joinfincubator.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create new Foo Bar

Create new Foo Bar.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanCreateDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_createFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_createFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Create new My Foo Bar

Create new My Foo Bar.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_createMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_createMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Delete Foo Bar by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanDeleteDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_deleteFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Delete My Foo Bar by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_deleteMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get Foo Bar List

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

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar_list":[{
    "bank-id":"gh.29.uk",
    "foo_bar":{
      "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Roles Requeridos:
  • CanGetDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getFooBarList_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getFooBarList_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get Foo Bar by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanGetDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get My Foo Bar List

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

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar_list":[{
    "bank-id":"gh.29.uk",
    "foo_bar":{
      "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyFooBarList_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getMyFooBarList_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Get My Foo Bar by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Update Foo Bar

Update Foo Bar.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanUpdateDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_updateFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,

Update My Foo Bar

Update My Foo Bar.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "bank-id":"gh.29.uk",
  "foo_bar":{
    "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanUpdateDynamicEntity_FooBar - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyFooBar_simonpublic1, operation_id: OBPv4.0.0-dynamicEntity_updateMyFooBar_simonpublic1 Tags: _Foo Bar(simonpublic1), Dynamic-Entity, Dynamic,