Commander l'installation de l'équipement

Préalable
-
Pour obtenir les détails de Smart Hands, vous devez avoir l'autorisation
Smart Hands. -
Authentification: soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète pour l’authentification OAuth2. Consultez la documentation relative à l’authentification API (Authentification API) pour savoir comment appeler l’API OAuth afin de valider et d’authentifier vos identifiants.
-
Obtenir les types de commandes Smart Hands: envoyez une requête
GETau point de terminaison/v1/orders/smarthands/typespour obtenir tous les types de commandes Smart Hands. Vous pouvez sauter cette étape si vous connaissez déjà le type de commande Smart Hands. -
Récupérer les informations de localisation: envoyez une requête
GETau point de terminaison/v1/orders/smarthands/locationspour obtenir les emplacements IBX disponibles auxquels vous avez accès. Vous pouvez sauter cette étape si vous connaissez déjà les informations de localisation.
Commande d'installation d'équipement - exemple minimal
Pour commander l'installation d'un équipement par un technicien Equinix IBX, envoyez une requête POST au point de terminaison /v1/orders/smarthands/equipmentInstall. Précisez vos exigences d'installation dans le corps de la requête.
Exemple de requête cURL:
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"
}
]
}'
Exemple de réponse:
{
"OrderNumber": "1-190986534844"
}
La réponse indique que la commande a été prise en compte et retourne le numéro de commande.
Commande d'installation d'équipement - exemple étendu
Pour commander l'installation d'un équipement par un technicien Equinix IBX, envoyez une requête POST au point de terminaison /v1/orders/smarthands/equipmentInstall. Précisez vos besoins d'installation dans le corps de la requête. Utilisez l'objet « accessoires » pour fournir des renseignements supplémentaires au technicien.
Avant de créer une commande avec pièce jointe, appelez le point de terminaison Attachments File.
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"
}
]
}'
Pour une liste complète des paramètres et descriptions du corps, voir la référence de l'API.