Skip to main content

Retrieve support cases

Contributors

GET /ipa/support/case-search

Retrieve a list of support cases according to filter parameters.
Token usage: Both a BlueXP user token and service token. The service token needs to include the following scopes: %scopes%. Pass the user token in the %userTokenHeader% request header and the service token in the %serviceTokenHeader% request header.

Parameters

Name Type In Required Description

nssKeyId

string

query

True

accountId

string

query

True

numberOfResults

integer

query

False

offset

integer

query

False

filter

string

query

False

Can contain the following fields: dateStart, dateEnd, systemSerialNumber, referenceNumber, caseStatus, caseNumber,allCasesByOwnerCompany,allCasesByCaseContact,systemCloudID. Filter items by property values and supported data operators are (eq, and) e.g. caseNumber eq 205656565 and caseStatus eq Open

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response
Name Type Required Description

caseList

array[caseList]

False

totalResultsNumber

integer

False

Example response
{
  "caseList": [
    {
      "caseNumber": "string",
      "symptom": "string",
      "systemSerialNumber": "string",
      "dateOpened": "string",
      "dateUpdated": "string",
      "priority": "Low",
      "status": "Unassigned",
      "clusterName": "string",
      "caseAssignedToContact": "string",
      "caseOwnerCompany": "string",
      "caseContact": "string"
    }
  ]
}

Response

Status: 4xx, Error response
Name Type Required Description

error

string

False

Error code/category

message

string

False

Error description message

Example response
{
  "error": "string",
  "message": "string"
}

Definitions

See Definitions

caseList

Name Type Required Description

caseNumber

string

False

symptom

string

False

systemSerialNumber

string

False

dateOpened

string

False

dateUpdated

string

False

priority

False

status

False

clusterName

string

False

caseAssignedToContact

string

False

caseOwnerCompany

string

False

caseContact

string

False

numberOfResults

integer

False

offset

integer

False

Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response