Package com.ibm.cloud.platform_services.case_management.v1

Class CaseManagement

  • public class CaseManagement
extends com.ibm.cloud.sdk.core.service.BaseService
    Case management API for creating cases, getting case statuses, adding comments to a case, adding and removing users from a case watchlist, downloading and adding attachments, and more. API Version: 1.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_SERVICE_NAME
      Default service name used when configuring the `CaseManagement` client.
      static java.lang.String DEFAULT_SERVICE_URL
      Default service endpoint URL.

      • Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

        PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

    • Constructor Summary

      Constructors 
      Constructor Description
      CaseManagement​(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
      Constructs an instance of the `CaseManagement` client.

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `CaseManagement` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CaseManagement

        public CaseManagement​(java.lang.String serviceName,
                      com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CaseManagement` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static CaseManagement newInstance()
        Class method which constructs an instance of the `CaseManagement` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `CaseManagement` client using external configuration

      • newInstance

        public static CaseManagement newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `CaseManagement` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `CaseManagement` client using external configuration

      • getCases

        public com.ibm.cloud.sdk.core.http.ServiceCall<CaseList> getCases​(GetCasesOptions getCasesOptions)
        Get cases in account. Get cases in the account that are specified by the content of the IAM token.
        Parameters:
        getCasesOptions - the GetCasesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CaseList

      • getCases

        public com.ibm.cloud.sdk.core.http.ServiceCall<CaseList> getCases()
        Get cases in account. Get cases in the account that are specified by the content of the IAM token.
        Returns:
        a ServiceCall with a result of type CaseList

      • createCase

        public com.ibm.cloud.sdk.core.http.ServiceCall<Case> createCase​(CreateCaseOptions createCaseOptions)
        Create a case. Create a support case to resolve issues in your account.
        Parameters:
        createCaseOptions - the CreateCaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Case

      • getCase

        public com.ibm.cloud.sdk.core.http.ServiceCall<Case> getCase​(GetCaseOptions getCaseOptions)
        Get a case in account. View a case in the account that is specified by the case number.
        Parameters:
        getCaseOptions - the GetCaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Case

      • updateCaseStatus

        public com.ibm.cloud.sdk.core.http.ServiceCall<Case> updateCaseStatus​(UpdateCaseStatusOptions updateCaseStatusOptions)
        Update case status. Mark the case as resolved or unresolved, or accept the provided resolution.
        Parameters:
        updateCaseStatusOptions - the UpdateCaseStatusOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Case

      • addComment

        public com.ibm.cloud.sdk.core.http.ServiceCall<Comment> addComment​(AddCommentOptions addCommentOptions)
        Add comment to case. Add a comment to a case to be viewed by a support engineer.
        Parameters:
        addCommentOptions - the AddCommentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Comment

      • addWatchlist

        public com.ibm.cloud.sdk.core.http.ServiceCall<WatchlistAddResponse> addWatchlist​(AddWatchlistOptions addWatchlistOptions)
        Add users to watchlist of case. Add users to the watchlist of case. By adding a user to the watchlist of the case, you are granting them read and write permissions, so the user can view the case, receive updates, and make updates to the case. Note that the user must be in the account to be added to the watchlist.
        Parameters:
        addWatchlistOptions - the AddWatchlistOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type WatchlistAddResponse

      • removeWatchlist

        public com.ibm.cloud.sdk.core.http.ServiceCall<Watchlist> removeWatchlist​(RemoveWatchlistOptions removeWatchlistOptions)
        Remove users from watchlist of case. Remove users from the watchlist of a case if you don't want them to view the case, receive updates, or make updates to the case.
        Parameters:
        removeWatchlistOptions - the RemoveWatchlistOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Watchlist

      • addResource

        public com.ibm.cloud.sdk.core.http.ServiceCall<Resource> addResource​(AddResourceOptions addResourceOptions)
        Add a resource to case. Add a resource to case by specifying the Cloud Resource Name (CRN), or id and type if attaching a class iaaS resource.
        Parameters:
        addResourceOptions - the AddResourceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Resource

      • uploadFile

        public com.ibm.cloud.sdk.core.http.ServiceCall<Attachment> uploadFile​(UploadFileOptions uploadFileOptions)
        Add attachments to a support case. You can add attachments to a case to provide more information for the support team about the issue that you're experiencing.
        Parameters:
        uploadFileOptions - the UploadFileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Attachment

      • downloadFile

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> downloadFile​(DownloadFileOptions downloadFileOptions)
        Download an attachment. Download an attachment from a case.
        Parameters:
        downloadFileOptions - the DownloadFileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • deleteFile

        public com.ibm.cloud.sdk.core.http.ServiceCall<AttachmentList> deleteFile​(DeleteFileOptions deleteFileOptions)
        Remove attachment from case. Remove an attachment from a case.
        Parameters:
        deleteFileOptions - the DeleteFileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AttachmentList