Case Management API | Equinix Product Documentation

Get a trouble ticket by case / order number

Request

This method get a trouble ticket by case or order number.

Security

BearerAuth

Path

idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)required

Case or Order Number.

Example:ex: 11150929 or 1-204976070710

Payload

// No request payload

Responses

OK

Bodyapplication/json

idstring, [ 8 .. 100 ] characters(CaseOrOrderNumber)

Case or order number.

Example:"ex: 11150929 or 1-204976070710"

accountNumberstring, [ 6 .. 100 ] characters(AccountNumber)

User account number.

Example:"182389736"

accountNamestring(AccountName)

User account name.

Example:"VjT Existing Reseller New BA"

customerReferenceIdstring

Additional information for customer to reference.

Example:"EESkFTupLmnF6KinbARfNgWAC2V1BZbDZKluF5TI5YVTXTfGkF"

channelstring

Channel through which the case was created.

Enum:"OFFLINE""PORTAL"

Example:"PORTAL"

orderIdstring, [ 14 .. 100 ] characters(OrderNumber)

Order number.

Example:"1-204976070710"

locationobject

statusstring(StatusResponse)

Case status.

Enum:"SUBMITTED""IN_PROGRESS""RESOLVED""ACTION_REQUIRED""CLOSED""CANCELLED"

Example:"IN_PROGRESS"

contactsArray of objects(ContactResponse)

Contacts

notesArray of objects

attachmentsArray of items(Attachments)

emailArray of items(Emails)

createdDateTimestring, (date-time)(Datetime)

A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.

Example:"2023-08-29T04:01:43Z"

otherDetailsobject

Response

{
  "id": "ex: 11150929 or 1-204976070710",
  "accountNumber": "182389736",
  "accountName": "VjT Existing Reseller New BA",
  "customerReferenceId": "EESkFTupLmnF6KinbARfNgWAC2V1BZbDZKluF5TI5YVTXTfGkF",
  "channel": "PORTAL",
  "orderId": "1-204976070710",
  "location": {
    "ibx": [ … ]
  },
  "status": "IN_PROGRESS",
  "contacts": [
    { … }
  ],
  "notes": [
    { … }
  ],
  "attachments": [
    [ … ]
  ],
  "email": [
    [ … ]
  ],
  "createdDateTime": "2023-08-29T04:01:43Z",
  "otherDetails": {
    "contactUCMID": "236284",
    "recordType": "ECM",
    "subChannel": "ECP",
    "finalScheduledDate": "2023-08-29T04:01:43Z",
    "category": "Trouble Services",
    "subCategory": "Incident",
    "description": "Sample description.",
    "updatedDateTime": "2023-08-29T04:01:43Z",
    "updatedByFullName": "0052H000003iLJjQAM",
    "requestedTerminationDate": "2026-09-01",
    "statusHistory": [ … ],
    "purchaseOrders": [ … ],
    "products": [ … ],
    "productOfferingCodes": [ … ],
    "details": [ … ],
    "additionalInfo": [ … ],
    "modifiable": false,
    "reOpen": false,
    "cancellable": true,
    "respond": true
  }
}