订购机笼护送
先决条件
-
身份验证-提交您的用户凭据，客户端ID和客户端机密以进行OAuth2身份验证。有关如何调用OAuth API以验证和验证凭据的说明，请参阅API身份验证。
-
获取工作访问订单号-向端点发送
GET请求/colocations/v2/orders/{orderId}，以检索已安排的工作访问的订单号。要安排新的工作访问，请向端点发送POST请求colocations/v2/orders/workVisits。您必须具有IBX Access Services安排工作访问的权限。如果您已经拥有工作访问订单号，则可以跳过此步骤。 -
要获取Smart Hands详细信息，用户必须具有
Smart Hands订购权限。 -
获取Smart Hands类型-向端点发送
GET请求/v1/orders/smarthands/types以获取所有Smart Hands订单类型。如果您已经知道Smart Hands订单类型，则可以跳过此步骤。 -
获取位置信息-向端点发送
GET请求/v1/orders/smarthands/locations以检索您有权访问的可用IBX位置。如果您已经知道位置信息，则可以跳过此步骤。
订购机笼护送 - 简单示例
要为访客订购IBX安全护送以访问您的笼子，请向端点发送POST请求/smarthands/cageEscort。
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"
}
]
}'
示例回答：
{
"OrderNumber": "1-19876653568916"
}
响应表明订单已成功，并返回订单号。
订购机笼护送 - 扩展示例
cURL 请求示例：
要为访客订购IBX安全护送以访问您的笼子，请向端点发送POST请求/smarthands/cageEscort。在请求正文中提供服务详细信息。使用attachments对象包括技术人员的其他详细信息。
在创建带有附件的订单之前，请调用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"
}
]
}'
有关主体参数和说明的完整列表, 请参见API参考。