Pular para o conteúdo principal

Ordem de escolta de gaiola

Pré-requisitos​

  1. Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para autenticação OAuth2. Consulte Autenticação API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.

  2. Obter um número de ordem de visita de trabalho - Enviar uma GET solicitação para o /colocations/v2/orders/{orderId} ponto de extremidade para recuperar um número de ordem para uma visita de trabalho que já foi programada. Para agendar uma nova visita de trabalho, envie uma POST solicitação para o colocations/v2/orders/workVisits endpoint. Você deve ter IBX Access Services permissão para agendar uma visita de trabalho. Você pode ignorar esta etapa se já tiver o número da ordem da visita de trabalho.

  3. Para obter detalhes do Smart Hands, o usuário deve ter Smart Handspermissões de pedido.

  4. Get Smart Hands Types - Envie uma GET solicitação para o /v1/orders/smarthands/types endpoint para obter todos os tipos de pedidos Smart Hands. Você pode ignorar esta etapa se já souber o tipo de pedido Smart Hands.

  5. Obter informações de localização - Envie uma GET solicitação para o /v1/orders/smarthands/locations ponto de extremidade para recuperar 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 da IBX para que um visitante acesse seu CAGE, envie uma POST solicitação para o /smarthands/cageEscort endpoint.

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 uma escolta de segurança da IBX para que um visitante acesse seu CAGE, envie uma POST solicitação para o /smarthands/cageEscort endpoint. Forneça os detalhes do serviço no corpo da solicitação. Use o attachments objeto para incluir detalhes adicionais de um técnico.

observação

Antes de criar um pedido com anexo, chame o Attachments File endpoint.

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 de parâmetros corporais e descrições, consulte a Referência do API .

Esta página foi útil?