Partially update supporting_document
PATCH /obp/dynamic-entity/banks/dylan-bank/supporting_document/SUPPORTING_DOCUMENT_ID
OBPv4.0.0-dynamicEntity_patchsupporting_document_dylan-bank Roles: CanUpdateDynamicEntityRecord_supporting_document(per bank) _Supporting_document(dylan-bank)Dynamic-EntityDynamic
Partially update supporting_document: 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 supporting_document. This Dynamic Entity is part of OGCR.
Property List:
- supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.
- title: Title of the document
MethodRouting settings example:
<details>
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"supporting_document"
}
{
"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
{
"supporting_document_id": "DE",
"title": "Germany",
"sha256_of_document": "string",
"url": "string"
}Example success response
{
"bank_id": "dylan-bank",
"supporting_document": {
"supporting_document_id": "DE",
"title": "Germany",
"sha256_of_document": "string",
"url": "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.