API Explorer

v4.0.0 (329 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Dynamic Entity

Create a DynamicEntity.

Authentication is Mandatory

Create one DynamicEntity, after created success, the corresponding CURD endpoints will be generated automatically

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

DATE_WITH_DAY format: yyyy-MM-dd

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField5": {
    "type": "reference:Bank",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField6": {
    "type": "reference:Consumer",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField7": {
    "type": "reference:Customer",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField8": {
    "type": "reference:MethodRouting",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField9": {
    "type": "reference:DynamicEntity",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField10": {
    "type": "reference:TransactionRequest",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField11": {
    "type": "reference:ProductAttribute",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField12": {
    "type": "reference:AccountAttribute",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField13": {
    "type": "reference:TransactionAttribute",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField14": {
    "type": "reference:CustomerAttribute",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField15": {
    "type": "reference:AccountApplication",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField16": {
    "type": "reference:CardAttribute",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField17": {
    "type": "reference:Counterparty",
    "example": "9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2"
}

"someField18": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&branchId=2bace8cf-006e-4353-9f1f-d674dda8a1ee"
}

"someField19": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&atmId=2bace8cf-006e-4353-9f1f-d674dda8a1ee"
}

"someField20": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&accountId=2bace8cf-006e-4353-9f1f-d674dda8a1ee"
}

"someField21": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&productCode=2bace8cf-006e-4353-9f1f-d674dda8a1ee"
}

"someField22": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&cardId=2bace8cf-006e-4353-9f1f-d674dda8a1ee"
}

"someField23": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&accountId=2bace8cf-006e-4353-9f1f-d674dda8a1ee&transactionId=0c81301b-2047-4389-83e2-8d74dabd299a"
}

"someField24": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=9cdf2f09-5dfe-40d0-a222-5e746b6fc7b2&accountId=2bace8cf-006e-4353-9f1f-d674dda8a1ee&counterpartyId=0c81301b-2047-4389-83e2-8d74dabd299a"
}

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" }
Required Roles:
  • CanCreateDynamicEntity - Please login to request this Role
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.
Implemented in OBPv4.0.0 by createDynamicEntity

Delete Dynamic Entity

Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteDynamicEntity - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by deleteDynamicEntity

Get Dynamic Entities

Get the all Dynamic Entities.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "dynamic_entities":[{ "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" }] }
Required Roles:
  • CanGetDynamicEntities - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by getDynamicEntities

Update Dynamic Entity

Update a DynamicEntity.

Authentication is Mandatory

Update one DynamicEntity, after update finished, the corresponding CURD 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

Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:

"someField0": {
    "type": "reference:FishPort",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField2": {
    "type": "reference:sustrans",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField3": {
    "type": "reference:SimonCovid",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField4": {
    "type": "reference:CovidAPIDays",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField5": {
    "type": "reference:Bank",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField6": {
    "type": "reference:Consumer",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField7": {
    "type": "reference:Customer",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField8": {
    "type": "reference:MethodRouting",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField9": {
    "type": "reference:DynamicEntity",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField10": {
    "type": "reference:TransactionRequest",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField11": {
    "type": "reference:ProductAttribute",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField12": {
    "type": "reference:AccountAttribute",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField13": {
    "type": "reference:TransactionAttribute",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField14": {
    "type": "reference:CustomerAttribute",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField15": {
    "type": "reference:AccountApplication",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField16": {
    "type": "reference:CardAttribute",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField17": {
    "type": "reference:Counterparty",
    "example": "8725518b-593c-46fe-9dd6-1ca97886b7b4"
}

"someField18": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&branchId=6ed1a752-3542-450a-941f-18976d736c8a"
}

"someField19": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&atmId=6ed1a752-3542-450a-941f-18976d736c8a"
}

"someField20": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&accountId=6ed1a752-3542-450a-941f-18976d736c8a"
}

"someField21": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&productCode=6ed1a752-3542-450a-941f-18976d736c8a"
}

"someField22": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&cardId=6ed1a752-3542-450a-941f-18976d736c8a"
}

"someField23": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&accountId=6ed1a752-3542-450a-941f-18976d736c8a&transactionId=32c68e29-e0ec-4368-ba3d-9c04debe98aa"
}

"someField24": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=8725518b-593c-46fe-9dd6-1ca97886b7b4&accountId=6ed1a752-3542-450a-941f-18976d736c8a&counterpartyId=32c68e29-e0ec-4368-ba3d-9c04debe98aa"
}

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" }
Required Roles:
  • CanUpdateDynamicEntity - Please login to request this Role
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.
Implemented in OBPv4.0.0 by updateDynamicEntity