API Explorer 1 endpoints

Factory Reset a System View

POST /obp/v7.0.0/management/system-views/VIEW_ID/factory-reset

OBPv7.0.0-factoryResetSystemView Roles: CanUpdateSystemView View-System

Reset the system view identified by VIEW_ID to the code-defined defaults.

This wipes the view's existing permissions and re-applies whatever the running OBP-API code currently defines as the default permission set for that system view id. View-level flags (name, description, is_firehose, alias settings, is_public) are also restored to defaults.

The underlying view row is preserved, so any AccountAccess records that grant users this view on specific accounts remain in place — only the contents of the view itself are reset.

Each successful invocation is audit-logged with the calling user_id and the reset view_id.

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

URL Parameters:

VIEW_ID: owner

JSON request body fields (0)
JSON response body fields (14)
account_id
8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
alias
allowed_actions
bank_id
gh.29.uk
can_grant_access_to_views
can_grant_access_to_views
can_revoke_access_to_views
can_revoke_access_to_views
description
Description of the object. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used
false
is_public
false
is_system
true
metadata_view
view_id
owner
view_name
owner
is_firehose
Example success response
{
  "bank_id": "",
  "account_id": "",
  "view_id": "auditor",
  "view_name": "Auditor",
  "description": "auditor",
  "metadata_view": "",
  "is_public": false,
  "is_system": true,
  "is_firehose": false,
  "alias": "",
  "hide_metadata_if_alias_used": false,
  "can_grant_access_to_views": [],
  "can_revoke_access_to_views": [],
  "allowed_actions": [
    "can_see_bank_account_balance",
    "can_see_transaction_amount",
    "can_add_comment",
    "can_add_tag"
  ]
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30252: System view not found. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 factoryResetSystemView