Commander une escorte de cage

Préalable

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

2. Obtenez un numéro de commande de visite de travail - Envoyez une requête GET à [/colocations/v2/orders/{orderId}](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%Utilisez le point de terminaison 20details pour récupérer le numéro de commande d'une intervention déjà planifiée. Pour planifier une nouvelle intervention, envoyez une requête POST à l'adresse [colocations/v2/orders/workVisits](/api-catalog/workvisitsv2/#tag/Work-Visit/operation/Schedule).%20Work%Point de terminaison 20Visit%20Services). Vous devez avoir l'autorisation IBX Access Services pour planifier une intervention. Vous pouvez sauter cette étape si vous avez déjà le numéro de commande de l'intervention.

3. Pour obtenir les détails de Smart Hands, l'utilisateur doit disposer des autorisations de commande Smart Hands.

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

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

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.

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 été prise en compte et retourne le numéro de commande.

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

Exemple de requête cURL:

Pour demander l'escorte d'un agent de sécurité IBX pour l'accès à votre cage, envoyez une requête POST au point de terminaison /smarthands/cageEscort. Indiquez les détails du service dans le corps de la requête. Utilisez l'objet « accessoires » pour fournir des renseignements supplémentaires au 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/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 et descriptions du corps, consultez la référence de l'API.