right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v5.1.0 (505 APIs)

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

Create Bank Level Dynamic Entity

Create a Bank Level DynamicEntity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:Bank",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField1": {
    "type": "reference:Consumer",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField2": {
    "type": "reference:Customer",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField3": {
    "type": "reference:MethodRouting",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField4": {
    "type": "reference:DynamicEntity",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField5": {
    "type": "reference:TransactionRequest",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField6": {
    "type": "reference:ProductAttribute",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField7": {
    "type": "reference:AccountAttribute",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField8": {
    "type": "reference:TransactionAttribute",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField9": {
    "type": "reference:CustomerAttribute",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField10": {
    "type": "reference:AccountApplication",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField11": {
    "type": "reference:CardAttribute",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField12": {
    "type": "reference:Counterparty",
    "example": "b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6"
}

"someField13": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&branchId=55394b53-133c-443a-9036-18fd4834dd18"
}

"someField14": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&atmId=55394b53-133c-443a-9036-18fd4834dd18"
}

"someField15": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&accountId=55394b53-133c-443a-9036-18fd4834dd18"
}

"someField16": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&productCode=55394b53-133c-443a-9036-18fd4834dd18"
}

"someField17": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&cardId=55394b53-133c-443a-9036-18fd4834dd18"
}

"someField18": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&accountId=55394b53-133c-443a-9036-18fd4834dd18&transactionId=ea481fcc-bd5d-43f8-8731-b312d052927e"
}

"someField19": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=b8f9ec5a-2e21-4c4c-8fae-fa78ee3d54a6&accountId=55394b53-133c-443a-9036-18fd4834dd18&counterpartyId=ea481fcc-bd5d-43f8-8731-b312d052927e"
}

Note: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.

Respuesta Exitosa Típica: 

								
									
{
  "bankId":"gh.29.uk",
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}
Roles Requeridos:
  • CanCreateBankLevelDynamicEntity - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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 createBankLevelDynamicEntity, operation_id: OBPv4.0.0-createBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API,

Create System Level Dynamic Entity

Create a system level Dynamic Entity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
See the following list of currently available reference types and examples of how to construct key values correctly. Note: As more Dynamic Entities are created on this instance, this list will grow:

"someField0": {
    "type": "reference:Bank",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField1": {
    "type": "reference:Consumer",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField2": {
    "type": "reference:Customer",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField3": {
    "type": "reference:MethodRouting",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField4": {
    "type": "reference:DynamicEntity",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField5": {
    "type": "reference:TransactionRequest",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField6": {
    "type": "reference:ProductAttribute",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField7": {
    "type": "reference:AccountAttribute",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField8": {
    "type": "reference:TransactionAttribute",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField9": {
    "type": "reference:CustomerAttribute",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField10": {
    "type": "reference:AccountApplication",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField11": {
    "type": "reference:CardAttribute",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField12": {
    "type": "reference:Counterparty",
    "example": "83233fb7-5f4e-4430-ac01-b58a84c54da9"
}

"someField13": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&branchId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2"
}

"someField14": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&atmId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2"
}

"someField15": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&accountId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2"
}

"someField16": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&productCode=3b154f04-e895-4e0c-bc6b-79b6d28eefb2"
}

"someField17": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&cardId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2"
}

"someField18": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&accountId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2&transactionId=6659f50b-4bac-4f13-ab41-34dbb0b0f8bb"
}

"someField19": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=83233fb7-5f4e-4430-ac01-b58a84c54da9&accountId=3b154f04-e895-4e0c-bc6b-79b6d28eefb2&counterpartyId=6659f50b-4bac-4f13-ab41-34dbb0b0f8bb"
}

Note: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.

Respuesta Exitosa Típica: 

								
									
{
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}
Roles Requeridos:
  • CanCreateSystemLevelDynamicEntity - 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 createSystemDynamicEntity, operation_id: OBPv4.0.0-createSystemDynamicEntity Tags: Dynamic-Entity-Manage, API,

Delete Bank Level Dynamic Entity

Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteBankLevelDynamicEntity - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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 deleteBankLevelDynamicEntity, operation_id: OBPv4.0.0-deleteBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API,

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Respuesta Exitosa Típica:
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 deleteMyDynamicEntity, operation_id: OBPv4.0.0-deleteMyDynamicEntity Tags: Dynamic-Entity-Manage, API,

Delete System Level Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteSystemLevelDynamicEntity - 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 deleteSystemDynamicEntity, operation_id: OBPv4.0.0-deleteSystemDynamicEntity Tags: Dynamic-Entity-Manage, API,

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities for one bank.

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "dynamic_entities":[{
    "bankId":"gh.29.uk",
    "FooBar":{
      "description":"description of this entity, can be markdown text.",
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "minLength":3,
          "maxLength":20,
          "example":"James Brown",
          "description":"description of **name** field, can be markdown text."
        },
        "number":{
          "type":"integer",
          "example":698761728,
          "description":"description of **number** field, can be markdown text."
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "hasPersonalEntity":true
  }]
}
Roles Requeridos:
  • CanGetBankLevelDynamicEntities - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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 getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities Tags: Dynamic-Entity-Manage, API,

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "dynamic_entities":[{
    "bankId":"gh.29.uk",
    "FooBar":{
      "description":"description of this entity, can be markdown text.",
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "minLength":3,
          "maxLength":20,
          "example":"James Brown",
          "description":"description of **name** field, can be markdown text."
        },
        "number":{
          "type":"integer",
          "example":698761728,
          "description":"description of **number** field, can be markdown text."
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "hasPersonalEntity":true
  }]
}
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 getMyDynamicEntities, operation_id: OBPv4.0.0-getMyDynamicEntities Tags: Dynamic-Entity-Manage, API,

Get System Dynamic Entities

Get all System Dynamic Entities

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "dynamic_entities":[{
    "bankId":"gh.29.uk",
    "FooBar":{
      "description":"description of this entity, can be markdown text.",
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "minLength":3,
          "maxLength":20,
          "example":"James Brown",
          "description":"description of **name** field, can be markdown text."
        },
        "number":{
          "type":"integer",
          "example":698761728,
          "description":"description of **number** field, can be markdown text."
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "hasPersonalEntity":true
  }]
}
Roles Requeridos:
  • CanGetSystemLevelDynamicEntities - 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 getSystemDynamicEntities, operation_id: OBPv4.0.0-getSystemDynamicEntities Tags: Dynamic-Entity-Manage, API,

Update Bank Level Dynamic Entity

Update a Bank Level DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:Bank",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField1": {
    "type": "reference:Consumer",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField2": {
    "type": "reference:Customer",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField3": {
    "type": "reference:MethodRouting",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField4": {
    "type": "reference:DynamicEntity",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField5": {
    "type": "reference:TransactionRequest",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField6": {
    "type": "reference:ProductAttribute",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField7": {
    "type": "reference:AccountAttribute",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField8": {
    "type": "reference:TransactionAttribute",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField9": {
    "type": "reference:CustomerAttribute",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField10": {
    "type": "reference:AccountApplication",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField11": {
    "type": "reference:CardAttribute",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField12": {
    "type": "reference:Counterparty",
    "example": "88d265fd-b104-4a16-ae9d-5d0fc799b0a4"
}

"someField13": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&branchId=7a953b40-42df-43dd-9c3e-70b7808721fe"
}

"someField14": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&atmId=7a953b40-42df-43dd-9c3e-70b7808721fe"
}

"someField15": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&accountId=7a953b40-42df-43dd-9c3e-70b7808721fe"
}

"someField16": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&productCode=7a953b40-42df-43dd-9c3e-70b7808721fe"
}

"someField17": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&cardId=7a953b40-42df-43dd-9c3e-70b7808721fe"
}

"someField18": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&accountId=7a953b40-42df-43dd-9c3e-70b7808721fe&transactionId=d0548a5f-b44f-47f4-b54b-19040194e9e5"
}

"someField19": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=88d265fd-b104-4a16-ae9d-5d0fc799b0a4&accountId=7a953b40-42df-43dd-9c3e-70b7808721fe&counterpartyId=d0548a5f-b44f-47f4-b54b-19040194e9e5"
}
Respuesta Exitosa Típica: 

								
									
{
  "bankId":"gh.29.uk",
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}
Roles Requeridos:
  • CanUpdateBankLevelDynamicEntity - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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 updateBankLevelDynamicEntity, operation_id: OBPv4.0.0-updateBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API,

Update My Dynamic Entity

Update my DynamicEntity.

Authentication is Mandatory

Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

Current support filed types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:Bank",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField1": {
    "type": "reference:Consumer",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField2": {
    "type": "reference:Customer",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField3": {
    "type": "reference:MethodRouting",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField4": {
    "type": "reference:DynamicEntity",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField5": {
    "type": "reference:TransactionRequest",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField6": {
    "type": "reference:ProductAttribute",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField7": {
    "type": "reference:AccountAttribute",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField8": {
    "type": "reference:TransactionAttribute",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField9": {
    "type": "reference:CustomerAttribute",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField10": {
    "type": "reference:AccountApplication",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField11": {
    "type": "reference:CardAttribute",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField12": {
    "type": "reference:Counterparty",
    "example": "0be59963-6210-44d6-8846-f702b73293c0"
}

"someField13": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&branchId=8b74711e-df34-4dc0-88ac-d961a54e3e2f"
}

"someField14": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&atmId=8b74711e-df34-4dc0-88ac-d961a54e3e2f"
}

"someField15": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&accountId=8b74711e-df34-4dc0-88ac-d961a54e3e2f"
}

"someField16": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&productCode=8b74711e-df34-4dc0-88ac-d961a54e3e2f"
}

"someField17": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&cardId=8b74711e-df34-4dc0-88ac-d961a54e3e2f"
}

"someField18": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&accountId=8b74711e-df34-4dc0-88ac-d961a54e3e2f&transactionId=91e5a71e-dbe5-4eef-a764-41bb8bfd74b2"
}

"someField19": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=0be59963-6210-44d6-8846-f702b73293c0&accountId=8b74711e-df34-4dc0-88ac-d961a54e3e2f&counterpartyId=91e5a71e-dbe5-4eef-a764-41bb8bfd74b2"
}
Respuesta Exitosa Típica: 

								
									
{
  "bankId":"gh.29.uk",
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}
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-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateMyDynamicEntity, operation_id: OBPv4.0.0-updateMyDynamicEntity Tags: Dynamic-Entity-Manage, API,

Update System Level Dynamic Entity

Update a System Level Dynamic Entity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

DATE_WITH_DAY format: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:Bank",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField1": {
    "type": "reference:Consumer",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField2": {
    "type": "reference:Customer",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField3": {
    "type": "reference:MethodRouting",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField4": {
    "type": "reference:DynamicEntity",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField5": {
    "type": "reference:TransactionRequest",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField6": {
    "type": "reference:ProductAttribute",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField7": {
    "type": "reference:AccountAttribute",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField8": {
    "type": "reference:TransactionAttribute",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField9": {
    "type": "reference:CustomerAttribute",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField10": {
    "type": "reference:AccountApplication",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField11": {
    "type": "reference:CardAttribute",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField12": {
    "type": "reference:Counterparty",
    "example": "0594fa72-81cd-4fdf-9362-1afd4bd8edab"
}

"someField13": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&branchId=5f177539-1fcd-448c-8008-9b6c344d03fc"
}

"someField14": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&atmId=5f177539-1fcd-448c-8008-9b6c344d03fc"
}

"someField15": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&accountId=5f177539-1fcd-448c-8008-9b6c344d03fc"
}

"someField16": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&productCode=5f177539-1fcd-448c-8008-9b6c344d03fc"
}

"someField17": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&cardId=5f177539-1fcd-448c-8008-9b6c344d03fc"
}

"someField18": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&accountId=5f177539-1fcd-448c-8008-9b6c344d03fc&transactionId=0f8b3c64-7833-450d-99a6-16a731795ec2"
}

"someField19": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=0594fa72-81cd-4fdf-9362-1afd4bd8edab&accountId=5f177539-1fcd-448c-8008-9b6c344d03fc&counterpartyId=0f8b3c64-7833-450d-99a6-16a731795ec2"
}
Respuesta Exitosa Típica: 

								
									
{
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}
Roles Requeridos:
  • CanUpdateSystemLevelDynamicEntity - 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-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateSystemDynamicEntity, operation_id: OBPv4.0.0-updateSystemDynamicEntity Tags: Dynamic-Entity-Manage, API,