Case Management API | Equinix Product Documentation

Create a trouble ticket / case

Request

This method create a trouble ticket or case.

Security

BearerAuth

Bodyapplication/json

codestringrequired

Ticket code.

Enum:"0000-0000""0000-0002""0002-0000""0002-0001""0003-0000""0003-0001""0003-0002""0003-0003""0004-0000""0004-0001"

Example:"0200-0000"

descriptionstring, [ 1 .. 4000 ] charactersrequired

Description of the trouble or issue.

Example:"The device is overheating and causing performance issues."

primaryIdstring, [ 1 .. 100 ] characters

Primary reference identifier.

Example:"__ENTER_DEVICE_UUID_HERE__"

secondaryIdstring, [ 1 .. 100 ] characters

Secondary reference identifier.

Example:"__ENTER_SECONDARY_ID_HERE__"

occurredDateTimestring, (date-time)

Date and time the issue occurred.

Example:"2020-05-22T19:23:51Z"

customerReferenceIdstring, [ 1 .. 200 ] characters

Customer or external reference number.

Example:"CustomerReference001"

attachmentsArray of objects, [ 0 .. 5 ] items(Attachment)

Supporting files to attach in the ticket, such as a picture of a broken device.

contactsArray of any

List of persons who will be contacted for this ticket.

details0302-0400 (object) or 0302-0500 (object) or 0302-0600 (object) or 0305-0000 (object) or 0305-0002 (object) or 0305-0100 (object) or 0305-0200 (object) or 0305-0300 (object) or 0305-0301 (object) or 0305-0302 (object) or 0306-0000 (object) or 0306-0100 (object) or 0306-0200 (object) or 0306-0300 (object) or DigitalProductDetails (object)

Any of:

List of additional details or requirements to support ticket resolution, depending on the issues you are facing.

Payload

{
  "code": "0305-0000",
  "customerReferenceId": "111111111",
  "description": "Enter any modification details/additional notes to the technician here.",
  "primaryId": "__ENTER_ACCOUNT_NUMBER_HERE__",
  "attachments": [
    { … },
    { … }
  ],
  "details": {
    "documents": { … }
  },
  "contacts": [
    { … },
    { … },
    { … }
  ]
}

Responses

OK

Bodyapplication/json

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

Case or order number.

Example:"ex: 11150929 or 1-204976070710"

typestringrequired

Ticket type.

Enum:"CASE""TROUBLE"

Example:"CASE"

Response

{
  "id": "ex: 11150929 or 1-204976070710",
  "type": "CASE"
}

Trouble Ticket / Case

Create a trouble ticket / case

Request

Responses