Smarthands (V1)

Smarthands (V1) API allows a user with Smart Hands ordering permission to get the available Smart Hands types, the permitted Smart Hands location information, as well as place Smart Hands orders.

To create different types of Smart Hands orders, see Create Smart Hands Order in the Getting Started section.

GET Smart Hands Types

	GET /smarthands/types
Method	GET
URL or End Point	/v1/orders/smarthands/types
Headers	Authorization, Content-Type
Query Parameters	Not applicable
Body	Not applicable

The Get smarthands types API returns all Smart Hands services available to the user with 'Smart Hands' permission. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The response returns all the Smart Hands services the user is permitted to order from the Equinix Customer Portal.

curl -X
GET "https://api.equinix.com/v1/orders/smarthands/types"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

{
  "smarthands": [
    {
      "type": "UNRACK_UNINSTALL_EQUIP",
      "typeDescription": "Unrack/Uninstall Equipment"
    },
    {
      "type": "PICTURES_DOCUMENT",
      "typeDescription": "Pictures/Document"
    },
    {
      "type": "CAGE_CLEANUP",
      "typeDescription": "Cage Clean Up"
    },
    {
      "type": "SHIPMENT_UNPACKING",
      "typeDescription": "Shipment Unpacking"
    },
    {
      "type": "CABLE_REQUEST",
      "typeDescription": "Request for Cables"
    },
    {
      "type": "LOCATE_PACKAGE",
      "typeDescription": "Locate Package"
    },
    {
      "type": "EQUIPMENT_INSTALL",
      "typeDescription": "Equipment Install"
    },
    {
      "type": "POWER_CIRCUIT_ENERGIZE_DE_ENERGIZE",
      "typeDescription": "Power Circuit Energize / De-Energize"
    },
    {
      "type": "LIGHT_LINK_TESTING",
      "typeDescription": "Light-Link Verification"
    },
    {
      "type": "RUN_JUMPER_PATCH_CABLE",
      "typeDescription": "Run Jumper/Patch Cable"
    },
    {
      "type": "CAGE_ESCORT_OPEN_CABINET",
      "typeDescription": "Escort to Cage/Open Cabinet"
    },
    {
      "type": "PATCH_CABLE_INSTALL",
      "typeDescription": "Patch Cable Install"
    },
    {
      "type": "OTHER",
      "typeDescription": "Other"
    },
    {
      "type": "PATCH_CABLE_REMOVAL",
      "typeDescription": "Patch Cable Removal"
    },
    {
      "type": "MOVE_JUMPER_PATCH_CABLE",
      "typeDescription": "Move Jumper/Patch Cable"
    },
    {
      "type": "SMART_HANDS_REPORT",
      "typeDescription": "Reports"
    }
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
smarthands	array [objects]		The Smart Hands orders available to the user.
type	string	UNRACK_UNINSTALL_EQUIP	The Smart Hands order types that are available to the user.
typeDescription	string	Unrack/Uninstall Equipment	A short description of the corresponding type of Smart Hands order.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Smarthands Locations

	GET /smarthands/locations
Method	GET
URL or End Point	/v1/orders/smarthands/locations
Headers	Authorization, Content-Type
Query Parameters	detail, ibxs, cages
Body	Not applicable

The Get smarthands locations API returns all available IBX locations, cages, and cabinets where a user has 'Smart Hands' permission. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.

The following screenshots show a sample curl request and JSON response for this API. The response indicates the IBX, cage, and account information for the cage, NY9:09:092630, in IBX location, NY9, that the user had access to.

curl -X
GET "https://api.equinix.com/v1/orders/smarthands/locations?detail=true&ibxs=NY9&cages=NY9:09:092630"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

The description of the query parameters is as follows:

Query Parameter Name	Mandatory	Type	Example	Applicable Values	Description
detail	No	boolean	true	true false	Defines if the information returned is detailed. If 'true', IBX location code and detailed cage and cabinet information would be returned. If 'false', the only information returned would be IBX location code. Default value: false.
ibxs	No	string	NY9		The IBXs that the user has access to. These are represented by the IBX location codes. E.g. AM1 represents an IBX in Amsterdam, Netherlands. By specifying single or multiple IBX location codes (ex: AM1 or AM1, AM2, AM3), the constraint is placed on specific IBXs. Default value: all IBXs where the user has this permission
cages	No	string	NY9:09:092630		ID of cage that the user has access to. By specifying single or multiple cage IDs (ex: AM1:0G:00EQ11 or AM1:0G:00EQ11, AM1:0G:00EQ11-1), the constraint is placed on specific cages. Default value: all cages where the user has this permission

Query Parameter Name

Mandatory

Type

Example

Applicable Values

Description

detail

boolean

true

true
false

Defines if the information returned is detailed.

If 'true', IBX location code and detailed cage and cabinet information would be returned.

If 'false', the only information returned would be IBX location code.

Default value: false.

ibxs

string

NY9

The IBXs that the user has access to. These are represented by the IBX location codes.

E.g. AM1 represents an IBX in Amsterdam, Netherlands.

By specifying single or multiple IBX location codes (ex: AM1 or AM1, AM2, AM3), the constraint is placed on specific IBXs.

Default value: all IBXs where the user has this permission

cages

string

NY9:09:092630

ID of cage that the user has access to.

By specifying single or multiple cage IDs (ex: AM1:0G:00EQ11 or AM1:0G:00EQ11, AM1:0G:00EQ11-1), the constraint is placed on specific cages.

Default value: all cages where the user has this permission

{
  "locations": [
    {
      "ibx": "NY9",
      "cages": [
        {
          "cage": "NY9:09:092630",
          "cageTypes": [
            "Shared"
          ],
          "accounts": [
            {
              "number": "987",
              "name": "JOHN DOE CORPORATION",
              "poTracking": false,
              "pricingEnabled": false,
              "pricingEnforced": false,
              "cabinets": [
                {
                  "cabinet": "NY9:09:092630:0911",
                  "cabinetReference": "12312149",
                  "cabinetType": "Cabinet"
                },
                {
                  "cabinet": "NY9:09:092630:0912",
                  "cabinetReference": "12312150",
                  "cabinetType": "Cabinet"
                }
              ],
              "isCreditHold": false,
              "isPOBearing": false,
              "isMonetAccount": false
            }
          ]
        }
      ]
    }
  ]
}

The description of the response payload is as follows:

Field name	Type	Example	Description
locations	array [objects]		Locations of the IBXs that user has access to.
ibx	string	NY9	The IBX location code.
cages	array [objects]		Cages information that contains cage ID number and cage type details.
cage	string	NY9:09:092630	ID of the cage.
cageTypes	array [string]	Shared	Type of cage. Cage type - Description Shared - Indicates that the cage is shared by more than one customer, so provision of ID of cabinet(s) is mandatory. Private - Indicates that the cage is privately held by one customer, so provision of ID of cabinet(s) is optional. IBXflex - there are no cabinets.
accounts	array [objects]		Cage account information that consists of cage account number, cage account name, purchase order tracking, enabling of pricing, IDs of all cabinets in the respective cage, credit holding status, purchase order bearing status, and MonetAccount status.
number	string	987	The customer account number linked to the cage.
name	string	JOHN DOE CORPORATION	The customer account name linked to the cage.
poTracking	boolean	false	Indicates if purchase order tracking is required for the customer account. You may ignore this.
pricingEnabled	boolean	false	Indicates if the pricing needs to be provided at the time of ordering for this customer account. You may ignore this.
pricingEnforced	boolean	false	Indicates if a pricing acknowledgment needs to be received from user before an order is submitted for this customer account. You may ignore this.
cabinets	array [objects]		All cabinets in the cage that user has access to.
cabinet	string	NY9:09:092630:0911	ID of the cabinet that the user has access to.
cabinetReference	string	12312149	Customer's cabinet reference number.
cabinetType	string	Cabinet	Type of cabinet. Cabinet type - Description Cabinet - Cabinet that is not a demarcation point for a cross connection. Demarcation point - Cabinet that is a demarcation point for a cross connection.
isCreditHold	boolean	false	Credit status of the customer account. If t'rue', customer account is unable to place billable orders. If 'false', customer account is free to make orders.
isPOBearing	boolean	false	Purchase order bearing status of customer account. If 'true', it is mandatory to include the purchase order number when placing billable orders. If 'false', purchase order number is not required.
isMonetAccount	boolean	false	Indicates that this account has cages that require submarine engineering support. If 'true', the field "needSupportFromASubmarineCableStationEngineer" must be provided when placing orders. If 'false', no additional field is required when placing orders.

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Smart Hands Types​

GET Smarthands Locations​

GET Smart Hands Types

GET Smarthands Locations