API Explorer 936 endpoints

Deactivate Dynamic Resource Doc

POST /obp/v7.0.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID/deactivation

OBPv7.0.0-deactivateDynamicResourceDoc Roles: CanApproveDynamicChangeRequest Dynamic-Change-RequestDynamic-Resource-Doc

Deactivate this dynamic artefact immediately. Deactivation reduces capability, so a single holder of CanApproveDynamicChangeRequest may do it directly; it is audited as a Dynamic Change Request with operation DEACTIVATE and status APPROVED. Re-activation requires a Dynamic Change Request with operation ACTIVATE approved by a second user.

An inactive artefact is never compiled or executed, regardless of whether maker/checker is enabled.

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

URL Parameters:

DYNAMIC_RESOURCE_DOC_ID: vce035ca-9a0f-4bfa-b30b-9003aa467f51

JSON request body fields (1)
comment
comment
JSON response body fields (18)
actioned_at
actioned_at
business_justification
business_justification
checker_comment
checker_comment
checker_user_id
checker_user_id
created_at
created_at
current_payload
current_payload
current_payload_hash
current_payload_hash
dynamic_change_request_id
dynamic_change_request_id
expires_at
expires_at
operation
operation
payload_hash
payload_hash
proposed_payload
proposed_payload
request_path
request_path
request_verb
POST
requestor_user_id
requestor_user_id
status
target_id
target_id
target_type
target_type
Example request body
{
  "comment": "Suspected data leak; disabling pending review."
}
Example success response
{
  "dynamic_change_request_id": "0d1c9e3c-6c2b-4c1e-9a53-2d5b2f0d7f11",
  "target_type": "DYNAMIC_RESOURCE_DOC",
  "target_id": "0d1c9e3c-6c2b-4c1e-9a53-2d5b2f0d7f22",
  "operation": "DEACTIVATE",
  "status": "APPROVED",
  "request_verb": "POST",
  "request_path": "",
  "payload_hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "current_payload_hash": "",
  "proposed_payload": {
    "is_active": false
  },
  "requestor_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "business_justification": "Expose the new loan quote endpoint for the mobile app.",
  "checker_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "checker_comment": "",
  "created_at": "1100-01-01T01:01:01.000Z",
  "actioned_at": "1100-01-01T01:01:01.000Z",
  "expires_at": "1100-01-01T01:01:01.000Z"
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30352: The target of the dynamic change request does not exist.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 deactivateDynamicResourceDoc