Skip to main content

Retrieve a list of case notes

GET /ipa/support/case-notes/{caseNumber}

Retrieves a list of case notes.

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

fetchEmail

string

query

False

latestEmailInThread

string

query

False

numberOfResults

integer

query

False

offset

integer

query

False

caseNumber

integer

path

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response
Name Type Required Description

caseNumber

string

False

totalResults

string

False

caseNotes

array[caseNotes]

False
Example response 
{
  "caseNumber": "string",
  "totalResults": "string",
  "caseNotes": [
    {
      "noteType": "string",
      "transactionDescription": "string",
      "transactionID": "string",
      "transactionAssignedTo": "string",
      "transactionStatus": "string",
      "textDetails": "string",
      "createdOnDateTime": "string",
      "createdBy": "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

caseNotes

Name Type Required Description

noteType

string

False

transactionDescription

string

False

transactionID

string

False

transactionAssignedTo

string

False

transactionStatus

string

False

textDetails

string

False

createdOnDateTime

string

False

createdBy

string

False