订购机笼护送
先决条件
-
身份验证 - 请提交您的用户凭据、客户端 ID 和客户端密钥以进行 OAuth2 身份验证。有关如何调用 OAuth API 来验证和确认您的凭据的说明，请参阅API 身份验证。
-
获取工作访问订单号 - 向
/colocations/v2/orders/{orderId}发送GET请求%20Order%要获取已安排的工作访问的订单号，请使用20details)端点。要安排新的工作访问，请向colocations/v2/orders/workVisits端点发送POST请求。%20Work%20Visit%20Services）端点。您必须拥有“IBX Access Services”权限才能安排工作访问。如果您已有工作访问订单号，则可以跳过此步骤。 -
要获取“智能搬运”详情，用户必须拥有“智能搬运”订购权限。
-
获取 Smart Hands 订单类型 - 向
/v1/orders/smarthands/types端点发送GET请求，即可获取所有 Smart Hands 订单类型。如果您已经知道 Smart Hands 订单类型，则可以跳过此步骤。 -
获取位置信息 - 向
/v1/orders/smarthands/locations端点发送GET请求，以检索您有权访问的可用 IBX 位置。如果您已经知道位置信息，则可以跳过此步骤。
订购机笼护送 - 简单示例
要为访客订购 IBX 安全护送以进入您的笼子，请向 /smarthands/cageEscort 端点发送 POST 请求。
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 安全护送服务以进入您的笼舍，请向 /smarthands/cageEscort 端点发送 POST 请求。请在请求正文中提供服务详情。使用 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 参考。