Nettoyage des cages de commande

Conditions préalables

1. Pour obtenir les détails de Smart Hands, vous devez avoir la permission Smart Hands.

2. Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.

3. Obtenir les types de 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. Obtenir des informations sur la localisation - Envoyez une requête GET au point de terminaison /v1/orders/smarthands/locations pour récupérer les localisations IBX disponibles auxquelles 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 l'enlèvement des ordures ou le nettoyage d'une cage spécifique, envoyez une requête POST au point de terminaison /smarthands/cageCleanup. Spécifiez le lieu, l'horaire, les contacts et les détails du service dans le corps de la demande.

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 du corps et des descriptions, voir la référence API.

Exemple de réponse :

{  
    "OrderNumber": "1-190368976438"  
}

La réponse indique que la commande a abouti et renvoie le numéro de commande.

Commander un nettoyage de cage - exemple détaillé

Pour commander l'enlèvement des ordures ou le nettoyage d'une cage spécifique, envoyez une requête POST au point de terminaison /smarthands/cageCleanup. Spécifiez le lieu, l'horaire, les contacts et les détails du service dans le corps de la requête. Utilisez l'objet attachments pour inclure des détails supplémentaires pour un technicien.

note

Avant de créer une commande avec une pièce jointe, appelez le Fichier de pièces jointes.

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 du corps et des descriptions, voir la référence API.