Skip to main content
API docs by Redocly

Smart Hands (1.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Request cage assistance, custom installation and equipment troubleshooting.

Smarthands

Request equipment installation per your specifications by an IBX Technician

Request equipment installation per your specifications by an IBX Technician

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object
deviceLocation
required
string

Device Location

elevationDrawingAttached
required
boolean

Elevation drawing attached?

installationPoint
required
string

Installation Point

installedEquipmentPhotoRequired
required
boolean

Installed Equipment Photo Required?

mountHardwareIncluded
required
boolean

Mount hardware included?

patchDevices
required
boolean

Patch Devices?

patchingInfo
string

Patching info

powerItOn
required
boolean

Power it on?

needSupportFromASubmarineCableStationEngineer
boolean (Need Support From Submarine Cable Station Engineer)

This flag is only applicable to Submarine Cable IBXs

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request inbound shipment unpacking and packaging disposal.

This API is used to request inbound shipment unpacking and packaging disposal.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Shipment Unpacking

inboundShipmentOrderNumber
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Inbound Shipment Order Number

copyOfPackingSlipNeeded
required
boolean

Copy of Packaging Slip Needed?

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

discardShipmentMaterial
required
boolean

Discard Shipment Material?

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

This API is used to request a patch cable to be moved between devices.

This API is used to request a patch cable to be moved between devices.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Move Jumper Cable Service Details Object. Please fill out the Cable ID, Current Device (Name, Slot, Port) and New Device (Name, Slot, Port) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'currentDeviceDetails' and 'newDeviceDetails' objects are mandatory.

quantity
required
string
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "12+"

Quantity.

cableId
string

Enter Cable ID or ‘None’ if not applicable. This field is mandatory if 'Quantity' is 1.

object (Device)
name
required
string <= 200 characters

Device name

slot
required
string <= 50 characters

Device slot

port
required
string <= 50 characters

Device port

object (Device)
name
required
string <= 200 characters

Device name

slot
required
string <= 50 characters

Device slot

port
required
string <= 50 characters

Device port

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request a patch cable to be moved between devices

This API is used to request a patch cable to be moved between devices

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Escort to Open Cage/Open Cabinet

durationVisit
required
string
Enum: "30 Minutes" "60 Minutes" "90 Minutes" "2 Hours" "2 Hours 30 Minutes" "3 Hours" "3 Hours 30 Minutes" "4 Hours"

Duration of the visit for the Visitor

openCabinetForVisitor
required
boolean

Open the Cabinet for the Visitor?

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

supervisionReqForVisitor
required
boolean

Supervision Required For the Visitor?

workVisitOrderNumber
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Work Visit Order Number

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Get the location of your package(s) at an IBX.

This API is used to get the location of your package(s) at an IBX.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Shipment Unpacking

shipmentOrderNumber
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Inbound Shipment Order Number

trackingNumber
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Tracking Number

possibleLocation
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Possible Location

packageDescription
required
string^[ A-Za-z0-9~!|\[\]@#$%^&*()_+:"<>?\/.,;'=\-\...

Package Description

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request an IBX Technician to provide cage-related pictures or documentation.

Request an IBX Technician to provide cage-related pictures or documentation.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object
cameraProvidedBy
string
Enum: "Equinix" "Customer"

Who is providing the camera? If documentOnly is false, this field is mandatory.

specificDateAndTime
boolean

Would you like to request a specific date and time? If true, Scheduling should not be STANDARD. If documentOnly is false, this field is mandatory.

documentOnly
required
boolean

Do you need documents or pictures? Set true if you need documents.

description
string

Descrption of the Photo/Document. If documentOnly is false, this field is mandatory.

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request installation of a cross connect patch cable by an IBX Technician.

Request installation of a cross connect patch cable by an IBX Technician.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object
required
Array of objects (Cross Connect for Install)
Array
serialNumber
required
string

Cross Connect serialNumber

deviceCabinet
required
string

Cross Connect Cabinet

deviceConnectorType
required
string

Cross Connect Device Connector Type

deviceDetails
required
string

Cross Connect Device Details

devicePort
required
string

Cross Connect Device Port

lightLinkVerification
boolean

Cross Connect Light Link Verification (Optional). Select this option if you would like a light reading provided and tx/rx verification after the cross connect is completed. In order to verify the correct transmit/receive alignment, please ensure your Z-Side Cross Connect Partner has their end fully extended to their equipment and their port is enabled. A separate billable activity will be created.

scopeOfWork
string [ 1 .. 4000 ] characters

Scope of work

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request removal of a cross connect cable by an IBX Technician.

Request removal of a cross connect cable by an IBX Technician.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object
required
Array of objects (Cross Connect for Removal)
Array
serialNumber
required
string

Cross Connect serialNumber

deviceCabinet
required
string

Cross Connect Cabinet

deviceConnectorType
required
string

Cross Connect Device Connector Type

deviceDetails
required
string

Cross Connect Device Details

devicePort
required
string

Cross Connect Device Port

removePatchCableWithLiveTraffic
boolean

Proceed with the de-install if live traffic is detected (Optional). By selecting this option, I agree to the terms of removal with live traffic. Please be advised that Equinix will complete the requested removal based on your instruction and will not be responsible for any service outages resulting from this removal.

scopeOfWork
string [ 1 .. 4000 ] characters

Scope of work

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request trash removal or cage cleanup

This API is used to request trash removal or cage cleanup

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Contact Info) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Cage Cleanup

permissionToDiscardBoxes
required
boolean

Permission To Discard Boxes?

dampMoistMopRequired
required
boolean

Is Damp Moist Mop Requested?

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

This API is used to request cables per your specifications for your equipment.

This API is used to request cables per your specifications for your equipment.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Please fill out the Media Type, Connector Type and Length (Specify in cm or ft) for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 10 cables, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'Media Type', 'Connector Type' and 'Length (feet/cm)' objects are mandatory.

mediaType
string
Enum: "Multi-mode 62.5mic" "Multi-mode 50mic" "Single-mode" "Cat-5" "Cat-6" "Coax" "POTS" "T1" "E1"

Media Type.

connectorType
string
Enum: "RJ45" "SC" "LC" "BNC" "Other"

Connector Type.

length
string [ 1 .. 50 ] characters

Length (feet/cm).

quantity
required
string
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" ">10"

Quantity

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

This API is used to request a jumper cable to be ran between devices.

This API is used to request a jumper cable to be ran between devices.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Move Jumper Cable Service Details Object. Please fill out the Media Type, Connector Type, Cable ID(optional), 'Should Equinix provide you Tx/Rx light levels, Yes Or No?', Devices to Connect details for Device#1 (Name/Panel, Device Slot, Device Ports) and Device#2(Optional) (Name/Panel, Device Slot, Device Ports) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. If any device is being shipped to Equinix, please include the shipment number. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If ‘Quantity’ is 1, then ‘Jumper Type’, Media Type, Connector Type, 'Should Equinix provide you Tx/Rx light levels?' and Device details are mandatory.

quantity
required
string
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "12+"

Quantity.

jumperType
string
Enum: "Jumper" "Pre-Wiring" "Patch Cable" "Other"

Jumper Type

mediaType
string
Enum: "Multi-mode 62.5mic" "Multi-mode 50mic" "Single-mode" "Cat-5" "Cat-6" "Coax" "POTS" "T1" "E1"

Media Type

connector
string
Enum: "RJ45" "SC" "LC" "BNC" "Other"

Connector Type

cableId
string

Cable ID

provideTxRxLightLevels
boolean

Provide Tx/Rx Light Levels

Array of objects (Device)
Array
name
required
string <= 200 characters

Device name

slot
required
string <= 50 characters

Device slot

port
required
string <= 50 characters

Device port

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Request a Smart Hands order not listed in catalogue

This API is used to request a Smart Hands order not listed in catalogue

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json
customerReferenceNumber
string (Customer Reference Number) [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required

number
string <= 20 characters

Purchase Order Number

purchaseOrderType
required
string
Enum: "EXISTING" "EXEMPTED"

Purchase Order Selection Type

required
object (IBX Location)

IBX, Cage, Accounts and Cabinet information

ibx
required
string [ 1 .. 10 ] characters
required
Array of objects non-empty
Array (non-empty)
cage
required
string non-empty
accountNumber
required
string non-empty
cabinets
Array of strings
required
Array of objects (Order Contacts Array) >= 3 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.

Array (>= 3 items)
contactType
required
string
Enum: "TECHNICAL" "ORDERING" "NOTIFICATION"

Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL

userName
string

User Name

name
string^[\s.]*([^\s.][\s.]*){0,100}$

Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'

email
string <= 100 characters ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@...

Valid email address of the contact

workPhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Primary Phone of the contact

workPhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Primary Phone of the contact

workPhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

mobilePhoneCountryCode
string [ 1 .. 6 ] characters ^\+[0-9]{1,6}$

Country Code of Mobile Phone of the contact

mobilePhone
string [ 1 .. 40 ] characters ^[0-9\.\-() ]{2,40}(?:(x|ext)[0-9\.\-() ]{1,1...

Mobile Phone of the contact

mobilePhonePrefToCall
string
Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS"

Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release

workPhoneTimeZone
string <= 40 characters

Work Phone TimeZone

mobilePhoneTimeZone
string <= 40 characters

Mobile Phone TimeZone

required
object (Schedule Info)

Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.

scheduleType
required
string
Enum: "STANDARD" "EXPEDITED" "SCHEDULED_MAINTENANCE"

STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance

requestedStartDate
string <date-time>

Requested Start Date Time (ISO Date)
Cannot Past Date.

requestedCompletionDate
string <date-time>

Requested Completion Date Time (ISO Date)
Cannot Past Date.

Array of objects (Attachments Array) <= 5 items

Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.

Array (<= 5 items)
id
required
string non-empty

Attachement Id generated from Attachment Api

name
required
string non-empty

Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api

required
object

Other

scopeOfWork
required
string (Scope Of Work) [ 1 .. 4000 ] characters

Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.

Responses

Request samples

Content type
application/json
{
  • "customerReferenceNumber": "RSS41244",
  • "purchaseOrder": {
    },
  • "ibxLocation": {
    },
  • "contacts": [
    ],
  • "schedule": {
    },
  • "attachments": [
    ],
  • "serviceDetails": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "ticketId": "190619221547671"
}

Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user

Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user

query Parameters
detail
boolean
Default: false

When enable this flag returns detailed permission with Cage & Cabinets.

ibxs
string

Example: AM1,AM2

cages
string

Example: AM1:02:002MC1

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json
Array of objects (Location)
Array
ibx
required
string

Ibx Name

required
Array of objects (Cage)

List of cage

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

All supported smart hands types API.

Smart Hands Types API provides all types of supported smart hands.

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json
Array of objects (Smart hands Type)
Array
type
required
string
Enum: "EQUIPMENT_INSTALL" "CAGE_CLEANUP" "CAGE_ESCORT_OPEN_CABINET" "SHIPMENT_UNPACKING" "OTHER"

Smarthand Type

typeDescription
required
string

Description of Smarthand Type

Response samples

Content type
application/json
{
  • "smarthands": [
    ]
}