Skip to main content

Retrieve support cases

GET /ipa/support/case-search

Retrieves a list of support cases according to the filter parameters.

Token usage: Both a NetApp Console user token and service token. The service token needs to include one of the following scopes: 'occm-access', 'ipa-internal'.

Parameters

Name Type In Required Description

nssKeyId

string

query

True

accountId

string

query

True

numberOfResults

integer

query

False

offset

integer

query

False

dateStart

string

query

False

dateEnd

string

query

False

systemSerialNumber

string

query

False

referenceNumber

string

query

False

caseStatus

query

False

caseNumber

integer

query

False

allCasesByOwnerCompany

query

False

allCasesByCaseContact

query

False

systemCloudID

string

query

False

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