Pedir acompañante de jaula

Requisitos previos

1. Autenticar: Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte Autenticación de API para obtener instrucciones sobre cómo llamar a OAuth API para validar y autenticar sus credenciales.

2. Obtener un número de orden de visita de trabajo - Enviar una GET solicitud al /colocations/v2/orders/{orderId} endpoint para recuperar un número de pedido para una visita de trabajo que ya se ha programado. Para programar una nueva visita de trabajo, envíe una POST solicitud al colocations/v2/orders/workVisits punto final. Debe tener IBX Access Services permiso para programar una visita de trabajo. Puede omitir este paso si ya tiene el número de orden de visita de trabajo.

3. Para obtener detalles de Smart Hands, el usuario debe tener Smart Handspermisos de pedido.

4. Obtener tipos de Smart Hands - Enviar una GET solicitud al /v1/orders/smarthands/types endpoint para obtener todos los tipos de órdenes de Smart Hands. Puede omitir este paso si ya conoce el tipo de orden Smart Hands.

5. Obtener información de ubicación: Envíe una GET solicitud al /v1/orders/smarthands/locations endpoint para recuperar las ubicaciones de IBX disponibles a las que tenga acceso. Puede omitir este paso si ya conoce la información de ubicación.

Pedir una jaula de escolta - ejemplo mínimo

Para solicitar una escolta de seguridad de IBX para que un visitante acceda a su jaula, envíe una POST solicitud al /smarthands/cageEscort punto final.

Ejemplo de solicitud 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"  
    }  
    ]  
}'

Respuesta de muestra:

{  
    "OrderNumber": "1-19876653568916"  
}

La respuesta indica que el pedido se ha realizado correctamente y devuelve el número de pedido.

Pedir una jaula de escolta - ejemplo ampliado

Ejemplo de solicitud cURL:

Para solicitar una escolta de seguridad de IBX para que un visitante acceda a su jaula, envíe una POST solicitud al /smarthands/cageEscort punto final. Proporcione los detalles del servicio en el cuerpo de la solicitud. Utilice el attachments objeto para incluir detalles adicionales para un técnico.

nota

Antes de crear una orden con adjunto, llame al Attachments File punto final.

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 obtener una lista completa de los parámetros y descripciones del cuerpo, consulte la Referencia API .