Blockchain Platform Functions

Package: DBMS_CLOUD_OCI_BC_BLOCKCHAIN_PLATFORM

CHANGE_BLOCKCHAIN_PLATFORM_COMPARTMENT Function

Change Blockchain Platform Compartment

Syntax

FUNCTION change_blockchain_platform_compartment (
  blockchain_platform_id varchar2,
  change_blockchain_platform_compartment_details dbms_cloud_oci_blockchain_change_blockchain_platform_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_change_blockchain_platform_compartment_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`change_blockchain_platform_compartment_details`	(required) Input payload to move the resource to a different compartment.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BLOCKCHAIN_PLATFORM Function

Creates a new Blockchain Platform.

Syntax

FUNCTION create_blockchain_platform (
  create_blockchain_platform_details dbms_cloud_oci_blockchain_create_blockchain_platform_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_create_blockchain_platform_response_t;

Parameters

Parameter	Description
`create_blockchain_platform_details`	(required) Details for the new service.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_OSN Function

Create Blockchain Platform Osn

Syntax

FUNCTION create_osn (
  blockchain_platform_id varchar2,
  create_osn_details dbms_cloud_oci_blockchain_create_osn_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_create_osn_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`create_osn_details`	(required) Input payload to create blockchain platform OSN. The payload cannot be empty.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PEER Function

Create Blockchain Platform Peer

Syntax

FUNCTION create_peer (
  blockchain_platform_id varchar2,
  create_peer_details dbms_cloud_oci_blockchain_create_peer_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_create_peer_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`create_peer_details`	(required) Input payload to create a blockchain platform peer. The payload cannot be empty.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BLOCKCHAIN_PLATFORM Function

Delete a particular of a Blockchain Platform

Syntax

FUNCTION delete_blockchain_platform (
  blockchain_platform_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_delete_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_OSN Function

Delete a particular OSN of a Blockchain Platform

Syntax

FUNCTION delete_osn (
  blockchain_platform_id varchar2,
  osn_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_delete_osn_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`osn_id`	(required) OSN identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PEER Function

Delete a particular peer of a Blockchain Platform

Syntax

FUNCTION delete_peer (
  blockchain_platform_id varchar2,
  peer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_delete_peer_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`peer_id`	(required) Peer identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_WORK_REQUEST Function

Attempts to cancel the work request with the given ID.

Syntax

FUNCTION delete_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_delete_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BLOCKCHAIN_PLATFORM Function

Gets information about a Blockchain Platform identified by the specific id

Syntax

FUNCTION get_blockchain_platform (
  blockchain_platform_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_get_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OSN Function

Gets information about an OSN identified by the specific id

Syntax

FUNCTION get_osn (
  blockchain_platform_id varchar2,
  osn_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_get_osn_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`osn_id`	(required) OSN identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PEER Function

Gets information about a peer identified by the specific id

Syntax

FUNCTION get_peer (
  blockchain_platform_id varchar2,
  peer_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_get_peer_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`peer_id`	(required) Peer identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BLOCKCHAIN_PLATFORM_PATCHES Function

List Blockchain Platform Patches

Syntax

FUNCTION list_blockchain_platform_patches (
  blockchain_platform_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_blockchain_platform_patches_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BLOCKCHAIN_PLATFORMS Function

Returns a list Blockchain Platform Instances in a compartment

Syntax

FUNCTION list_blockchain_platforms (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_blockchain_platforms_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`display_name`	(optional) A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OSNS Function

List Blockchain Platform OSNs

Syntax

FUNCTION list_osns (
  blockchain_platform_id varchar2,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_osns_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`display_name`	(optional) A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'timeCreated', 'displayName'
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PEERS Function

List Blockchain Platform Peers

Syntax

FUNCTION list_peers (
  blockchain_platform_id varchar2,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_peers_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`display_name`	(optional) A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. Allowed values are: 'timeCreated', 'displayName'
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  blockchain_platform_id varchar2,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`blockchain_platform_id`	(required) Unique service identifier.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for TIMESTARTED is descending. Default order for WORKREQUESTID is ascending. If no value is specified TIMESTARTED is default. Allowed values are: 'timeStarted', 'workRequestId'
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page at which to start retrieving results.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PREVIEW_SCALE_BLOCKCHAIN_PLATFORM Function

Preview Scale Blockchain Platform

Syntax

FUNCTION preview_scale_blockchain_platform (
  blockchain_platform_id varchar2,
  scale_blockchain_platform_details dbms_cloud_oci_blockchain_scale_blockchain_platform_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_preview_scale_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`scale_blockchain_platform_details`	(required) Input payload to scaleout blockchain platform. The payload cannot be empty.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SCALE_BLOCKCHAIN_PLATFORM Function

Scale Blockchain Platform

Syntax

FUNCTION scale_blockchain_platform (
  blockchain_platform_id varchar2,
  scale_blockchain_platform_details dbms_cloud_oci_blockchain_scale_blockchain_platform_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_scale_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`scale_blockchain_platform_details`	(required) Input payload to scaleout blockchain platform. The payload cannot be empty.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_BLOCKCHAIN_PLATFORM Function

Start a Blockchain Platform

Syntax

FUNCTION start_blockchain_platform (
  blockchain_platform_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_start_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_BLOCKCHAIN_PLATFORM Function

Stop a Blockchain Platform

Syntax

FUNCTION stop_blockchain_platform (
  blockchain_platform_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_stop_blockchain_platform_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BLOCKCHAIN_PLATFORM Function

Update a particular of a Blockchain Platform

Syntax

FUNCTION update_blockchain_platform (
  update_blockchain_platform_details dbms_cloud_oci_blockchain_update_blockchain_platform_details_t,
  blockchain_platform_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_update_blockchain_platform_response_t;

Parameters

Parameter	Description
`update_blockchain_platform_details`	(required) The Blockchain Platform fields to update. Fields that are not provided will not be updated.
`blockchain_platform_id`	(required) Unique service identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_OSN Function

Update Blockchain Platform OSN

Syntax

FUNCTION update_osn (
  blockchain_platform_id varchar2,
  osn_id varchar2,
  update_osn_details dbms_cloud_oci_blockchain_update_osn_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_update_osn_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`osn_id`	(required) OSN identifier.
`update_osn_details`	(required) Input payload to update a blockchain platform OSN. The payload cannot be empty.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PEER Function

Update Blockchain Platform Peer

Syntax

FUNCTION update_peer (
  blockchain_platform_id varchar2,
  peer_id varchar2,
  update_peer_details dbms_cloud_oci_blockchain_update_peer_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_update_peer_response_t;

Parameters

Parameter	Description
`blockchain_platform_id`	(required) Unique service identifier.
`peer_id`	(required) Peer identifier.
`update_peer_details`	(required) Input payload to update a blockchain platform peer. The payload cannot be empty.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPGRADE_BLOCKCHAIN_PLATFORM Function

Upgrade a Blockchain Platform version

Syntax

FUNCTION upgrade_blockchain_platform (
  upgrade_blockchain_platform_details dbms_cloud_oci_blockchain_upgrade_blockchain_platform_details_t,
  blockchain_platform_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bc_blockchain_platform_upgrade_blockchain_platform_response_t;

Parameters

Parameter	Description
`upgrade_blockchain_platform_details`	(required) Details for the new version to which it needs to be upgraded.
`blockchain_platform_id`	(required) Unique service identifier.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://blockchain.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_BLOCKCHAIN_PLATFORM_COMPARTMENT Function 🔗

CREATE_BLOCKCHAIN_PLATFORM Function 🔗

CREATE_OSN Function 🔗

CREATE_PEER Function 🔗

DELETE_BLOCKCHAIN_PLATFORM Function 🔗

DELETE_OSN Function 🔗

DELETE_PEER Function 🔗

DELETE_WORK_REQUEST Function 🔗

GET_BLOCKCHAIN_PLATFORM Function 🔗

GET_OSN Function 🔗

GET_PEER Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_BLOCKCHAIN_PLATFORM_PATCHES Function 🔗

LIST_BLOCKCHAIN_PLATFORMS Function 🔗

LIST_OSNS Function 🔗

LIST_PEERS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

PREVIEW_SCALE_BLOCKCHAIN_PLATFORM Function 🔗

SCALE_BLOCKCHAIN_PLATFORM Function 🔗

START_BLOCKCHAIN_PLATFORM Function 🔗

STOP_BLOCKCHAIN_PLATFORM Function 🔗

UPDATE_BLOCKCHAIN_PLATFORM Function 🔗

UPDATE_OSN Function 🔗

UPDATE_PEER Function 🔗

UPGRADE_BLOCKCHAIN_PLATFORM Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_BLOCKCHAIN_PLATFORM_COMPARTMENT Function

CREATE_BLOCKCHAIN_PLATFORM Function

CREATE_OSN Function

CREATE_PEER Function

DELETE_BLOCKCHAIN_PLATFORM Function

DELETE_OSN Function

DELETE_PEER Function

DELETE_WORK_REQUEST Function

GET_BLOCKCHAIN_PLATFORM Function

GET_OSN Function

GET_PEER Function

GET_WORK_REQUEST Function

LIST_BLOCKCHAIN_PLATFORM_PATCHES Function

LIST_BLOCKCHAIN_PLATFORMS Function

LIST_OSNS Function

LIST_PEERS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

PREVIEW_SCALE_BLOCKCHAIN_PLATFORM Function

SCALE_BLOCKCHAIN_PLATFORM Function

START_BLOCKCHAIN_PLATFORM Function

STOP_BLOCKCHAIN_PLATFORM Function

UPDATE_BLOCKCHAIN_PLATFORM Function

UPDATE_OSN Function

UPDATE_PEER Function

UPGRADE_BLOCKCHAIN_PLATFORM Function