API Explorer 5 endpoints

Partially update My test_daniel707

PATCH /obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID

OBPv4.0.0-dynamicEntity_patchMytest_daniel707_ Roles: CanUpdateDynamicEntityRecord_test_daniel707(per bank) _Test_daniel707Dynamic-EntityDynamic

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

This is also the write path for field-level write-restricted fields; writing such a field requires the caller to hold that field's write role.

Description of this entity, can be markdown text.

Property List:

  • name: 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":"test_daniel707"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

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

With a Consent: the consent user may use this endpoint only if the Consent lists this entity in my_resources.personal_dynamic_entities with the needed action (read for GET, write otherwise); rows written with a Consent belong to the User who granted it.

Example request body
{
  "name": "James Brown",
  "number": 698761728
}
Example success response
{
  "test_daniel707": {
    "test_daniel707_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name": "James Brown",
    "number": 698761728
  }
}
Possible errors (5)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-35043: The Consent does not cover this personal resource. A consent user may use a personal (my) endpoint only if the Consent lists the resource in my_resources with the needed action.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented by OBPv4.0.0 dynamicEntity_patchMytest_daniel707_ Originally /my/test_daniel707/TEST_DANIEL707_ID