Partially update FishPort
PATCH /obp/dynamic-entity/FishPort/FISH_PORT_ID
OBPv4.0.0-dynamicEntity_patchFishPort_ Roles: CanUpdateDynamicEntityRecord_FishPort(per bank) _FishPortDynamic-EntityDynamic
Partially update FishPort: 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.
Portfolio of fishbased values
Property List:
- fish: description of name field, can be markdown text.
- number: description of number field, can be markdown text.
MethodRouting settings example:
<details>
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"FishPort"
}
{
"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
{
"fish": "James Brown",
"number": 6987233228
}Example success response
{
"fish_port": {
"fish_port_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
"fish": "James Brown",
"number": 6987233228
}
}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.