Commander une cage d'escorte

Conditions préalables

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

2. Obtenir le numéro de commande d'une visite de travail - Envoyez une requête GET au point de terminaison /colocations/v2/orders/{orderId} pour récupérer le numéro de commande d'une visite de travail qui a déjà été programmée. Pour programmer une nouvelle visite de travail, envoyez une requête POST au point de terminaison colocations/v2/orders/workVisits. Vous devez avoir l'autorisation de IBX Access Services pour planifier une visite de travail. Vous pouvez sauter cette étape si vous avez déjà le numéro de commande de la visite de travail.

3. Pour obtenir les détails de Smart Hands, l'utilisateur doit avoir les permissions de commande Smart Hands.

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

5. 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 une cage d'escorte - exemple minimal

Pour commander une escorte de sécurité IBX pour qu'un visiteur accède à votre cage, envoyez une requête POST au point de terminaison /smarthands/cageEscort.

Exemple de requête cURL :

curl -X  
POST "https://api.equinix.com/v1/orders/smarthands/cageEscort"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "ibxLocation": {  
    "ibx": "AM1",  
    "cages": [  
        {  
        "cage": "AM1:0J:00JD11",  
        "accountNumber": "126854"  
        }  
    ]  
    },  
    "serviceDetails": {  
    "workVisitOrderNumber": "1-19864326570532",  
    "openCabinetForVisitor": true,  
    "supervisionReqForVisitor": true,  
    "durationVisit": "4 Hours",  
    "scopeOfWork": "If staff from customer company is unable to attend, please continue to accompany the visitor."  
    },  
    "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-19876653568916"  
}

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

Commander une cage d'escorte - exemple détaillé

Exemple de requête cURL :

Pour commander une escorte de sécurité IBX pour qu'un visiteur puisse accéder à votre cage, envoyez une requête POST au point de terminaison /smarthands/cageEscort. Fournissez 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/cageEscort"  
-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": {  
        "workVisitOrderNumber": "1-19864326570532",  
        "openCabinetForVisitor": true,  
        "supervisionReqForVisitor": true,  
        "durationVisit": "4 Hours",  
        "scopeOfWork": "If staff from customer company is unable to attend, please continue to accompany the visitor.",  
        "needSupportFromASubmarineCableStationEngineer": true  
    },  
    "attachments": [  
     {  
        "id": "fcb2k8763-2947-456e-8d68-f280753d60ba",  
        "name": "WorkVisitInstructions.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": "jillsnow"  
    }  
  ]  
}'

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