API Explorer

v5.1.0 (567 APIs)

Bank
Accounts
Views
Counterparties
Transactions

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:FishPort",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField10": {
    "type": "reference:ObpActivity",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField11": {
    "type": "reference:test1",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField12": {
    "type": "reference:D-Entity1",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField13": {
    "type": "reference:Bank",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField14": {
    "type": "reference:Consumer",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField15": {
    "type": "reference:Customer",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField16": {
    "type": "reference:MethodRouting",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField17": {
    "type": "reference:DynamicEntity",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField18": {
    "type": "reference:TransactionRequest",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField19": {
    "type": "reference:ProductAttribute",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField20": {
    "type": "reference:AccountAttribute",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField21": {
    "type": "reference:TransactionAttribute",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField22": {
    "type": "reference:CustomerAttribute",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField23": {
    "type": "reference:AccountApplication",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField24": {
    "type": "reference:CardAttribute",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField25": {
    "type": "reference:Counterparty",
    "example": "d0823ea7-ad12-4dbd-aaf1-5b9258c511c9"
}

"someField26": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&branchId=17cb2cea-be39-45c3-a763-c458242f05cd"
}

"someField27": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&atmId=17cb2cea-be39-45c3-a763-c458242f05cd"
}

"someField28": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&accountId=17cb2cea-be39-45c3-a763-c458242f05cd"
}

"someField29": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&productCode=17cb2cea-be39-45c3-a763-c458242f05cd"
}

"someField30": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&cardId=17cb2cea-be39-45c3-a763-c458242f05cd"
}

"someField31": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&accountId=17cb2cea-be39-45c3-a763-c458242f05cd&transactionId=d750f398-6e49-4e42-a8e3-337c6544094b"
}

"someField32": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=d0823ea7-ad12-4dbd-aaf1-5b9258c511c9&accountId=17cb2cea-be39-45c3-a763-c458242f05cd&counterpartyId=d750f398-6e49-4e42-a8e3-337c6544094b"
}

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

Typical Successful Response

								
									
{ "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 }
Required Roles:
  • CanCreateBankLevelDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEntity, operation_id: OBPv4.0.0-createBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

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:FishPort",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField10": {
    "type": "reference:ObpActivity",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField11": {
    "type": "reference:test1",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField12": {
    "type": "reference:D-Entity1",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField13": {
    "type": "reference:Bank",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField14": {
    "type": "reference:Consumer",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField15": {
    "type": "reference:Customer",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField16": {
    "type": "reference:MethodRouting",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField17": {
    "type": "reference:DynamicEntity",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField18": {
    "type": "reference:TransactionRequest",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField19": {
    "type": "reference:ProductAttribute",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField20": {
    "type": "reference:AccountAttribute",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField21": {
    "type": "reference:TransactionAttribute",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField22": {
    "type": "reference:CustomerAttribute",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField23": {
    "type": "reference:AccountApplication",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField24": {
    "type": "reference:CardAttribute",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField25": {
    "type": "reference:Counterparty",
    "example": "9270c408-154f-4531-8e0b-a4a7754b725a"
}

"someField26": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&branchId=8c196690-bef6-465a-aa60-ded1e057f6e9"
}

"someField27": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&atmId=8c196690-bef6-465a-aa60-ded1e057f6e9"
}

"someField28": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&accountId=8c196690-bef6-465a-aa60-ded1e057f6e9"
}

"someField29": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&productCode=8c196690-bef6-465a-aa60-ded1e057f6e9"
}

"someField30": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&cardId=8c196690-bef6-465a-aa60-ded1e057f6e9"
}

"someField31": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&accountId=8c196690-bef6-465a-aa60-ded1e057f6e9&transactionId=990e9fb5-a41a-43a3-9472-6809fd2621a8"
}

"someField32": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=9270c408-154f-4531-8e0b-a4a7754b725a&accountId=8c196690-bef6-465a-aa60-ded1e057f6e9&counterpartyId=990e9fb5-a41a-43a3-9472-6809fd2621a8"
}

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

Typical Successful Response

								
									
{ "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 }
Required Roles:
  • CanCreateSystemLevelDynamicEntity - 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 createSystemDynamicEntity, operation_id: OBPv4.0.0-createSystemDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete Bank Level Dynamic Entity

Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response

								
									
Required Roles:
  • CanDeleteBankLevelDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteBankLevelDynamicEntity, operation_id: OBPv4.0.0-deleteBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete My Dynamic Entity

Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response

								
									
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteMyDynamicEntity, operation_id: OBPv4.0.0-deleteMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Delete System Level Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response

								
									
Required Roles:
  • CanDeleteSystemLevelDynamicEntity - 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 deleteSystemDynamicEntity, operation_id: OBPv4.0.0-deleteSystemDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities for one bank.

Authentication is Mandatory

Typical Successful Response

								
									
{ "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 }] }
Required Roles:
  • CanGetBankLevelDynamicEntities - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get My Dynamic Entities

Get all my Dynamic Entities.

Authentication is Mandatory

Typical Successful Response

								
									
{ "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 }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyDynamicEntities, operation_id: OBPv4.0.0-getMyDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Get System Dynamic Entities

Get all System Dynamic Entities

Authentication is Mandatory

Typical Successful Response

								
									
{ "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 }] }
Required Roles:
  • CanGetSystemLevelDynamicEntities - 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 getSystemDynamicEntities, operation_id: OBPv4.0.0-getSystemDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

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:FishPort",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField10": {
    "type": "reference:ObpActivity",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField11": {
    "type": "reference:test1",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField12": {
    "type": "reference:D-Entity1",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField13": {
    "type": "reference:Bank",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField14": {
    "type": "reference:Consumer",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField15": {
    "type": "reference:Customer",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField16": {
    "type": "reference:MethodRouting",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField17": {
    "type": "reference:DynamicEntity",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField18": {
    "type": "reference:TransactionRequest",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField19": {
    "type": "reference:ProductAttribute",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField20": {
    "type": "reference:AccountAttribute",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField21": {
    "type": "reference:TransactionAttribute",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField22": {
    "type": "reference:CustomerAttribute",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField23": {
    "type": "reference:AccountApplication",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField24": {
    "type": "reference:CardAttribute",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField25": {
    "type": "reference:Counterparty",
    "example": "ad9cc77a-c480-4909-9f60-25f30535741a"
}

"someField26": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&branchId=6e2889ef-4bad-4545-a2d1-df34f541f0b3"
}

"someField27": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&atmId=6e2889ef-4bad-4545-a2d1-df34f541f0b3"
}

"someField28": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&accountId=6e2889ef-4bad-4545-a2d1-df34f541f0b3"
}

"someField29": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&productCode=6e2889ef-4bad-4545-a2d1-df34f541f0b3"
}

"someField30": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&cardId=6e2889ef-4bad-4545-a2d1-df34f541f0b3"
}

"someField31": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&accountId=6e2889ef-4bad-4545-a2d1-df34f541f0b3&transactionId=b0b88e60-4b6f-4666-86af-54fd0907bdef"
}

"someField32": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=ad9cc77a-c480-4909-9f60-25f30535741a&accountId=6e2889ef-4bad-4545-a2d1-df34f541f0b3&counterpartyId=b0b88e60-4b6f-4666-86af-54fd0907bdef"
}

Typical Successful Response

								
									
{ "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 }
Required Roles:
  • CanUpdateBankLevelDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateBankLevelDynamicEntity, operation_id: OBPv4.0.0-updateBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

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:FishPort",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField10": {
    "type": "reference:ObpActivity",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField11": {
    "type": "reference:test1",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField12": {
    "type": "reference:D-Entity1",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField13": {
    "type": "reference:Bank",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField14": {
    "type": "reference:Consumer",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField15": {
    "type": "reference:Customer",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField16": {
    "type": "reference:MethodRouting",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField17": {
    "type": "reference:DynamicEntity",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField18": {
    "type": "reference:TransactionRequest",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField19": {
    "type": "reference:ProductAttribute",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField20": {
    "type": "reference:AccountAttribute",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField21": {
    "type": "reference:TransactionAttribute",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField22": {
    "type": "reference:CustomerAttribute",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField23": {
    "type": "reference:AccountApplication",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField24": {
    "type": "reference:CardAttribute",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField25": {
    "type": "reference:Counterparty",
    "example": "c5ff244e-9466-4609-b874-16e7c9e8f7d3"
}

"someField26": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&branchId=fc32c8e8-d8bb-4af1-9664-40edfda5372e"
}

"someField27": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&atmId=fc32c8e8-d8bb-4af1-9664-40edfda5372e"
}

"someField28": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&accountId=fc32c8e8-d8bb-4af1-9664-40edfda5372e"
}

"someField29": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&productCode=fc32c8e8-d8bb-4af1-9664-40edfda5372e"
}

"someField30": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&cardId=fc32c8e8-d8bb-4af1-9664-40edfda5372e"
}

"someField31": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&accountId=fc32c8e8-d8bb-4af1-9664-40edfda5372e&transactionId=5422e779-b661-4a6e-8c35-5ea2be78ffa5"
}

"someField32": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=c5ff244e-9466-4609-b874-16e7c9e8f7d3&accountId=fc32c8e8-d8bb-4af1-9664-40edfda5372e&counterpartyId=5422e779-b661-4a6e-8c35-5ea2be78ffa5"
}

Typical Successful Response

								
									
{ "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 }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateMyDynamicEntity, operation_id: OBPv4.0.0-updateMyDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

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:FishPort",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField5": {
    "type": "reference:customer_cars",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField6": {
    "type": "reference:MarchHare",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField7": {
    "type": "reference:InsurancePolicy",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField8": {
    "type": "reference:Odometer",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField9": {
    "type": "reference:InsurancePremium",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField10": {
    "type": "reference:ObpActivity",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField11": {
    "type": "reference:test1",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField12": {
    "type": "reference:D-Entity1",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField13": {
    "type": "reference:Bank",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField14": {
    "type": "reference:Consumer",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField15": {
    "type": "reference:Customer",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField16": {
    "type": "reference:MethodRouting",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField17": {
    "type": "reference:DynamicEntity",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField18": {
    "type": "reference:TransactionRequest",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField19": {
    "type": "reference:ProductAttribute",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField20": {
    "type": "reference:AccountAttribute",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField21": {
    "type": "reference:TransactionAttribute",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField22": {
    "type": "reference:CustomerAttribute",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField23": {
    "type": "reference:AccountApplication",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField24": {
    "type": "reference:CardAttribute",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField25": {
    "type": "reference:Counterparty",
    "example": "14503760-e76e-476d-830a-94d051f294ac"
}

"someField26": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&branchId=a08618a0-5c6d-490f-a642-07e0ef8acdd7"
}

"someField27": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&atmId=a08618a0-5c6d-490f-a642-07e0ef8acdd7"
}

"someField28": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&accountId=a08618a0-5c6d-490f-a642-07e0ef8acdd7"
}

"someField29": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&productCode=a08618a0-5c6d-490f-a642-07e0ef8acdd7"
}

"someField30": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&cardId=a08618a0-5c6d-490f-a642-07e0ef8acdd7"
}

"someField31": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&accountId=a08618a0-5c6d-490f-a642-07e0ef8acdd7&transactionId=9127fe3a-362b-4c64-b0e1-61957d563cd3"
}

"someField32": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=14503760-e76e-476d-830a-94d051f294ac&accountId=a08618a0-5c6d-490f-a642-07e0ef8acdd7&counterpartyId=9127fe3a-362b-4c64-b0e1-61957d563cd3"
}

Typical Successful Response

								
									
{ "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 }
Required Roles:
  • CanUpdateSystemLevelDynamicEntity - 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-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateSystemDynamicEntity, operation_id: OBPv4.0.0-updateSystemDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,