Interface WorkVisits

All Known Implementing Classes:
WorkVisitsImpl
public interface WorkVisits
Client interface for scheduling work visits in the Equinix Customer Portal.

Backed by the Work Visit v2 order API at /colocations/v2/orders/workVisits. Work visits are scheduled and updated as orders; the resulting order is tracked through Orders and OrderHistory, and a work visit is cancelled via Orders.cancel(String, String). Each order operation returns the generated order id (parsed from the Location header).

Work Visit v1 (/v1/orders/workvisit/...) reached end of life on 2024-01-22 and is not exposed. The locations where the current user may place work visit orders come from Lookup v2 (GET /colocations/v2/locations?permissionCode=WORK_VISIT): see listLocations() and Lookups.listLocations(String, List, String, String, String, Boolean).

  • Method Details

    • order

      OrderResponse order(WorkVisitOrderRequest request)
      Schedules a work visit.

      Maps to POST /colocations/v2/orders/workVisits (Schedule Work Visit Services).

      Parameters:
      request - the work visit order request body
      Returns:
      the order submission result carrying the generated order id

    • update

      OrderResponse update(String orderId, WorkVisitUpdateRequest request)
      Updates a pending work visit order.

      Maps to PATCH /colocations/v2/orders/workVisits/{orderId} (Update a work visit order).

      Parameters:
      orderId - the identifier of the work visit order
      request - the update request body
      Returns:
      the order submission result carrying the order id

    • listLocations

      List<? extends LookupLocation> listLocations()
      Lists the IBX locations, cages and cabinets where the current user may place work visit orders.

      Maps to Lookup v2 GET /colocations/v2/locations?permissionCode=WORK_VISIT; the same call as lookups().listLocations("WORK_VISIT"). It replaces the end-of-life Work Visit v1 GET /v1/orders/workvisit/locations.

      Returns:
      the list of permitted locations

    • listLocations

      List<? extends LookupLocation> listLocations(List<String> ibxs, Boolean details)
      Lists the work visit locations for the given IBXs, optionally with cage, cabinet and account details.

      Maps to Lookup v2 GET /colocations/v2/locations?permissionCode=WORK_VISIT.

      Parameters:
      ibxs - the IBX codes to filter by, or null
      details - when true, returns cage, cabinet and account details, or null for the default
      Returns:
      the list of permitted locations