right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

创建动态实体

创建一个DynamicEntity。

身份验证是强制性的

创建一个DynamicEntity，创建成功后，将自动生成相应的CRUD端点

当前的支持文件类型如下：
[字符串，数字，整数，布尔值]

Typical Successful Response: 

								
									
{
  "FooBar":{
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "example":"James Brown"
      },
      "number":{
        "type":"integer",
        "example":698761728
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id"
}
Required Roles:
  • CanCreateDynamicEntity - 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 createDynamicEntity, operation_id: OBPv4.0.0-createDynamicEntity Tags: Dynamic-Entity, API, New-Style,

删除动态实体

删除由DYNAMIC_ENTITY_ID指定的DynamicEntity。

身份验证是强制性的

Typical Successful Response: 

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

更新DynamicEntity

更新DynamicEntity。

身份验证是强制性的

更新一个DynamicEntity，更新完成后，将更改相应的CRUD端点。

当前的支持文件类型如下：
[字符串，数字，整数，布尔值]

Typical Successful Response: 

								
									
{
  "FooBar":{
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "example":"James Brown"
      },
      "number":{
        "type":"integer",
        "example":698761728
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id"
}
Required Roles:
  • CanUpdateDynamicEntity - 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 updateDynamicEntity, operation_id: OBPv4.0.0-updateDynamicEntity Tags: Dynamic-Entity, API, New-Style,

获取动态实体

获取所有DynamicEntities。

Typical Successful Response: 

								
									
{
  "dynamic_entities":[{
    "FooBar":{
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "example":"James Brown"
        },
        "number":{
          "type":"integer",
          "example":698761728
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id"
  }]
}
Required Roles:
  • CanGetDynamicEntities - 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 getDynamicEntities, operation_id: OBPv4.0.0-getDynamicEntities Tags: Dynamic-Entity, API, New-Style,