Nettoyage de la cage de contrôle

Préalable

1. Pour obtenir les détails de Smart Hands, vous devez avoir l'autorisation Smart Hands.

2. 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.

3. Obtenir les types de commandes Smart Hands: envoyez une requête GET au point de terminaison /v1/orders/smarthands/types pour obtenir tous les types de commandes Smart Hands. Vous pouvez sauter cette étape si vous connaissez déjà le type de commande Smart Hands.

4. Récupérer les informations de localisation: envoyez une requête GET au point de terminaison /v1/orders/smarthands/locations pour obtenir les emplacements IBX disponibles auxquels vous avez accès. Vous pouvez sauter cette étape si vous connaissez déjà les informations de localisation.

Commander un nettoyage de cage - exemple minimal

Pour commander le ramassage des déchets ou le nettoyage d'une cage spécifique, envoyez une requête POST au point de terminaison /smarthands/cageCleanup. Précisez l'emplacement, la fréquence, les contacts et les détails du service dans le corps de la requête.

Exemple de requête cURL:

curl -X  
POST "https://api.equinix.com/v1/orders/smarthands/cageCleanup"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "ibxLocation": {  
    "ibx": "AM1",  
    "cages": [  
      {  
        "cage": "AM1:0J:00JD11",  
        "accountNumber": "126854"  
      }  
    ]  
  },  
  "serviceDetails": {  
    "permissionToDiscardBoxes": true,  
    "dampMoistMopRequired": true,  
    "scopeOfWork": "Light dusting of equipment, microfiber mop to be used."  
  },  
  "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"  
    }  
  ]  
}'

Pour une liste complète des paramètres et descriptions du corps, voir la référence de l'API.

Exemple de réponse:

{  
    "OrderNumber": "1-190368976438"  
}

La réponse indique que la commande a été prise en compte et retourne le numéro de commande.

Commander un nettoyage de cage - exemple détaillé

Pour commander l'enlèvement des déchets ou le nettoyage d'une cage spécifique, envoyez une requête POST au point de terminaison /smarthands/cageCleanup. Indiquez l'emplacement, la date et l'heure, les contacts et les détails du service dans le corps de la requête. Utilisez l'objet « accessoires » pour inclure des renseignements supplémentaires destinés à un technicien.

remarque

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/cageCleanup"  
-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": {  
    "permissionToDiscardBoxes": true,  
    "dampMoistMopRequired": true,  
    "scopeOfWork": "Light dusting of equipment, microfiber mop to be used.",  
    "needSupportFromASubmarineCableStationEngineer": true  
  },  
  "attachments": [  
    {  
      "id": "fcb2k8763-2947-456e-8d68-f280753d60ba",  
      "name": "PhotoForCageCleanupServiceDetails.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.