Ordem de escolta de gaiola

Pré-requisitos
-
Autenticar - Envie suas credenciais de usuário, ID do Cliente e Segredo do Cliente para autenticação OAuth2. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
-
Obtenha um número de ordem de visita de trabalho - Envie uma solicitação
GETpara [/colocations/v2/orders/{orderId}](/api-catalog/ordersv2/#tag/Orders/operation/GET%20Order%Para obter o número de um pedido de uma visita técnica já agendada, envie uma solicitaçãoPOSTpara o endpoint[colocations/v2/orders/workVisits](/api-catalog/workvisitsv2/#tag/Work-Visit/operation/Schedule). Para agendar uma nova visita técnica, envie uma solicitaçãoPOSTpara o endpointcolocations/v2/orders/workVisits.%20Work%endpoint 20Visit%20Services). Você precisa ter permissão para agendar uma visita técnica (IBX Access Services). Você pode pular esta etapa se já tiver o número da ordem de serviço da visita técnica. -
Para obter detalhes sobre o Smart Hands, o usuário deve ter permissões de pedido do tipo "Smart Hands".
-
Obtenha os tipos de pedidos Smart Hands - Envie uma solicitação
GETpara o endpoint/v1/orders/smarthands/typespara obter todos os tipos de pedidos Smart Hands. Você pode pular esta etapa se já souber o tipo de pedido Smart Hands. -
Obter informações de localização - Envie uma solicitação
GETpara o endpoint/v1/orders/smarthands/locationspara recuperar os locais IBX disponíveis aos quais você tem acesso. Você pode pular esta etapa se já souber as informações de localização.
Pedido uma acompanhante em Cage - exemplo mínimo
Para solicitar uma escolta de segurança IBX para um visitante acessar sua gaiola, envie uma solicitação POST para o endpoint /smarthands/cageEscort.
Exemplo de solicitação 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"
}
]
}'
Exemplo de resposta:
{
"OrderNumber": "1-19876653568916"
}
A resposta indica que o pedido foi bem-sucedido e retorna o número do pedido.
Pedido uma escolta em Cage - exemplo estendido
Exemplo de solicitação cURL:
Para solicitar um serviço de escolta de segurança IBX para um visitante acessar sua cela, envie uma solicitação POST para o endpoint /smarthands/cageEscort. Forneça os detalhes do serviço no corpo da solicitação. Utilize o objeto attachments para incluir informações adicionais sobre o técnico.
Antes de criar um pedido com anexo, chame o endpoint Arquivo de anexos.
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"
}
]
}'
Para obter uma lista completa dos parâmetros e descrições do corpo, consulte a Referência da API.