{"resource_docs":[{"operation_id":"OBPv4.0.0-deleteMyDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyDynamicEntity"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Delete My Dynamic Entity","description":"
Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities","summary":"Get Bank Level Dynamic Entities","description":"Get all the bank level Dynamic Entities for one bank.
\nAuthentication is Mandatory
\n","description_markdown":"Get all the bank level Dynamic Entities for one bank.\n\nAuthentication is Mandatory","success_response_body":{"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}]},"error_response_bodies":["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."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}}}}},"roles":[{"role":"CanGetBankLevelDynamicEntities","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateMyDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"updateMyDynamicEntity"},"request_verb":"PUT","request_url":"/obp/v4.0.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Update My Dynamic Entity","description":"Update my DynamicEntity.
\nAuthentication is Mandatory
\nUpdate one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nCurrent support filed types as follow:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference 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..
\nThe 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": {\n "type": "reference:FishPort",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField1": {\n "type": "reference:FooBar",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField2": {\n "type": "reference:sustrans",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField3": {\n "type": "reference:SimonCovid",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField4": {\n "type": "reference:CovidAPIDays",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField5": {\n "type": "reference:customer_cars",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField6": {\n "type": "reference:MarchHare",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField7": {\n "type": "reference:InsurancePolicy",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField8": {\n "type": "reference:Odometer",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField9": {\n "type": "reference:InsurancePremium",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField10": {\n "type": "reference:ObpActivity",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField11": {\n "type": "reference:test1",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField12": {\n "type": "reference:D-Entity1",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField13": {\n "type": "reference:test_daniel707",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField14": {\n "type": "reference:Bank",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField15": {\n "type": "reference:Consumer",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField16": {\n "type": "reference:Customer",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField17": {\n "type": "reference:MethodRouting",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField18": {\n "type": "reference:DynamicEntity",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField19": {\n "type": "reference:TransactionRequest",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField20": {\n "type": "reference:ProductAttribute",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField21": {\n "type": "reference:AccountAttribute",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField22": {\n "type": "reference:TransactionAttribute",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField23": {\n "type": "reference:CustomerAttribute",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField24": {\n "type": "reference:AccountApplication",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField25": {\n "type": "reference:CardAttribute",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField26": {\n "type": "reference:Counterparty",\n "example": "17c65e35-c81d-4ba4-9be7-2dc10de0fae7"\n}\n\n"someField27": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&branchId=09147fcd-3656-453b-9260-f9aeb5d206d3"\n}\n\n"someField28": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&atmId=09147fcd-3656-453b-9260-f9aeb5d206d3"\n}\n\n"someField29": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3"\n}\n\n"someField30": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&productCode=09147fcd-3656-453b-9260-f9aeb5d206d3"\n}\n\n"someField31": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&cardId=09147fcd-3656-453b-9260-f9aeb5d206d3"\n}\n\n"someField32": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3&transactionId=c8e2aafe-01c4-484f-a1b7-a6898db39694"\n}\n\n"someField33": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3&counterpartyId=c8e2aafe-01c4-484f-a1b7-a6898db39694"\n}\n\n
\n","description_markdown":"Update my DynamicEntity.\n\n\nAuthentication is Mandatory\n\nUpdate one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nCurrent support filed types as follow:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference 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..\nThe 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.\n```\n\"someField0\": {\n \"type\": \"reference:FishPort\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField1\": {\n \"type\": \"reference:FooBar\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField2\": {\n \"type\": \"reference:sustrans\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField3\": {\n \"type\": \"reference:SimonCovid\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField4\": {\n \"type\": \"reference:CovidAPIDays\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField5\": {\n \"type\": \"reference:customer_cars\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField6\": {\n \"type\": \"reference:MarchHare\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField7\": {\n \"type\": \"reference:InsurancePolicy\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField8\": {\n \"type\": \"reference:Odometer\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField9\": {\n \"type\": \"reference:InsurancePremium\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField10\": {\n \"type\": \"reference:ObpActivity\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField11\": {\n \"type\": \"reference:test1\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField12\": {\n \"type\": \"reference:D-Entity1\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField13\": {\n \"type\": \"reference:test_daniel707\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Bank\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField15\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Customer\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField17\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField18\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField19\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField20\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField21\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField22\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField23\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField24\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField25\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField26\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"17c65e35-c81d-4ba4-9be7-2dc10de0fae7\"\n}\n\n\"someField27\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&branchId=09147fcd-3656-453b-9260-f9aeb5d206d3\"\n}\n\n\"someField28\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&atmId=09147fcd-3656-453b-9260-f9aeb5d206d3\"\n}\n\n\"someField29\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3\"\n}\n\n\"someField30\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&productCode=09147fcd-3656-453b-9260-f9aeb5d206d3\"\n}\n\n\"someField31\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&cardId=09147fcd-3656-453b-9260-f9aeb5d206d3\"\n}\n\n\"someField32\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3&transactionId=c8e2aafe-01c4-484f-a1b7-a6898db39694\"\n}\n\n\"someField33\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=17c65e35-c81d-4ba4-9be7-2dc10de0fae7&accountId=09147fcd-3656-453b-9260-f9aeb5d206d3&counterpartyId=c8e2aafe-01c4-484f-a1b7-a6898db39694\"\n}\n\n```","example_request_body":{"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."}}},"hasPersonalEntity":true},"success_response_body":{"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},"error_response_bodies":["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."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSystemDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getSystemDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/system-dynamic-entities","summary":"Get System Dynamic Entities","description":"Get all System Dynamic Entities
\nAuthentication is Mandatory
\n","description_markdown":"Get all System Dynamic Entities \n\nAuthentication is Mandatory","success_response_body":{"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}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}}}}},"roles":[{"role":"CanGetSystemLevelDynamicEntities","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelDynamicEntity"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Delete Bank Level Dynamic Entity","description":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["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."],"tags":["Dynamic-Entity-Manage","API"],"roles":[{"role":"CanDeleteBankLevelDynamicEntity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelDynamicEntity"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities","summary":"Create Bank Level Dynamic Entity","description":"Create a Bank Level DynamicEntity.
\nAuthentication is Mandatory
\nCreate 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
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
The DATE_WITH_DAY format is: yyyy-MM-dd
\nReference 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..
\nThe 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": {\n "type": "reference:FishPort",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField1": {\n "type": "reference:FooBar",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField2": {\n "type": "reference:sustrans",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField3": {\n "type": "reference:SimonCovid",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField4": {\n "type": "reference:CovidAPIDays",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField5": {\n "type": "reference:customer_cars",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField6": {\n "type": "reference:MarchHare",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField7": {\n "type": "reference:InsurancePolicy",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField8": {\n "type": "reference:Odometer",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField9": {\n "type": "reference:InsurancePremium",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField10": {\n "type": "reference:ObpActivity",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField11": {\n "type": "reference:test1",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField12": {\n "type": "reference:D-Entity1",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField13": {\n "type": "reference:test_daniel707",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField14": {\n "type": "reference:Bank",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField15": {\n "type": "reference:Consumer",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField16": {\n "type": "reference:Customer",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField17": {\n "type": "reference:MethodRouting",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField18": {\n "type": "reference:DynamicEntity",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField19": {\n "type": "reference:TransactionRequest",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField20": {\n "type": "reference:ProductAttribute",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField21": {\n "type": "reference:AccountAttribute",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField22": {\n "type": "reference:TransactionAttribute",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField23": {\n "type": "reference:CustomerAttribute",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField24": {\n "type": "reference:AccountApplication",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField25": {\n "type": "reference:CardAttribute",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField26": {\n "type": "reference:Counterparty",\n "example": "34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0"\n}\n\n"someField27": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&branchId=85919873-d09a-41c1-8325-7377a4c6b6a0"\n}\n\n"someField28": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&atmId=85919873-d09a-41c1-8325-7377a4c6b6a0"\n}\n\n"someField29": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&accountId=85919873-d09a-41c1-8325-7377a4c6b6a0"\n}\n\n"someField30": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&productCode=85919873-d09a-41c1-8325-7377a4c6b6a0"\n}\n\n"someField31": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&cardId=85919873-d09a-41c1-8325-7377a4c6b6a0"\n}\n\n"someField32": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&accountId=85919873-d09a-41c1-8325-7377a4c6b6a0&transactionId=fb22a6b7-0d3d-4e05-856e-0c7591a5543b"\n}\n\n"someField33": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=34c64ad5-b9a1-4ed0-8cf6-5c24b551aad0&accountId=85919873-d09a-41c1-8325-7377a4c6b6a0&counterpartyId=fb22a6b7-0d3d-4e05-856e-0c7591a5543b"\n}\n\n
\nNote: if you set hasPersonalEntity
= false, then OBP will not generate the CRUD my FooBar endpoints.
Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"roles":[{"role":"CanDeleteSystemLevelDynamicEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelDynamicEntity"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Update Bank Level Dynamic Entity","description":"Update a Bank Level DynamicEntity.
\nAuthentication is Mandatory
\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference 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..
\nThe 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": {\n "type": "reference:FishPort",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField1": {\n "type": "reference:FooBar",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField2": {\n "type": "reference:sustrans",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField3": {\n "type": "reference:SimonCovid",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField4": {\n "type": "reference:CovidAPIDays",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField5": {\n "type": "reference:customer_cars",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField6": {\n "type": "reference:MarchHare",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField7": {\n "type": "reference:InsurancePolicy",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField8": {\n "type": "reference:Odometer",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField9": {\n "type": "reference:InsurancePremium",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField10": {\n "type": "reference:ObpActivity",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField11": {\n "type": "reference:test1",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField12": {\n "type": "reference:D-Entity1",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField13": {\n "type": "reference:test_daniel707",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField14": {\n "type": "reference:Bank",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField15": {\n "type": "reference:Consumer",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField16": {\n "type": "reference:Customer",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField17": {\n "type": "reference:MethodRouting",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField18": {\n "type": "reference:DynamicEntity",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField19": {\n "type": "reference:TransactionRequest",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField20": {\n "type": "reference:ProductAttribute",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField21": {\n "type": "reference:AccountAttribute",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField22": {\n "type": "reference:TransactionAttribute",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField23": {\n "type": "reference:CustomerAttribute",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField24": {\n "type": "reference:AccountApplication",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField25": {\n "type": "reference:CardAttribute",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField26": {\n "type": "reference:Counterparty",\n "example": "2a7394b9-ce89-40bb-8dd2-79ef650f42f3"\n}\n\n"someField27": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&branchId=1af23d08-3d8d-470d-a413-302fba7c1853"\n}\n\n"someField28": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&atmId=1af23d08-3d8d-470d-a413-302fba7c1853"\n}\n\n"someField29": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853"\n}\n\n"someField30": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&productCode=1af23d08-3d8d-470d-a413-302fba7c1853"\n}\n\n"someField31": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&cardId=1af23d08-3d8d-470d-a413-302fba7c1853"\n}\n\n"someField32": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853&transactionId=62eac72e-fd8b-40b4-8dda-b808837ac204"\n}\n\n"someField33": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853&counterpartyId=62eac72e-fd8b-40b4-8dda-b808837ac204"\n}\n\n
\n","description_markdown":"Update a Bank Level DynamicEntity.\n\n\nAuthentication is Mandatory\n\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nThe following field types are as supported:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference 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..\nThe 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.\n```\n\"someField0\": {\n \"type\": \"reference:FishPort\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField1\": {\n \"type\": \"reference:FooBar\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField2\": {\n \"type\": \"reference:sustrans\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField3\": {\n \"type\": \"reference:SimonCovid\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField4\": {\n \"type\": \"reference:CovidAPIDays\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField5\": {\n \"type\": \"reference:customer_cars\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField6\": {\n \"type\": \"reference:MarchHare\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField7\": {\n \"type\": \"reference:InsurancePolicy\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField8\": {\n \"type\": \"reference:Odometer\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField9\": {\n \"type\": \"reference:InsurancePremium\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField10\": {\n \"type\": \"reference:ObpActivity\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField11\": {\n \"type\": \"reference:test1\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField12\": {\n \"type\": \"reference:D-Entity1\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField13\": {\n \"type\": \"reference:test_daniel707\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Bank\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField15\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Customer\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField17\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField18\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField19\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField20\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField21\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField22\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField23\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField24\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField25\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField26\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"2a7394b9-ce89-40bb-8dd2-79ef650f42f3\"\n}\n\n\"someField27\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&branchId=1af23d08-3d8d-470d-a413-302fba7c1853\"\n}\n\n\"someField28\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&atmId=1af23d08-3d8d-470d-a413-302fba7c1853\"\n}\n\n\"someField29\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853\"\n}\n\n\"someField30\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&productCode=1af23d08-3d8d-470d-a413-302fba7c1853\"\n}\n\n\"someField31\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&cardId=1af23d08-3d8d-470d-a413-302fba7c1853\"\n}\n\n\"someField32\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853&transactionId=62eac72e-fd8b-40b4-8dda-b808837ac204\"\n}\n\n\"someField33\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=2a7394b9-ce89-40bb-8dd2-79ef650f42f3&accountId=1af23d08-3d8d-470d-a413-302fba7c1853&counterpartyId=62eac72e-fd8b-40b4-8dda-b808837ac204\"\n}\n\n```","example_request_body":{"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."}}},"hasPersonalEntity":true},"success_response_body":{"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},"error_response_bodies":["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."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}},"roles":[{"role":"CanUpdateBankLevelDynamicEntity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createSystemDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"createSystemDynamicEntity"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/system-dynamic-entities","summary":"Create System Level Dynamic Entity","description":"Create a system level Dynamic Entity.
\nAuthentication is Mandatory
\nCreate 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
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
The DATE_WITH_DAY format is: yyyy-MM-dd
\nReference 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..
\nSee 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": {\n "type": "reference:FishPort",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField1": {\n "type": "reference:FooBar",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField2": {\n "type": "reference:sustrans",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField3": {\n "type": "reference:SimonCovid",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField4": {\n "type": "reference:CovidAPIDays",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField5": {\n "type": "reference:customer_cars",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField6": {\n "type": "reference:MarchHare",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField7": {\n "type": "reference:InsurancePolicy",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField8": {\n "type": "reference:Odometer",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField9": {\n "type": "reference:InsurancePremium",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField10": {\n "type": "reference:ObpActivity",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField11": {\n "type": "reference:test1",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField12": {\n "type": "reference:D-Entity1",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField13": {\n "type": "reference:test_daniel707",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField14": {\n "type": "reference:Bank",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField15": {\n "type": "reference:Consumer",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField16": {\n "type": "reference:Customer",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField17": {\n "type": "reference:MethodRouting",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField18": {\n "type": "reference:DynamicEntity",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField19": {\n "type": "reference:TransactionRequest",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField20": {\n "type": "reference:ProductAttribute",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField21": {\n "type": "reference:AccountAttribute",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField22": {\n "type": "reference:TransactionAttribute",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField23": {\n "type": "reference:CustomerAttribute",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField24": {\n "type": "reference:AccountApplication",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField25": {\n "type": "reference:CardAttribute",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField26": {\n "type": "reference:Counterparty",\n "example": "b8c74777-b30d-48af-964d-3f71019fef7c"\n}\n\n"someField27": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&branchId=5a3f6810-bdfb-478c-9b22-fa19ab73277a"\n}\n\n"someField28": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&atmId=5a3f6810-bdfb-478c-9b22-fa19ab73277a"\n}\n\n"someField29": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&accountId=5a3f6810-bdfb-478c-9b22-fa19ab73277a"\n}\n\n"someField30": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&productCode=5a3f6810-bdfb-478c-9b22-fa19ab73277a"\n}\n\n"someField31": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&cardId=5a3f6810-bdfb-478c-9b22-fa19ab73277a"\n}\n\n"someField32": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&accountId=5a3f6810-bdfb-478c-9b22-fa19ab73277a&transactionId=c1f94b85-81d8-40a1-b6df-de87ca0afff6"\n}\n\n"someField33": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=b8c74777-b30d-48af-964d-3f71019fef7c&accountId=5a3f6810-bdfb-478c-9b22-fa19ab73277a&counterpartyId=c1f94b85-81d8-40a1-b6df-de87ca0afff6"\n}\n\n
\nNote: if you set hasPersonalEntity
= false, then OBP will not generate the CRUD my FooBar endpoints.
Update a System Level Dynamic Entity.
\nAuthentication is Mandatory
\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference 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..
\nThe 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": {\n "type": "reference:FishPort",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField1": {\n "type": "reference:FooBar",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField2": {\n "type": "reference:sustrans",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField3": {\n "type": "reference:SimonCovid",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField4": {\n "type": "reference:CovidAPIDays",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField5": {\n "type": "reference:customer_cars",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField6": {\n "type": "reference:MarchHare",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField7": {\n "type": "reference:InsurancePolicy",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField8": {\n "type": "reference:Odometer",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField9": {\n "type": "reference:InsurancePremium",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField10": {\n "type": "reference:ObpActivity",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField11": {\n "type": "reference:test1",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField12": {\n "type": "reference:D-Entity1",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField13": {\n "type": "reference:test_daniel707",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField14": {\n "type": "reference:Bank",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField15": {\n "type": "reference:Consumer",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField16": {\n "type": "reference:Customer",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField17": {\n "type": "reference:MethodRouting",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField18": {\n "type": "reference:DynamicEntity",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField19": {\n "type": "reference:TransactionRequest",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField20": {\n "type": "reference:ProductAttribute",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField21": {\n "type": "reference:AccountAttribute",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField22": {\n "type": "reference:TransactionAttribute",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField23": {\n "type": "reference:CustomerAttribute",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField24": {\n "type": "reference:AccountApplication",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField25": {\n "type": "reference:CardAttribute",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField26": {\n "type": "reference:Counterparty",\n "example": "822e4dc3-3564-45e0-a69b-8ecd9eb6652e"\n}\n\n"someField27": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&branchId=0337db36-9652-4374-b650-e48ef6654aba"\n}\n\n"someField28": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&atmId=0337db36-9652-4374-b650-e48ef6654aba"\n}\n\n"someField29": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba"\n}\n\n"someField30": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&productCode=0337db36-9652-4374-b650-e48ef6654aba"\n}\n\n"someField31": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&cardId=0337db36-9652-4374-b650-e48ef6654aba"\n}\n\n"someField32": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba&transactionId=832d6fca-18ef-4cf9-9baf-a50cc5d5624d"\n}\n\n"someField33": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba&counterpartyId=832d6fca-18ef-4cf9-9baf-a50cc5d5624d"\n}\n\n
\n","description_markdown":"Update a System Level Dynamic Entity.\n\n\nAuthentication is Mandatory\n\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nThe following field types are as supported:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference 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..\nThe 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.\n```\n\"someField0\": {\n \"type\": \"reference:FishPort\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField1\": {\n \"type\": \"reference:FooBar\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField2\": {\n \"type\": \"reference:sustrans\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField3\": {\n \"type\": \"reference:SimonCovid\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField4\": {\n \"type\": \"reference:CovidAPIDays\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField5\": {\n \"type\": \"reference:customer_cars\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField6\": {\n \"type\": \"reference:MarchHare\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField7\": {\n \"type\": \"reference:InsurancePolicy\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField8\": {\n \"type\": \"reference:Odometer\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField9\": {\n \"type\": \"reference:InsurancePremium\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField10\": {\n \"type\": \"reference:ObpActivity\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField11\": {\n \"type\": \"reference:test1\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField12\": {\n \"type\": \"reference:D-Entity1\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField13\": {\n \"type\": \"reference:test_daniel707\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Bank\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField15\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Customer\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField17\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField18\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField19\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField20\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField21\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField22\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField23\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField24\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField25\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField26\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"822e4dc3-3564-45e0-a69b-8ecd9eb6652e\"\n}\n\n\"someField27\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&branchId=0337db36-9652-4374-b650-e48ef6654aba\"\n}\n\n\"someField28\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&atmId=0337db36-9652-4374-b650-e48ef6654aba\"\n}\n\n\"someField29\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba\"\n}\n\n\"someField30\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&productCode=0337db36-9652-4374-b650-e48ef6654aba\"\n}\n\n\"someField31\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&cardId=0337db36-9652-4374-b650-e48ef6654aba\"\n}\n\n\"someField32\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba&transactionId=832d6fca-18ef-4cf9-9baf-a50cc5d5624d\"\n}\n\n\"someField33\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=822e4dc3-3564-45e0-a69b-8ecd9eb6652e&accountId=0337db36-9652-4374-b650-e48ef6654aba&counterpartyId=832d6fca-18ef-4cf9-9baf-a50cc5d5624d\"\n}\n\n```","example_request_body":{"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."}}},"hasPersonalEntity":true},"success_response_body":{"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},"error_response_bodies":["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."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}},"roles":[{"role":"CanUpdateSystemLevelDynamicEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getMyDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/dynamic-entities","summary":"Get My Dynamic Entities","description":"Get all my Dynamic Entities.
\nAuthentication is Mandatory
\n","description_markdown":"Get all my Dynamic Entities.\n\nAuthentication is Mandatory","success_response_body":{"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}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}},"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}}}},"description":{"type":"string"}}},"userId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities","connector_methods":[]}]}