Order equipment installation

Prerequisites

1. To get Smart Hands details, you must have Smart Hands 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.

Order Equipment Installation - minimal example

To order equipment installation by an Equinix IBX Technician, send a POST request to the /v1/orders/smarthands/equipmentInstall endpoint. Specify your installation requirements in the body of the request.

Sample cURL Request:

curl -X  
POST "https://api.equinix.com/v1/orders/smarthands/equipmentInstall"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "ibxLocation": {  
    "ibx": "AM1",  
    "cages": [  
      {  
        "cage": "AM1:0J:00JD11",  
        "accountNumber": "126854"  
      }  
    ]  
  },  
  "serviceDetails": {  
    "deviceLocation": "DHL tracking no. 1039 5739 92",  
    "elevationDrawingAttached": false,  
    "installationPoint": "Front and center.",  
    "patchDevices": true,  
    "patchingInfo": "When patching use the next available port, but maintain a symmetrical appearance.",  
    "powerItOn": true,  
    "mountHardwareIncluded": true,  
    "installedEquipmentPhotoRequired": true,  
    "scopeOfWork": "When installing make sure wires are all labeled."  
  },  
  "schedule": {  
    "scheduleType": "SCHEDULED_MAINTENANCE",  
    "requestedStartDate": "2019-08-30T22:00:49.776Z",  
    "requestedCompletionDate": "2019-08-31T22:00:49.776Z"  
  },  
  "contacts": [  
    {  
        "contactType": "ORDERING",  
        "userName": "johndoe"  
    },  
    {  
        "contactType": "TECHNICAL",  
        "userName": "johndoe",  
        "workPhonePrefToCall": "ANYTIME"  
    },  
    {  
        "contactType": "NOTIFICATION",  
        "userName": "johndoe"  
    }  
  ]  
}'

Sample Response:

{  
"OrderNumber": "1-190986534844"  
}

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

Order Equipment Installation - extended example

To order equipment installation by an Equinix IBX Technician, send a POST request to the /v1/orders/smarthands/equipmentInstall endpoint. Specify your installation requirements in the body of the request. Use the 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/equipmentInstall"  
-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": {  
    "deviceLocation": "DHL tracking no. 1039 5739 92",  
    "elevationDrawingAttached": true,  
    "installationPoint": "Front and center.",  
    "patchDevices": true,  
    "patchingInfo": "When patching use the next available port, but maintain a symmetrical appearance.",  
    "powerItOn": true,  
    "mountHardwareIncluded": true,  
    "installedEquipmentPhotoRequired": true,  
    "scopeOfWork": "When installing make sure wires are all labeled.",  
    "needSupportFromASubmarineCableStationEngineer": true  
  },  
  "attachments": [  
    {  
        "id": "fcb4a673-6308-456e-8f83-f745501d60ba",  
        "name": "Elevation drawing.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": "janesmith"  
    }  
  ]  
}'

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