Commander une cage d'escorte

Conditions préalables

1. Authentifier - soumettre vos informations d'identification utilisateur, ID client et secret client pour l'authentification OAuth2. Reportez-vous à authentification API pour obtenir des instructions sur la façon d'appeler le API OAuth pour valider et authentifier vos informations d'identification.

2. Obtenir un numéro de commande de visite de travail - Envoyer une GET demande au /colocations/v2/orders/{orderId}point de terminaison pour récupérer un numéro de commande pour une visite de travail qui a déjà été planifiée. Pour planifier une nouvelle visite de travail, envoyez une POST demande au colocations/v2/orders/workVisitsnoeud final. Vous devez être IBX Access Services autorisé à planifier une visite de travail. Vous pouvez ignorer cette étape si vous avez déjà le numéro de commande de visite de travail.

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

4. Get Smart Hands types - envoie une GET demande au /v1/orders/smarthands/typesnoeud final pour obtenir tous les types de commande Smart Hands. Vous pouvez ignorer cette étape si vous connaissez déjà le type de commande Smart Hands.

5. Obtenir des informations sur l'emplacement : envoyez une GET demande au /v1/orders/smarthands/locationsnoeud final pour récupérer les emplacements IBX disponibles auxquels vous avez accès. Vous pouvez ignorer 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 POST demande au /smarthands/cageEscortterminal.

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 accède à votre cage, envoyez une POST demande au /smarthands/cageEscortterminal. Indiquez les détails du service dans le corps de la demande. Utilisez l'attachmentsobjet pour inclure des détails supplémentaires pour un technicien.

note

Avant de créer une commande avec pièce jointe, appelez le Attachments File noeud final.

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