API Explorer 891 endpoints

Update obp_report

PUT /obp/dynamic-entity/obp_report/OBP_REPORT_ID

OBPv4.0.0-dynamicEntity_updateobp_report_ Roles: CanUpdateDynamicEntityRecord_obp_report(per bank) _Obp_reportDynamic-EntityDynamic

Update obp_report.

A report authored on the API Manager's Reports page. definition is JavaScript that runs in a sandboxed frame in the viewer's browser, calls OBP through the API Manager with the viewer's own access, and emits rows; parameters describes the inputs the viewer fills in before a run. Never served to the public.

Property List:

  • slug: Short identifier. Lower-case letters, digits and hyphens.
  • title: Display title.
  • description: What the report shows and who it is for.
  • definition: JavaScript defining async function run(params, obp) that returns { columns, rows } or { items }.
  • parameters: JSON array of parameter fields: name, label, type (string | number | date | bank_id | boolean), default, required.
  • author: Username of the last editor.
  • updated_at: ISO 8601 time of the last save.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"obp_report"
    }
    {
        "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
{
  "slug": "accounts-per-bank",
  "title": "Accounts per bank",
  "description": "Counts the accounts the viewer can see at each bank.",
  "definition": "async function run(params, obp) { const b = await obp.get('/obp/v6.0.0/banks'); return { columns: ['bank_id', 'name'], rows: b.banks.map(x => [x.bank_id, x.full_name]) }; }",
  "parameters": "[{\"name\": \"bank_id\", \"label\": \"Bank\", \"type\": \"bank_id\", \"required\": true}]",
  "author": "ops.team",
  "updated_at": "2026-09-04T10:15:00Z"
}
Example success response
{
  "obp_report": {
    "obp_report_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "slug": "accounts-per-bank",
    "title": "Accounts per bank",
    "description": "Counts the accounts the viewer can see at each bank.",
    "definition": "async function run(params, obp) { const b = await obp.get('/obp/v6.0.0/banks'); return { columns: ['bank_id', 'name'], rows: b.banks.map(x => [x.bank_id, x.full_name]) }; }",
    "parameters": "[{\"name\": \"bank_id\", \"label\": \"Bank\", \"type\": \"bank_id\", \"required\": true}]",
    "author": "ops.team",
    "updated_at": "2026-09-04T10:15:00Z"
  }
}
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_updateobp_report_ Originally /obp_report/OBP_REPORT_ID