CIMS Incident Functions

Package: DBMS_CLOUD_OCI_CI_INCIDENT

CREATE_INCIDENT Function

Operation to create a support ticket.

Syntax

FUNCTION create_incident (
  create_incident_details dbms_cloud_oci_cims_create_incident_t,
  opc_request_id varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_create_incident_response_t;

Parameters

Parameter	Description
`create_incident_details`	(required) Incident information
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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_CSI_NUMBER Function

Fetches csi number of the user.

Syntax

FUNCTION get_csi_number (
  tenant_id varchar2,
  l_region varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_get_csi_number_response_t;

Parameters

Parameter	Description
`tenant_id`	(required) Tenancy Ocid in oracle cloud Infrastructure
`l_region`	(required) Home region of the customer which is part of oracle cloud infrastructure regions
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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_INCIDENT Function

Gets details about the specified support ticket.

Syntax

FUNCTION get_incident (
  incident_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  csi varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  problemtype varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_get_incident_response_t;

Parameters

Parameter	Description
`incident_key`	(required) Unique identifier for the support ticket.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`csi`	(optional) The Customer Support Identifier (CSI) associated with the support account.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`compartment_id`	(optional) The OCID of the tenancy.
`problemtype`	(optional) The kind of support request.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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_STATUS Function

Gets the status of the service.

Syntax

FUNCTION get_status (
  opc_request_id varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_get_status_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`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://incidentmanagement.{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_INCIDENT_RESOURCE_TYPES Function

During support ticket creation, returns the list of all possible products that Oracle Cloud Infrastructure supports.

Syntax

FUNCTION list_incident_resource_types (
  problem_type varchar2,
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  csi varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_list_incident_resource_types_response_t;

Parameters

Parameter	Description
`problem_type`	(required) The kind of support request.
`compartment_id`	(required) The OCID of the tenancy.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The key to use to sort the returned items. Allowed values are: 'dateUpdated', 'severity'
`sort_order`	(optional) The order to sort the results in. Allowed values are: 'ASC', 'DESC'
`name`	(optional) The user-friendly name of the support ticket type.
`csi`	(optional) The Customer Support Identifier (CSI) associated with the support account.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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_INCIDENTS Function

Returns the list of support tickets raised by the tenancy.

Syntax

FUNCTION list_incidents (
  compartment_id varchar2,
  csi varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  problem_type varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_list_incidents_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the tenancy.
`csi`	(optional) The Customer Support Identifier (CSI) associated with the support account.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination.
`sort_by`	(optional) The key to use to sort the returned items. Allowed values are: 'dateUpdated', 'severity'
`sort_order`	(optional) The order to sort the results in. Allowed values are: 'ASC', 'DESC'
`lifecycle_state`	(optional) The current state of the ticket. Allowed values are: 'ACTIVE', 'CLOSED'
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`problem_type`	(optional) The kind of support request.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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_INCIDENT Function

Updates the specified support ticket's information.

Syntax

FUNCTION update_incident (
  incident_key varchar2,
  update_incident_details dbms_cloud_oci_cims_update_incident_t,
  csi varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_update_incident_response_t;

Parameters

Parameter	Description
`incident_key`	(required) Unique identifier for the support ticket.
`update_incident_details`	(required) Details about the support ticket being updated.
`csi`	(optional) The Customer Support Identifier (CSI) associated with the support account.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) The OCID of the tenancy.
`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.
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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.

VALIDATE_USER Function

Checks whether the requested user is valid.

Syntax

FUNCTION validate_user (
  csi varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  problem_type varchar2 DEFAULT NULL,
  ocid varchar2 DEFAULT NULL,
  homeregion varchar2 DEFAULT NULL,
  bearertokentype varchar2 DEFAULT NULL,
  bearertoken varchar2 DEFAULT NULL,
  idtoken varchar2 DEFAULT NULL,
  domainid varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ci_incident_validate_user_response_t;

Parameters

Parameter	Description
`csi`	(optional) The Customer Support Identifier (CSI) associated with the support account.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`problem_type`	(optional) The kind of support request. Allowed values are: 'LIMIT', 'LEGACY_LIMIT', 'TECH', 'ACCOUNT', 'TAXONOMY'
`ocid`	(optional) User OCID for Oracle Identity Cloud Service (IDCS) users who also have a federated Oracle Cloud Infrastructure account.
`homeregion`	(optional) The region of the tenancy.
`bearertokentype`	(optional) Token type that determine which cloud provider the request come from.
`bearertoken`	(optional) Token that provided by multi cloud provider, which help to validate the email.
`idtoken`	(optional) IdToken that provided by multi cloud provider, which help to validate the email.
`domainid`	(optional) The OCID of identity domain.
`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://incidentmanagement.{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

CREATE_INCIDENT Function 🔗

GET_CSI_NUMBER Function 🔗

GET_INCIDENT Function 🔗

GET_STATUS Function 🔗

LIST_INCIDENT_RESOURCE_TYPES Function 🔗

LIST_INCIDENTS Function 🔗

UPDATE_INCIDENT Function 🔗

VALIDATE_USER Function 🔗

CREATE_INCIDENT Function

GET_CSI_NUMBER Function

GET_INCIDENT Function

GET_STATUS Function

LIST_INCIDENT_RESOURCE_TYPES Function

LIST_INCIDENTS Function

UPDATE_INCIDENT Function

VALIDATE_USER Function