API Explorer 896 endpoints

Get buffer_pool by id

GET /obp/dynamic-entity/banks/ogcr/buffer_pool/BUFFER_POOL_ID

OBPv4.0.0-dynamicEntity_getSinglebuffer_pool_ogcr Roles: CanGetDynamicEntityRecord_buffer_pool(per bank) _Buffer_pool(ogcr)Dynamic-EntityDynamic

Get buffer_pool by id.

Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.

Property List:

  • buffer_pool_id: (uu)id of the buffer pool
  • name: Human-readable name
  • activity_id: ID of the activity
  • unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)
  • certification_scheme_id: Scheme that runs the pool
  • rules_uri: The document defining contribution, cancellation and release rules

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"buffer_pool"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Example success response
{
  "bank_id": "ogcr",
  "buffer_pool": {
    "buffer_pool_id": "string",
    "name": "string",
    "activity_id": "string",
    "unit_type": "string",
    "certification_scheme_id": "string",
    "rules_uri": "string"
  }
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getSinglebuffer_pool_ogcr Originally /banks/ogcr/buffer_pool/BUFFER_POOL_ID