Skip to main content

Ordering More Cables

Prerequisites

  1. To get Smart Hands details, you must have Smart Hands ordering permission.

  2. Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

  3. Get Smart Hands Types - Send a GET request to the /v1/orders/smarthands/types endpoint to get all Smart Hands order types. You may skip this step if you already know the Smart Hands order type.

  4. Get Location Information - Send a GET request to the /v1/orders/smarthands/locations endpoint to retrieve available IBX locations that you have access to. You may skip this step if you already know the location information.

Ordering Cables - single type of cable

To order cables, send a POST v1/orders/smarthands/cableRequest endpoint. Specify your order details in the body of the request. Use the optional attachments object to include additional details for a technician.

note

Before creating an order with attachment, call the Attachments File endpoint.

curl -X  
POST "https://api.equinix.com/v1/orders/smarthands/cableRequest"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
    "ibxLocation": {
    "ibx": "AM1",
    "cages": [
        {
        "cage": "AM1:0J:00JD11",
        "accountNumber": "126854"
        }
    ]
  },
  "serviceDetails": {
    "quantity": "10",
    "mediaType": "Multi-mode 62.5mic",
    "connectorType": "RJ45",
    "length": "25cm",
    "scopeOfWork": "Refer to attachment.",
    "needSupportFromASubmarineCableStationEngineer": true
  },
  "attachments": [
    {
        "id": "fcb4a673-6308-456e-8f83-f745501d60ba",
        "name": "additionalattachment.docx"
    }
  ],
  "schedule": {
    "scheduleType": "SCHEDULED_MAINTENANCE",
    "requestedStartDate": "2019-08-30T22:00:49.776Z",
    "requestedCompletionDate": "2019-08-31T22:00:49.776Z"
  },
  "customerReferenceNumber": "EQX-PO2019-08-001",
  "purchaseOrder": {
    "purchaseOrderType": "EXEMPTED",
    "attachment": {
        "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",
        "name": "PurchaseOrderExemptionForm123.docx"
    }
  },
  "contacts": [
    {
        "contactType": "ORDERING",
        "userName": "johndoe"
    },
    {
        "contactType": "TECHNICAL",
        "name": "Jane Smith",
        "email": "janesmith@corporation.com",
        "workPhoneCountryCode": "+44",
        "workPhone": "0148211111",
        "workPhonePrefToCall": "MY_BUSINESS_HOURS",
        "workPhoneTimeZone": "Europe/London",
        "mobilePhoneCountryCode": "+44",
        "mobilePhone": "0123456789",
        "mobilePhonePrefToCall": "MY_BUSINESS_HOURS",
        "mobilePhoneTimeZone": "Europe/London"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "johndoe"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "jillsnow"
    }
  ]
}'

Ordering Cables - different cables

To order cables, send a POST v1/orders/smarthands/cableRequest endpoint. Specify your order details in the body of the request. To order multiple cable types, use the serviceDetails.scopeOfWork parameter for the cable types or use the optional attachments object to include the cable types and details for a technician.

note

Before creating an order with attachment, call the Attachments File endpoint.

curl -X  
POST "https://api.equinix.com/v1/orders/smarthands/cableRequest"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
    "ibxLocation": {
    "ibx": "AM1",
    "cages": [
        {
            "cage": "AM1:0J:00JD11",
            "cabinets": [
                "AM1:0J:00JD11:0001"
            ],
            "accountNumber": "126854"
        }
    ]
  },
  "serviceDetails": {
    "quantity": ">10",
    "scopeOfWork": "Refer to attachment.",
    "needSupportFromASubmarineCableStationEngineer": true
  },
  "attachments": [
    {
        "id": "fcb4a673-6308-456e-8f83-f745501d60ba",
        "name": "additionalattachment.docx"
    }
  ],
  "schedule": {
    "scheduleType": "SCHEDULED_MAINTENANCE",
    "requestedStartDate": "2019-08-30T22:00:49.776Z",
    "requestedCompletionDate": "2019-08-31T22:00:49.776Z"
  },
  "customerReferenceNumber": "EQX-PO2019-08-001",
  "purchaseOrder": {
    "purchaseOrderType": "EXEMPTED",
    "attachment": {
        "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",
        "name": "PurchaseOrderExemptionForm123.docx"
    }
  },
  "contacts": [
    {
        "contactType": "ORDERING",
        "userName": "johndoe"
    },
    {
        "contactType": "TECHNICAL",
        "name": "Jane Smith",
        "email": "janesmith@corporation.com",
        "workPhoneCountryCode": "+44",
        "workPhone": "0148211111",
        "workPhonePrefToCall": "MY_BUSINESS_HOURS",
        "workPhoneTimeZone": "Europe/London",
        "mobilePhoneCountryCode": "+44",
        "mobilePhone": "0123456789",
        "mobilePhonePrefToCall": "MY_BUSINESS_HOURS",
        "mobilePhoneTimeZone": "Europe/London"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "johndoe"
    },
    {
        "contactType": "NOTIFICATION",
        "userName": "jillsnow"
    }
  ]
}'

For a complete list of body parameters and descriptions, see the API Reference.

Sample Response:

{  
  "OrderNumber": "1-457809872838"
}

The response indicates the order was successful and returns the order number.