right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v1.3.0 (152 APIs)

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

Create new Test1

Create new Test1.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "test1":{
    "test1Id":"aaff8e14-a049-46e3-a169-58f2b718456b",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanCreateDynamicEntity_Systemtest1 - 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_createtest1_, operation_id: OBPv4.0.0-dynamicEntity_createtest1_ Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Delete Test1 by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "test1":{
    "test1Id":"5a70bb39-5348-4f17-a2e4-fcadfbc1ee7d",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanDeleteDynamicEntity_Systemtest1 - 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_deletetest1_, operation_id: OBPv4.0.0-dynamicEntity_deletetest1_ Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Get Test1 List

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

Authentication is Mandatory

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

								
									
{
  "test1_list":[{
    "test1":{
      "test1Id":"151bc77a-68a3-4f01-b2d1-8838d6ff7b0b",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Roles Requeridos:
  • CanGetDynamicEntity_Systemtest1 - 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_gettest1List_, operation_id: OBPv4.0.0-dynamicEntity_gettest1List_ Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Get Test1 by id

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "test1":{
    "test1Id":"18c2f4a0-7f2a-4751-94ba-df39f611f18c",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanGetDynamicEntity_Systemtest1 - 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_getSingletest1_, operation_id: OBPv4.0.0-dynamicEntity_getSingletest1_ Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,

Update Test1

Update Test1.

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "test1":{
    "test1Id":"e9ab2abd-bf4e-4fa9-b50f-4ea51474ae8c",
    "name":"James Brown",
    "number":698761728
  }
}
Roles Requeridos:
  • CanUpdateDynamicEntity_Systemtest1 - 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_updatetest1_, operation_id: OBPv4.0.0-dynamicEntity_updatetest1_ Tags: _Test1, New-Style, Dynamic-Entity, Dynamic,