Commander une escorte de cage

Conditions préalables
-
Authentifier - envoyez vos identifiants utilisateur, votre identifiant client et votre secret client pour l'authentification OAuth2. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.
-
Obtenir un numéro de commande de visite de travail - envoyez une
GETdemande au/colocations/v2/orders/{orderId}terminal pour récupérer un numéro de commande pour une visite de travail qui a déjà été programmée. Pour planifier une nouvelle visite de travail, envoyez unePOSTdemande aucolocations/v2/orders/workVisitsterminal. Vous devez êtreIBX Access Servicesautorisé à planifier une visite de travail. Vous pouvez sauter cette étape si vous disposez déjà du numéro de commande de visite de travail. -
Pour obtenir les détails Smart Hands, l'utilisateur doit disposer
Smart Handsd'autorisations de commande. -
Obtenir les types de Smart Hands - envoyez une
GETdemande au/v1/orders/smarthands/typesterminal 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. -
Obtenir des informations de localisation : envoyez une
GETdemande au/v1/orders/smarthands/locationspoint 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 puisse accéder à votre cage, envoyez POSTune 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 é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 commander une escorte de sécurité IBX pour qu’un visiteur puisse accéder à votre cage, envoyez POSTune 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 sur un technicien.
Avant de créer une commande avec pièce jointe, appelez le Attachments File terminal.
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 obtenir une liste complète des paramètres corporels et des descriptions, reportez-vous à la référence API .