API Explorer 896 endpoints

Partially update buffer_pool

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

OBPv4.0.0-dynamicEntity_patchbuffer_pool_ogcr Roles: CanUpdateDynamicEntityRecord_buffer_pool(per bank) _Buffer_pool(ogcr)Dynamic-EntityDynamic

Partially update buffer_pool: only the fields supplied in the body are changed; others are preserved.

This is also the write path for field-level write-restricted fields (those declared with write_role_required or an explicit write_role). Authorisation is per field present in the body: a write-restricted field requires that field's write role, and an unrestricted field requires the entity update role. You may change a field if (and only if) you hold the role that governs it; the request is rejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update precondition — holding only a field's write role is sufficient to PATCH that field alone.

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 request body
{
  "buffer_pool_id": "string",
  "name": "string",
  "activity_id": "string",
  "unit_type": "string",
  "certification_scheme_id": "string",
  "rules_uri": "string"
}
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 (4)
  • 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 by OBPv4.0.0 dynamicEntity_patchbuffer_pool_ogcr Originally /banks/ogcr/buffer_pool/BUFFER_POOL_ID