Orders | Equinix Product Documentation

Add notes to an order

This method adds notes to an order by its ID for a user with permission to view this request.

Security

BearerAuth

orderIdstring, [ 1 .. 100 ] charactersrequired

Identifier of the order

Example:{orderId}

Bodyapplication/json

The Order Id to be updated

referenceIdstring, [ 1 .. 50 ] characters

Unique reference ID associated with notes.

Example:"{orderId}"

textstring, [ 5 .. 4000 ] charactersrequired

The text of the note

Example:"The text of the note"

attachmentsArray of objects, <= 5 items(Attachment)

File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.

Payload

{
  "text": "problem description",
  "attachments": [
    { … }
  ]
}

Accepted

Headers

Locationstring

Location of an order "/orders/1-23232322"

Example:"/orders/1-23232322"

Response

No content