API Explorer 1 endpoints

Get Dynamic Code Approval Config

GET /obp/v7.0.0/management/dynamic-code-approval-config

OBPv7.0.0-getDynamicCodeApprovalConfig No role required Dynamic-Change-RequestDynamicAPI

Returns whether maker/checker approval gates dynamic code and configuration on this instance, so a client can tell the maker before they submit.

  • dynamic_code_execution_enabled — the allow_user_generated_scala_code prop, the master kill switch. When false, creating or running any user-supplied Scala fails with OBP-50020: User-generated dynamic code execution is disabled on this API instance. Set allow_user_generated_scala_code=true to enable., whatever the approval settings say.
  • requires_approval — the dynamic_code_requires_approval prop. When false every other field is informational and writes are applied directly.
  • target_types — the dynamic_code_approval_target_types prop: the target types whose create, update and delete calls are queued as Dynamic Change Requests. Empty when approval is off.
  • delete_requires_approval — the dynamic_code_delete_requires_approval prop, combined with requires_approval.
  • request_ttl_hours — the dynamic_code_approval_request_ttl_hours prop: INITIATED requests older than this expire. 0 means never.
  • approval_role — the Role a checker must hold to approve, reject or deactivate.

Maker/checker for runtime-supplied code and configuration (dynamic resource docs, connector methods, dynamic message docs, ABAC rules).

When dynamic_code_requires_approval is true and the target type is listed in dynamic_code_approval_target_types, the v4.0.0 / v6.0.0 create, update and delete endpoints validate and compile the body as before but return 202 Accepted with a Dynamic Change Request instead of applying it. A DIFFERENT user holding CanApproveDynamicChangeRequest approves the request by its payload_hash; only then is the change applied, and the runtime executes only rows whose body hash equals the approved hash.

Approval is system level. Dynamic code runs in the shared JVM, so a bank-level artefact is approved by the same system-level checker; there are no bank-level change request endpoints.

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

JSON response body fields (6)
approval_role
approval_role
delete_requires_approval
delete_requires_approval
dynamic_code_execution_enabled
dynamic_code_execution_enabled
request_ttl_hours
request_ttl_hours
requires_approval
requires_approval
target_types
target_types
Example success response
{
  "dynamic_code_execution_enabled": true,
  "requires_approval": true,
  "target_types": [
    "DYNAMIC_RESOURCE_DOC",
    "DYNAMIC_MESSAGE_DOC",
    "CONNECTOR_METHOD",
    "ABAC_RULE"
  ],
  "delete_requires_approval": true,
  "request_ttl_hours": 168,
  "approval_role": "CanApproveDynamicChangeRequest"
}
Possible errors (2)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getDynamicCodeApprovalConfig