Oracle Cloud Infrastructure Documentation
Try Free Tier

Lockbox Common Types

DBMS_CLOUD_OCI_LOCKBOX_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_CONTEXT_ATTRIBUTE_T Type

Defined by partner while creating a lockbox. These attributes provides context for creating access request

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_context_attribute_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  description varchar2(32767),
  default_value varchar2(32767),
  l_values dbms_cloud_oci_lockbox_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_context_attribute_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_context_attribute_t (
    name varchar2,
    description varchar2,
    default_value varchar2,
    l_values dbms_cloud_oci_lockbox_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the context attribute

description

(optional) The description of the context attribute

default_value

(optional) An optional default value used when access request context value is not provided

l_values

(optional) List of context attribute values.

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_CONTEXT_ATTRIBUTE_TBL Type

Nested table type of dbms_cloud_oci_lockbox_access_context_attribute_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_context_attribute_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_access_context_attribute_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_CONTEXT_ATTRIBUTE_COLLECTION_T Type

Contains context attribute entries defined while creating or updating a lockbox.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_context_attribute_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_access_context_attribute_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_context_attribute_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_context_attribute_collection_t (
    items dbms_cloud_oci_lockbox_access_context_attribute_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of context attributes.

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_MATERIALS_T Type

Access materials details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_materials_t FORCE AUTHID CURRENT_USER IS OBJECT (
  details json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_materials_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_materials_t (
    details json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

details

(required) The contents of the material. This is a map that contains the various fields needed for access.

DBMS_CLOUD_OCI_LOCKBOX_ACTIVITY_LOG_T Type

The log of the action taken by different persona on the access request, e.g. approve/deny/revoke

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_activity_log_t FORCE AUTHID CURRENT_USER IS OBJECT (
  user_id varchar2(32767),
  user_level varchar2(32767),
  action varchar2(32767),
  message varchar2(32767),
  time_updated timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_activity_log_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_activity_log_t (
    user_id varchar2,
    user_level varchar2,
    action varchar2,
    message varchar2,
    time_updated timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

user_id

(optional) User OCID of the persona

user_level

(optional) Level of the persona

Allowed values are: 'LEVEL1', 'LEVEL2', 'LEVEL3', 'ADMIN', 'OPERATOR'

action

(optional) The action take by persona

Allowed values are: 'APPROVE', 'DENY', 'REVOKE', 'CANCEL'

message

(optional) The action justification or details.

time_updated

(optional) The time the action was taken. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

DBMS_CLOUD_OCI_LOCKBOX_ACTIVITY_LOG_TBL Type

Nested table type of dbms_cloud_oci_lockbox_activity_log_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_activity_log_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_activity_log_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_REQUEST_T Type

An access request to a customer's resource. An access request is a subsidiary resource of the Lockbox entity.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lockbox_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  requestor_id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_state_details varchar2(32767),
  access_duration varchar2(32767),
  context json_element_t,
  activity_logs dbms_cloud_oci_lockbox_activity_log_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  time_expired timestamp with time zone,
  time_reminded timestamp with time zone,
  reminder_count number,
  requestor_location varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_t (
    id varchar2,
    lockbox_id varchar2,
    display_name varchar2,
    description varchar2,
    requestor_id varchar2,
    lifecycle_state varchar2,
    lifecycle_state_details varchar2,
    access_duration varchar2,
    context json_element_t,
    activity_logs dbms_cloud_oci_lockbox_activity_log_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    time_expired timestamp with time zone,
    time_reminded timestamp with time zone,
    reminder_count number,
    requestor_location varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the access request, which can't be changed after creation.

lockbox_id

(required) The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.

display_name

(required) The name of the access request.

description

(required) The rationale for requesting the access request and any other related details..

requestor_id

(required) The unique identifier of the requestor.

lifecycle_state

(required) Possible access request lifecycle states.

Allowed values are: 'IN_PROGRESS', 'WAITING', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'FAILED'

lifecycle_state_details

(required) Details of access request lifecycle state.

Allowed values are: 'PROCESSING', 'WAITING_FOR_APPROVALS', 'APPROVED', 'AUTO_APPROVED', 'CANCELLING_ACCESS', 'EXPIRED', 'REVOKED', 'DENIED', 'ERROR'

access_duration

(required) The maximum amount of time operator has access to associated resources.

context

(optional) The context object containing the access request specific details.

activity_logs

(required) The actions taken by different persona on the access request, e.g. approve/deny/revoke

time_created

(required) The time the access request was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(required) The time the access request was last updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_expired

(required) The time the access request expired. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_reminded

(required) The time the access request was last reminded. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

reminder_count

(required) The count of times the access request was reminded.

requestor_location

(required) The location of the requestor. Format with be two letters indicatiog operator's country code defined by https://jira-sd.mc1.oracleiaas.com/browse/SSD-17880 Example: `US`

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_REQUEST_SUMMARY_T Type

Summary information for an access request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lockbox_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  requestor_id varchar2(32767),
  requestor_location varchar2(32767),
  lifecycle_state varchar2(32767),
  access_duration varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  time_expired timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_summary_t (
    id varchar2,
    lockbox_id varchar2,
    display_name varchar2,
    description varchar2,
    requestor_id varchar2,
    requestor_location varchar2,
    lifecycle_state varchar2,
    access_duration varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    time_expired timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the access request, which can't be changed after creation.

lockbox_id

(required) The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.

display_name

(required) The name of the access request.

description

(required) The rationale for requesting the access request.

requestor_id

(required) The unique identifier of the requestor.

requestor_location

(optional) The two-char country code of the requestor while creating the access request Example: `US`

lifecycle_state

(required) The current state of the access request.

access_duration

(optional) The maximum amount of time operator has access to associated resources.

time_created

(required) The time the access request was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(required) The time the access request was last updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_expired

(required) The time the access request expired. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_lockbox_access_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_access_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_ACCESS_REQUEST_COLLECTION_T Type

Results of access request search. Contains both AccessRequestSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_access_request_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_access_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_access_request_collection_t (
    items dbms_cloud_oci_lockbox_access_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of AccessRequestSummary.

DBMS_CLOUD_OCI_LOCKBOX_APPROVER_INFO_T Type

The approver data for this approver level.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approver_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
  approver_type varchar2(32767),
  approver_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approver_info_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approver_info_t (
    approver_type varchar2,
    approver_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

approver_type

(required) The approver type of this approver level.

Allowed values are: 'GROUP', 'USER'

approver_id

(required) The group or user ocid of the approver for this approver level.

DBMS_CLOUD_OCI_LOCKBOX_APPROVER_LEVELS_T Type

The approver levels.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approver_levels_t FORCE AUTHID CURRENT_USER IS OBJECT (
  level1 dbms_cloud_oci_lockbox_approver_info_t,
  level2 dbms_cloud_oci_lockbox_approver_info_t,
  level3 dbms_cloud_oci_lockbox_approver_info_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approver_levels_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approver_levels_t (
    level1 dbms_cloud_oci_lockbox_approver_info_t,
    level2 dbms_cloud_oci_lockbox_approver_info_t,
    level3 dbms_cloud_oci_lockbox_approver_info_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

level1

(required)

level2

(optional)

level3

(optional)

DBMS_CLOUD_OCI_LOCKBOX_APPROVAL_TEMPLATE_T Type

Group/User OCIDs of those who can approve/deny/revoke operator's request to access associated resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approval_template_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
  compartment_id varchar2(32767),
  auto_approval_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_t (
    id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
    compartment_id varchar2,
    auto_approval_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the approval template, which can't be changed after creation.

display_name

(required) The approval template display name.

lifecycle_state

(optional) The current state of the approval template.

Allowed values are: 'ACTIVE', 'CREATING', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'

approver_levels

(optional)

compartment_id

(required) The unique identifier (OCID) of the customer compartment where the approval template is located.

auto_approval_state

(optional) The auto approval state of the lockbox.

Allowed values are: 'ENABLED', 'DISABLED'

time_created

(required) The time the the approval template was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the approval template was updated. An RFC3339 formatted datetime string

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_LOCKBOX_APPROVAL_TEMPLATE_SUMMARY_T Type

Summary info for an approval tmeplate.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approval_template_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
  compartment_id varchar2(32767),
  auto_approval_state varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_summary_t (
    id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
    compartment_id varchar2,
    auto_approval_state varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the approval template, which can't be changed after creation.

display_name

(required) The approval template display name.

lifecycle_state

(optional) The current state of the approval template.

approver_levels

(optional)

compartment_id

(required) The unique identifier (OCID) of the customer compartment where the approval template is located.

auto_approval_state

(optional) The auto approval state of the lockbox.

Allowed values are: 'ENABLED', 'DISABLED'

time_created

(required) The time the the approval template was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the approval template was updated. An RFC3339 formatted datetime string

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_LOCKBOX_APPROVAL_TEMPLATE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_lockbox_approval_template_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approval_template_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_approval_template_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_APPROVAL_TEMPLATE_COLLECTION_T Type

Results of approval template search. Contains both ApprovalTemplateSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_approval_template_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_approval_template_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_approval_template_collection_t (
    items dbms_cloud_oci_lockbox_approval_template_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of ApprovalTemplateSummary.

DBMS_CLOUD_OCI_LOCKBOX_CHANGE_APPROVAL_TEMPLATE_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_change_approval_template_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_change_approval_template_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_change_approval_template_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The unique identifier (OCID) of the compartment where the resource is located.

DBMS_CLOUD_OCI_LOCKBOX_CHANGE_LOCKBOX_COMPARTMENT_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_change_lockbox_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_change_lockbox_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_change_lockbox_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The unique identifier (OCID) of the compartment where the resource is located.

DBMS_CLOUD_OCI_LOCKBOX_CREATE_ACCESS_REQUEST_DETAILS_T Type

The configuration details for a new access request. We don't accept a compartmentId parameter because it is implied to be the same as the lockbox as a subsidiary resource. The requestorId is also based on the caller user info.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_create_access_request_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  lockbox_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  context json_element_t,
  access_duration varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_access_request_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_access_request_details_t (
    lockbox_id varchar2,
    display_name varchar2,
    description varchar2,
    context json_element_t,
    access_duration varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

lockbox_id

(required) The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.

display_name

(optional) The name of the access request.

description

(required) The rationale for requesting the access request.

context

(optional) The context object containing the access request specific details.

access_duration

(required) The maximum amount of time operator has access to associated resources.

DBMS_CLOUD_OCI_LOCKBOX_CREATE_APPROVAL_TEMPLATE_DETAILS_T Type

The configuration details for a new approval template.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_create_approval_template_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
  auto_approval_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_approval_template_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_approval_template_details_t (
    compartment_id varchar2,
    display_name varchar2,
    approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
    auto_approval_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The unique identifier (OCID) of the compartment where the resource is located.

display_name

(optional) approval template identifier

approver_levels

(optional)

auto_approval_state

(optional) The auto approval state of the lockbox.

Allowed values are: 'ENABLED', 'DISABLED'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_LOCKBOX_CREATE_LOCKBOX_DETAILS_T Type

The information about new Lockbox.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_create_lockbox_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  resource_id varchar2(32767),
  lockbox_partner varchar2(32767),
  compartment_id varchar2(32767),
  partner_id varchar2(32767),
  partner_compartment_id varchar2(32767),
  approval_template_id varchar2(32767),
  max_access_duration varchar2(32767),
  access_context_attributes dbms_cloud_oci_lockbox_access_context_attribute_collection_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_lockbox_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_create_lockbox_details_t (
    display_name varchar2,
    resource_id varchar2,
    lockbox_partner varchar2,
    compartment_id varchar2,
    partner_id varchar2,
    partner_compartment_id varchar2,
    approval_template_id varchar2,
    max_access_duration varchar2,
    access_context_attributes dbms_cloud_oci_lockbox_access_context_attribute_collection_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Lockbox Identifier

resource_id

(required) The unique identifier (OCID) of the customer's resource.

lockbox_partner

(optional) The partner using this lockbox to lock a resource.

Allowed values are: 'FAAAS', 'CANARY'

compartment_id

(required) The unique identifier (OCID) of the compartment where the resource is located.

partner_id

(optional) The unique identifier (OCID) of partner resource using this lockbox to lock a resource

partner_compartment_id

(optional) Compartment Identifier

approval_template_id

(optional) Approval template ID

max_access_duration

(optional) The maximum amount of time operator has access to associated resources.

access_context_attributes

(required)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_LOCKBOX_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_LOCKBOX_EXPORT_ACCESS_REQUESTS_DETAILS_T Type

Details for generating report of Access Requests to export action

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_export_access_requests_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  lockbox_id varchar2(32767),
  time_created_after timestamp with time zone,
  time_created_before timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_export_access_requests_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_export_access_requests_details_t (
    lockbox_id varchar2,
    time_created_after timestamp with time zone,
    time_created_before timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

lockbox_id

(required) The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.

time_created_after

(required) Date and time after which access requests were created, as described in RFC 3339

time_created_before

(required) Date and time before which access requests were created, as described in RFC 3339s

DBMS_CLOUD_OCI_LOCKBOX_HANDLE_ACCESS_REQUEST_DETAILS_T Type

The details for handling access request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_handle_access_request_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_handle_access_request_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_handle_access_request_details_t (
    action varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action

(required) The action take by persona

Allowed values are: 'APPROVE', 'DENY', 'REVOKE', 'CANCEL'

message

(optional) Action justification or details.

DBMS_CLOUD_OCI_LOCKBOX_LOCKBOX_T Type

Description of Lockbox.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_lockbox_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  partner_id varchar2(32767),
  parent_lockbox_id varchar2(32767),
  partner_compartment_id varchar2(32767),
  resource_id varchar2(32767),
  lockbox_partner varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  access_context_attributes dbms_cloud_oci_lockbox_access_context_attribute_collection_t,
  approval_template_id varchar2(32767),
  max_access_duration varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    partner_id varchar2,
    parent_lockbox_id varchar2,
    partner_compartment_id varchar2,
    resource_id varchar2,
    lockbox_partner varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    access_context_attributes dbms_cloud_oci_lockbox_access_context_attribute_collection_t,
    approval_template_id varchar2,
    max_access_duration varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

display_name

(required) Lockbox Identifier, can be renamed

compartment_id

(required) Compartment Identifier

partner_id

(optional) The unique identifier (OCID) of partner resource using this lockbox to lock a resource

parent_lockbox_id

(optional) The unique identifier (OCID) of lockbox resource using to reference parent lockbox in hybrid oma setup

partner_compartment_id

(optional) Compartment Identifier

resource_id

(required) The unique identifier (OCID) of associated resource that the lockbox is created for.

lockbox_partner

(optional) The partner using this lockbox to lock a resource.

Allowed values are: 'FAAAS', 'CANARY'

time_created

(required) The time the the Lockbox was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the Lockbox was updated. An RFC3339 formatted datetime string

lifecycle_state

(required) The current state of the Lockbox.

Allowed values are: 'ACTIVE', 'CREATING', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'

access_context_attributes

(optional)

approval_template_id

(optional) Approval template ID

max_access_duration

(optional) The maximum amount of time operator has access to associated resources.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_LOCKBOX_LOCKBOX_SUMMARY_T Type

Summary of the Lockbox.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_lockbox_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  lockbox_partner varchar2(32767),
  compartment_id varchar2(32767),
  partner_id varchar2(32767),
  partner_compartment_id varchar2(32767),
  resource_id varchar2(32767),
  approval_template_id varchar2(32767),
  max_access_duration varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_summary_t (
    id varchar2,
    display_name varchar2,
    lockbox_partner varchar2,
    compartment_id varchar2,
    partner_id varchar2,
    partner_compartment_id varchar2,
    resource_id varchar2,
    approval_template_id varchar2,
    max_access_duration varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

display_name

(required) Lockbox Identifier, can be renamed

lockbox_partner

(optional) The partner using this lockbox to lock a resource.

Allowed values are: 'FAAAS', 'CANARY'

compartment_id

(required) Compartment Identifier

partner_id

(optional) The unique identifier (OCID) of partner resource using this lockbox to lock a resource

partner_compartment_id

(optional) Compartment Identifier

resource_id

(required) The unique identifier (OCID) of associated resource that the lockbox is created for.

approval_template_id

(optional) Approval template ID

max_access_duration

(optional) The maximum amount of time operator has access to associated resources.

time_created

(required) The time the the Lockbox was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the Lockbox was updated. An RFC3339 formatted datetime string

lifecycle_state

(required) The current state of the Lockbox.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(required) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(required) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_LOCKBOX_LOCKBOX_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_lockbox_lockbox_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_lockbox_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_lockbox_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_LOCKBOX_COLLECTION_T Type

Results of a lockbox search. Contains both LockboxSummary items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_lockbox_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_lockbox_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_lockbox_collection_t (
    items dbms_cloud_oci_lockbox_lockbox_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of lockboxes.

DBMS_CLOUD_OCI_LOCKBOX_UPDATE_APPROVAL_TEMPLATE_DETAILS_T Type

The action to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_update_approval_template_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
  display_name varchar2(32767),
  auto_approval_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_update_approval_template_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_update_approval_template_details_t (
    approver_levels dbms_cloud_oci_lockbox_approver_levels_t,
    display_name varchar2,
    auto_approval_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

approver_levels

(optional)

display_name

(optional) approval template identifier

auto_approval_state

(optional) The auto approval state of the lockbox.

Allowed values are: 'ENABLED', 'DISABLED'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_LOCKBOX_UPDATE_LOCKBOX_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_update_lockbox_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  approval_template_id varchar2(32767),
  max_access_duration varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_update_lockbox_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_update_lockbox_details_t (
    display_name varchar2,
    approval_template_id varchar2,
    max_access_duration varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Lockbox Identifier

approval_template_id

(optional) Approval template ID

max_access_duration

(optional) The maximum amount of time operator has access to associated resources.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  metadata json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2,
    metadata json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED', 'FAILED'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata

metadata

(optional) Additional information that helps to explain the resource.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_lockbox_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_lockbox_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_lockbox_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_LOCKBOX', 'UPDATE_LOCKBOX', 'DELETE_LOCKBOX', 'MOVE_LOCKBOX', 'CREATE_ACCESS_REQUEST', 'APPROVE_ACCESS_REQUEST', 'REVOKE_ACCESS_REQUEST', 'CREATE_APPROVAL_TEMPLATE', 'MOVE_APPROVAL_TEMPLATE', 'UPDATE_APPROVAL_TEMPLATE', 'DELETE_APPROVAL_TEMPLATE', 'CREATE_PARTNER', 'REMIND_ACCESS_REQUEST', 'CREATE_ACCESSCONTEXTATTRIBUTE'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'NEEDS_ATTENTION'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_lockbox_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_ERROR_COLLECTION_T Type

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_error_collection_t (
    items dbms_cloud_oci_lockbox_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_lockbox_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_log_entry_collection_t (
    items dbms_cloud_oci_lockbox_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_lockbox_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_lockbox_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_LOCKBOX', 'UPDATE_LOCKBOX', 'DELETE_LOCKBOX', 'MOVE_LOCKBOX', 'CREATE_ACCESS_REQUEST', 'APPROVE_ACCESS_REQUEST', 'REVOKE_ACCESS_REQUEST', 'CREATE_APPROVAL_TEMPLATE', 'MOVE_APPROVAL_TEMPLATE', 'UPDATE_APPROVAL_TEMPLATE', 'DELETE_APPROVAL_TEMPLATE', 'CREATE_PARTNER', 'REMIND_ACCESS_REQUEST', 'CREATE_ACCESSCONTEXTATTRIBUTE'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'NEEDS_ATTENTION'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_lockbox_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_lockbox_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_LOCKBOX_WORK_REQUEST_SUMMARY_COLLECTION_T Type

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_lockbox_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_lockbox_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_lockbox_work_request_summary_collection_t (
    items dbms_cloud_oci_lockbox_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?