Scheduling Work Visits | Equinix Product Documentation

Schedule Work Visit Services

Request

This method creates a work visit request that grants IBX visitors access for up to two weeks. This can only be done by a user with work visit request permission.

Security

BearerAuth

Bodyapplication/json

descriptionstring, [ 10 .. 4000 ] characters

Description of the Work Visit

Example:"Monthly Routine check"

customerReferenceIdstring, [ 1 .. 40 ] characters

Customer Reference Number / External Reference Number

Example:"048837d6-4cd8-401f-ba41-a4ac015c3f3e"

purchaseOrderobject(purchaseOrder)

Purchase Order

attachmentsArray of objects, <= 5 items(Attachment)

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

contactsArray of any

The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, specify the Technical contact and Notification contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users).

detailsobject(workvisit_additional_details)required

Payload

{
  "description": "Monthly Routine check",
  "customerReferenceId": "048837d6-4cd8-401f-ba41-a4ac015c3f3e",
  "purchaseOrder": {
    "type": "EXISTING",
    "number": 1091238010,
    "amount": "2020",
    "startDate": "2020-05-22",
    "endDate": "2021-05-22",
    "attachmentId": "8d0bef9c-cca9-11ea-87d0-0242ac130003"
  },
  "attachments": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "details": {
    "cages": [ … ],
    "openCabinet": false,
    "visitStartDateTime": "2019-08-24T14:15:22Z",
    "visitEndDateTime": "2019-08-24T14:15:22Z",
    "visitors": [ … ]
  }
}

Responses

Created

Headers

Locationstring

Location of Work Visit request "/orders/1-23232322"

Example:"/orders/1-23232322"

Response

No content