IBM Cloud API Docs

Introduction

Last updated: 2025-05-13

With the IBM Cloud® Support Center, you can get the help that you need to determine the cause of a problem and find a solution for issues that you encounter on your account. The Case Management API provides a RESTful public interface to create and manage your support cases. SDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. For more information about using the SDKs, see the IBM Cloud SDK Common project on GitHub.

HIPAA notice

The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice

To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

The code examples on this tab use the client library that is provided for Java.

Maven

<dependency>
    <groupId>com.ibm.cloud</groupId>
	<artifactId>case-management</artifactId>
	<version>{version}</version>
</dependency>

Gradle

'com.ibm.cloud:case-management:{version}'

View on GitHub

https://github.com/IBM/platform-services-java-sdk

The code examples on this tab use the client library that is provided for Node.js.

Installation

npm install @ibm-cloud/platform-services

View on GitHub

https://github.com/IBM/platform-services-node-sdk

The code examples on this tab use the client library that is provided for Python.

Installation

To install, use pip or easy_install:

pip install --upgrade "ibm-platform-services"

or

easy_install --upgrade "ibm-platform-services"

View on GitHub

https://github.com/IBM/platform-services-python-sdk

Installing the Go SDK

Go modules (recommended): Add the following import in your code, and then run go build or go mod tidy

import (
	"github.com/IBM/platform-services-go-sdk/casemanagementv2"
)

Go get

go get -u github.com/IBM/platform-services-go-sdk/casemanagementv2

View on GitHub

https://github.com/IBM/platform-services-go-sdk

Endpoint URL

The Case Management API uses the following global endpoint URL. When you call the API, add the path for each method to form the complete API endpoint for your requests.

https://support-center.cloud.ibm.com/case-management/v2

Example API request

curl -X {request_method} "https://support-center.cloud.ibm.com/case-management/v2/{method_endpoint}"

Replace {request_method} and {method_endpoint} in this example with the values for your particular API call.

Authentication

Authentication to the case management REST API is enforced by using an IAM access token. The token is used to determine the identity and access roles for management services. All cases are in the scope of the account that is specified in an IAM token. You need the IAM token that has account information. If you generate an IAM token through an API, don't forget to add the account information. For information about how to obtain an IAM token for an authenticated user or service ID, see the IAM Identity Service API documentation.

Use of the IAM Policy Management REST API is done by adding a valid IAM Token to the HTTP Authorization request header. Example: -H 'Authorization: Bearer $TOKEN'

Obtaining an IAM token for an authenticated user or service ID is described in the IAM Identity Services API documentation.

To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer <TOKEN>'.

When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:

  • Programmatically by constructing an IAM authenticator instance and supplying your IAM API key
  • By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key

In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.

For more information, see the Authentication section of the IBM Cloud SDK Common documentation.

To call each method, you need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Assigning access to account management services.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey=<API_KEY>'

Replace <API_KEY> with your IAM API key.

Setting client options through external configuration

Example environment variables, where <API_KEY> is your IAM API key

export CASE_MANAGEMENT_APIKEY=<API_KEY>

Example of constructing the service client

import {
    "github.com/IBM/platform-services-go-sdk/casemanagementv2"
}
...
caseManagementServiceOptions := &casemanagementv2.CaseManagementV2Options{}
caseManagementService, err := casemanagementv2.NewCaseManagementV2UsingExternalConfig(caseManagementServiceOptions)

Setting client options through external configuration

Example environment variables, where <API_KEY> is your IAM API key

export CASE_MANAGEMENT_APIKEY=<API_KEY>

Example of constructing the service client

import com.ibm.cloud.platform_services.case_management.v2.CaseManagement;
...
CaseManagement service = CaseManagement.newInstance();

Setting client options through external configuration

Example environment variables, where <API_KEY> is your IAM API key

export CASE_MANAGEMENT_APIKEY=<API_KEY>

Example of constructing the service client

const CaseManagementV2 = require('@ibm-cloud/platform-services/case-management/v2');
...
const caseManagementService = CaseManagementV2.newInstance({});

Setting client options through external configuration

Example environment variables, where <API_KEY> is your IAM API key

pip install --upgrade "ibm-platform-services"
export CASE_MANAGEMENT_APIKEY=<API_KEY>

Example of constructing the service client

from ibm_platform_services.case_management_v2 import *
...
case_management_service = CaseManagementV2.new_instance()

all_results = []
pager = GetCasesPager(client=case_management_service, limit=10, search='Example')
while pager.has_next():
  next_page = pager.get_next()
  assert next_page is not None
  all_results.extend(next_page)

print(json.dumps(all_results, indent=2))

Error handling

The Case Management API returns standard HTTP status codes to indicate the success or failure of a request. The format of the response is represented in JSON as follows:

{
    "trace": "cd4f7573121a4cf99f0079f8482b3d6b",
    "errors": [
        {
            "code": "invalid_token",
            "message": "The provided IAM token is invalid."
        }
    ],
    "status_code": 401
}

If an operation cannot be fulfilled, an appropriate 400 or 500 series HTTP response is returned from the server. The operations that are defined in the Reference section describe example errors that can be returned from a failed request. All responses from the IAM Policy Management API are in the JSON format.

The following are potential error codes that the API can return.

HTTP Error Code Description Recovery
200 Success The request was successful.
201 Created The resource was successfully created.
204 No Content The request was successful. No response body is provided.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. The token is either invalid, missing or expired. Get a new valid token and try again.
403 Forbidden The token is valid, but the subject of the token is not authorized to perform the operation. If this error persists, contact the account owner to check your permissions.
404 Not Found The requested resource could not be found.
409 Conflict The entity is already in the requested state.
415 Unsupported Media Type Request body sent was formatted by using an unsupported media type.
429 Too Many Requests Too many requests were made within a given time window. Wait before you call the API again.
500 Service Unavailable IAM Policy Management Point is unavailable. Your request might not be processed. Wait a few minutes and try again.

Pagination

Some API requests might return a large number of results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. For more information, see Pagination.

GET requests for GetCasesOptions use pagination.

The default page and max size is 100 objects. To use a different page size, use the limit query parameter.

For any request that uses pagination, the response includes a next_url object that specifies pagination information. next_url is the URL for requesting the next page of results. The next_url property is null if there are no more results, and retains the same limit parameter that is used for the initial request.

Methods

Get cases

Get cases in the account that are specified by the content of the IAM token.

GET /cases

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

Query Parameters

  • offset
    integer

    Number of cases should be skipped

    Possible values: 0 ≤ value ≤ 10000000000

    Default: 0

  • limit
    integer

    Number of cases should be returned

    Possible values: 1 ≤ value ≤ 100

    Default: 10

  • search
    string

    String that a case might contain

    Possible values: Value must match regular expression ^[a-zA-Z0-9\s\\.\\_]{2,160}$

  • show_opened_by_cases
    boolean

    Only show cases opened by the caller

  • show_watchlist_cases
    boolean

    Show cases where caller is on the watchlist

  • sort
    string

    Sort field and direction. If omitted, default to descending of updated date. Prefix "~" signifies sort in descending order.

    Allowable values: [number,subject,severity,updated_at,created_at,~number,~subject,~severity,~updated_at,~created_at]

  • status
    string[]

    Case status filter

    Allowable values: [new,in_progress,waiting_on_client,resolution_provided,resolved,closed]

  • updated_at_or_after
    date-time

    Timestamp in UTC

  • fields
    string[]

    Selected fields of interest

    Allowable values: [number,subject,description,created_at,created_by,updated_at,updated_by,contact,contact_type,status,severity,support_tier,resolution,close_notes,invoice_number,agent_close_only,eu,watchlist,attachments,resources,comments,topic_id,subtopic]

    Possible values: number of items ≥ 1, contains only unique items

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   "https://support-center.cloud.ibm.com/case-management/v2/cases"

Response

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Create case

Create a case in the account.

HIPAA notice
The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice
To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

POST /cases

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.create

Request

Request Body

Required*
CaseCreationRequest

This is the request body for creating a support case. There will be different optional/required properties depending on which type of support case the system will route too.

  • curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "topic_id": "<some topic id - find one by calling the topics endpoint>", "subject": "some subject", "description": "some description" }'   "https://support-center.cloud.ibm.com/case-management/v2/cases"

Response

Response Body

object

The response payload when a support case is created

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Get case

View case in the account that is specified by the case number

GET /cases/{case_number}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Query Parameters

  • fields
    string[]

    Selected fields of interest

    Allowable values: [number,subject,description,created_at,created_by,updated_at,updated_by,contact,contact_type,status,severity,support_tier,resolution,close_notes,invoice_number,agent_close_only,eu,watchlist,attachments,resources,comments,topic_id,subtopic]

    Possible values: number of items ≥ 1, contains only unique items

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}"

Response

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Attach file

You can add file attachments to a case to provide more information for the support team about the issue that you're experiencing.

HIPAA notice
The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice
To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

PUT /cases/{case_number}/attachments

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Form Parameters

  • file
    Required*
    binary

    File of supported types, 8MB in size limit

  • curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: multipart/form-data"   --form "file=@${path_to_file}"   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/attachments"

Response

Response Body

CaseUpdateAttachmentResponse

Details of an attachment

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Download file

Download file attachment

GET /cases/{case_number}/attachments/{file_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

  • file_id
    Required*
    string

    Unique identifier of file

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/attachments/${file_id}"

Response

Response Body

string

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Delete file

Delete file attachment

DELETE /cases/{case_number}/attachments/{file_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

  • file_id
    Required*
    string

    Unique identifier of file

  • curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/attachments/${file_id}"

Response

Response Body

CaseDeleteAttachmentResponse

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Update status

Mark the case as resolved or unresolved, or accept the provided resolution.

HIPAA notice
The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice
To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

PUT /cases/{case_number}/status

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Request Body

Required*
StatusRequest

This is the request body for updating the status of a support case

  • curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Content-Type: application/json"   --data '{ "action": "resolve" }'   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/status"

Response

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Get comments

Get all comments on case

GET /cases/{case_number}/comments

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/comments"

Response

Response Body

CaseGetCommentsReponse

Contains a total count and an array of comment objects that excludes any work notes

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Add comment

Add comment to case.

HIPAA notice
The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice
To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

PUT /cases/{case_number}/comments

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Request Body

Required*
CaseAddCommentsRequest

Request body for adding comment to case

  • curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"comment":"a comment"}'   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/comments"

Response

Response Body

CaseAddCommentsReponse

Response to adding comment to case

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Add user to watchlist

Add user to case watchlist. Users on watchlist will be notified of case updates. If account user visbility is restricted, the user did not create the case, and the added user does not have access to view or manage users in the account, then the user added to the case watchlist will have access to the case, if the user has been granted a Viewer, Editor, or Administrator Support Center IAM policy on the account.

PUT /cases/{case_number}/watchlist

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Request Body

Required*
CaseWatchlistRequest

Request body for adding users to case watchlist

Examples: 
{
  "watchlist": [
    "IBMid-123fakeid"
  ]
}
  • curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"watchlist":["IBMid-123fakeid"]}'   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/watchlist"

Response

Response Body

CaseAddWatchlistResponse

Request response of adding to watchlist

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

Example responses
  • {
  "added": [
    "IBMid-123fakeid"
  ],
  "failed": [
    "IBMid-456fakeid"
  ]
}

Remove user from watchlist

Remove user from case watchlist

DELETE /cases/{case_number}/watchlist

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Request Body

Required*
CaseWatchlistRequest

Request body for removing users from case watchlist

Examples: 
{
  "watchlist": [
    "IBMid-123fakeid"
  ]
}
  • curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"watchlist":["IBMid-123fakeid"]}'   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/watchlist"

Response

Response Body

CaseDeleteWatchlistResponse

Request response to delete from watchlist

Status Code

  • 200

    Success - Returns a list of remaining watchlist users

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Add resources

Add resource to case by specifying the Cloud Resource Name (CRN).

HIPAA notice
The support case system does not offer features for the protection of content that contains Healthcare Information, health data, Protected Health Information or data subject to additional regulatory requirements and Client must not input or provide such data.

GDPR notice
To maintain device security, do not include any device credentials within case responses. The response fields are not intended for Personal Information or Sensitive Data. Information entered into these fields is retained to provide the best support experience.

PUT /cases/{case_number}/resources

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.update

Request

Path Parameters

  • case_number
    Required*
    string

    Unique case identifier

    Possible values: Value must match regular expression ^(?:CS|TS)\d{3,128}$

Request Body

Required*
CaseAddResourcesRequest

This is the request body for adding resources to a case

Examples: 
{
  "resources": [
    {
      "name": "fake-name-1",
      "crn": "fake-crn-1"
    },
    {
      "name": "fake-name-2",
      "crn": "fake-crn-2"
    }
  ]
}
  • curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"resources":[{"name":"fake-name-1","crn":"fake-crn-1"},{"name":"fake-name-2","crn":"fake-crn-2"}]}'   "https://support-center.cloud.ibm.com/case-management/v2/cases/${case_number}/resources"

Response

Response Body

CaseAddResourcesResponse

Response to add resource to case. Returns newly added resources.

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Get topics

Returns list of topics which can be used to open support cases

GET /topics

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

No Request Parameters

This method does not accept any request parameters.

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "https://support-center.cloud.ibm.com/case-management/v2/topics"

Response

Response Body

TopicRetrievalResponseForAllTopics

The response payload when retrieving all topics

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

Get topic by id

Get topic by topic id

GET /topics/{topic_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • support.case.read

Request

Path Parameters

  • topic_id
    Required*
    string

    ID of topic

    Possible values: Value must match regular expression ^(?:[a-z0-9]{8})-{1}(?:[a-z0-9]{4})-{1}(?:[a-z0-9]{4})-{1}(?:[a-z0-9]{4})-{1}(?:[a-z0-9]{12})$

  • curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "https://support-center.cloud.ibm.com/case-management/v2/topics/${topic_id}"

Response

Response Body

TopicRetrievalResponse

The response payload when viewing topics publicly

Status Code

  • 200

    Success

  • 403

    Forbidden - insufficient permission. The client has been authenticated successfully, but the permissions set for the operation forbid this operation to the specified user.

  • 404

    Not Found - The requested resource does not exist

  • 409

    Conflict - The requested resource is being modified in a different request

  • 500

    Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request

No Sample Response

This method does not specify any sample responses.

id=curlclassName=tab-item-selected
Privacy statement
Terms of Use
Accessibility
Glossary
Submitting feedback