API Explorer 891 endpoints

Partially update certification_scheme

PATCH /obp/dynamic-entity/certification_scheme/CERTIFICATION_SCHEME_ID

OBPv4.0.0-dynamicEntity_patchcertification_scheme_ Roles: CanUpdateDynamicEntityRecord_certification_scheme(per bank) _Certification_schemeDynamic-EntityDynamic

Partially update certification_scheme: 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.

‘certification scheme’ means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.

Property List:

  • certification_scheme_id: Unique identifier for certification scheme entity.
  • name: Public name of the certification scheme.
  • commission_decision_reference: "the Commission decision recognising that scheme"
  • certification_methodology: Methodology(ies) the scheme applies (identifier + version).
  • scheme_version_number: Scheme rulebook version used for this certification

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"certification_scheme"
    }
    {
        "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
{
  "certification_scheme_id": "cs_01HZZ1K0X5F6Q7R8S9T0",
  "name": "CRCF Scheme",
  "commission_decision_reference": "Commission Decision C(2026)1234",
  "certification_methodology": "{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}",
  "scheme_version_number": "v1.3"
}
Example success response
{
  "certification_scheme": {
    "certification_scheme_id": "cs_01HZZ1K0X5F6Q7R8S9T0",
    "name": "CRCF Scheme",
    "commission_decision_reference": "Commission Decision C(2026)1234",
    "certification_methodology": "{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}",
    "scheme_version_number": "v1.3"
  }
}
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_patchcertification_scheme_ Originally /certification_scheme/CERTIFICATION_SCHEME_ID