Interface CrossConnects

All Known Implementing Classes:
CrossConnectsImpl
@Beta public interface CrossConnects
Fabric v4 cross connects (real physical orders) (12 operations).

Obtain it from fabric.beta().crossConnects(). Every operation maps one Fabric v4 endpoint; the Javadoc of each method names the path and the spec operation id.

Beta: Fabric v4 4.34.0 (spec read 2026-11-11).

Generated from the Fabric v4 OpenAPI spec by the fabric-beta generator; regenerate rather than hand-edit.

  • Method Details

    • create

      CrossConnectResponse create(CreateCrossConnect request)
      Create Cross Connect: POST /fabric/v4/crossConnects (operation createCrossConnect).

      The API provides capability to create a new Cross Connect.

      Parameters:
      request - the CreateCrossConnect request body
      Returns:
      the CrossConnectResponse the API returns

    • createDiverse

      List<CrossConnectResponse> createDiverse(DiverseCrossConnectRequest request)
      Create Diverse Cross Connect: POST /fabric/v4/crossConnects/bulk (operation createDiverseCrossConnect).

      The API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed at the same time, or multiple Cross Connects by sending one entry per Cross Connect.

      Unwraps the CrossConnectDiverse data envelope (the spec documents no paging for it).

      Parameters:
      request - the DiverseCrossConnectRequest request body
      Returns:
      the CrossConnectResponse entries (empty when none)

    • search

      PaginatedFilteredList<CrossConnectResponse> search(FilterPropertyList filter, SortPropertyList sort)
      Search Cross Connects: POST /fabric/v4/crossConnects/search (operation searchCrossConnects).

      The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.

      Filter properties named by the spec: /aSide/demarcationPoint/patchPanelId, /aSide/demarcationPoint/patchPanelPortA, /aSide/demarcationPoint/patchPanelPortB, /aSide/location/ibxCode, /account/accountNumber, /bmmrType, /changeLog/createdDateTime, /changeLog/updatedDateTime, /circuitId, /name, /order/customerReferenceId, /order/orderNumber, /redundancy/group, /redundancy/priority, /serialNumber, /state, /type, /uuid, /zSide/demarcationPoint/patchPanelId, /zSide/demarcationPoint/patchPanelPortA, /zSide/demarcationPoint/patchPanelPortB, /zSide/loa/uuid, /zSide/location/ibxCode.

      Sort properties named by the spec: /changeLog/createdDateTime, /changeLog/updatedDateTime, /name, /state.

      Parameters:
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of CrossConnectResponse

    • search

      PaginatedFilteredList<CrossConnectResponse> search(FilterPropertyList filter)
      Search Cross Connects: POST /fabric/v4/crossConnects/search (operation searchCrossConnects).

      The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.

      Parameters:
      filter - the filter (null for none)
      Returns:
      a lazily paged list of CrossConnectResponse

    • search

      PaginatedFilteredList<CrossConnectResponse> search()
      Search Cross Connects: POST /fabric/v4/crossConnects/search (operation searchCrossConnects).

      The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.

      Returns:
      a lazily paged list of CrossConnectResponse

    • getByUuid

      CrossConnectResponse getByUuid(String crossConnectId)
      Get Cross Connect: GET /fabric/v4/crossConnects/{crossConnectId} (operation getCrossConnectByUuid).

      The API provides capability to get Cross Connect details by Cross Connect ID.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      the CrossConnectResponse the API returns

    • getSchedules

      List<CrossConnectScheduleResponse> getSchedules(String crossConnectId)
      Get Cross Connect Schedules: GET /fabric/v4/crossConnects/{crossConnectId}/schedules (operation getCrossConnectSchedulesByUuid).

      The API provides capability to get the schedules of a Cross Connect by Cross Connect ID.

      Unwraps the SchedulesResponse data envelope (the spec documents no paging for it).

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      the CrossConnectScheduleResponse entries (empty when none)

    • getServices

      List<CrossConnectServiceResponse> getServices(String crossConnectId)
      Get Cross Connect Services: GET /fabric/v4/crossConnects/{crossConnectId}/services (operation getCrossConnectServicesByUuid).

      The API provides capability to get the services ordered alongside a Cross Connect by Cross Connect ID.

      Unwraps the CrossConnectServicesResponse data envelope (the spec documents no paging for it).

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      the CrossConnectServiceResponse entries (empty when none)

    • getAttachments

      List<CrossConnectAttachmentResponse> getAttachments(String crossConnectId)
      Get Cross Connect Attachments: GET /fabric/v4/crossConnects/{crossConnectId}/attachments (operation getCrossConnectAttachmentsByUuid).

      The API provides capability to get the documents attached to a Cross Connect by Cross Connect ID.

      Unwraps the CrossConnectAttachmentsResponse data envelope (the spec documents no paging for it).

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      the CrossConnectAttachmentResponse entries (empty when none)

    • listNotes

      PaginatedList<CrossConnectNoteResponse> listNotes(String crossConnectId)
      Get Cross Connect Notes: GET /fabric/v4/crossConnects/{crossConnectId}/notes (operation getCrossConnectNotesByUuid).

      The API provides capability to get the notes added to a Cross Connect by Cross Connect ID.

      Paged with offset/limit.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      a lazily paged list of CrossConnectNoteResponse

    • performAction

      CrossConnectActionResponse performAction(String crossConnectId, CrossConnectActionRequest request)
      Cross Connect Actions: POST /fabric/v4/crossConnects/{crossConnectId}/actions (operation performCrossConnectAction).

      The API provides capability to perform an action on a Cross Connect that is in the PENDING_ACTION state. The applicable action types are listed in the allowedActions of the Cross Connect.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      request - the CrossConnectActionRequest request body
      Returns:
      the CrossConnectActionResponse the API returns

    • getAction

      CrossConnectActionResponse getAction(String crossConnectId, String actionId)
      Get Cross Connect Action by Action ID: GET /fabric/v4/crossConnects/{crossConnectId}/actions/{actionId} (operation getCrossConnectActionByUuid).

      The API provides capability to fetch Cross Connect action details by Action ID.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      actionId - the actionId path parameter
      Returns:
      the CrossConnectActionResponse the API returns

    • searchActions

      PaginatedFilteredList<CrossConnectActionResponse> searchActions(String crossConnectId, FilterPropertyList filter, SortPropertyList sort)
      Search Cross Connect Actions: POST /fabric/v4/crossConnects/{crossConnectId}/actions/search (operation searchCrossConnectAction).

      The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.

      Filter properties named by the spec: /state, /type, /uuid.

      Sort properties named by the spec: /changeLog/createdDateTime.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of CrossConnectActionResponse

    • searchActions

      PaginatedFilteredList<CrossConnectActionResponse> searchActions(String crossConnectId, FilterPropertyList filter)
      Search Cross Connect Actions: POST /fabric/v4/crossConnects/{crossConnectId}/actions/search (operation searchCrossConnectAction).

      The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      filter - the filter (null for none)
      Returns:
      a lazily paged list of CrossConnectActionResponse

    • searchActions

      PaginatedFilteredList<CrossConnectActionResponse> searchActions(String crossConnectId)
      Search Cross Connect Actions: POST /fabric/v4/crossConnects/{crossConnectId}/actions/search (operation searchCrossConnectAction).

      The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.

      Parameters:
      crossConnectId - the crossConnectId path parameter
      Returns:
      a lazily paged list of CrossConnectActionResponse

    • searchSchedules

      PaginatedFilteredList<CrossConnectScheduleAvailability> searchSchedules(FilterPropertyList filter, SortPropertyList sort)
      Search Cross Connect Schedules: POST /fabric/v4/crossConnectSchedules/search (operation searchCrossConnectSchedules).

      The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.

      Filter properties named by the spec: /aSide/location/ibxCode, /code, /type, /zSide/location/ibxCode.

      Sort properties named by the spec: /code, /endDateTime, /startDateTime.

      Parameters:
      filter - the filter (null for none)
      sort - the sort order (null for the service default)
      Returns:
      a lazily paged list of CrossConnectScheduleAvailability

    • searchSchedules

      PaginatedFilteredList<CrossConnectScheduleAvailability> searchSchedules(FilterPropertyList filter)
      Search Cross Connect Schedules: POST /fabric/v4/crossConnectSchedules/search (operation searchCrossConnectSchedules).

      The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.

      Parameters:
      filter - the filter (null for none)
      Returns:
      a lazily paged list of CrossConnectScheduleAvailability

    • searchSchedules

      PaginatedFilteredList<CrossConnectScheduleAvailability> searchSchedules()
      Search Cross Connect Schedules: POST /fabric/v4/crossConnectSchedules/search (operation searchCrossConnectSchedules).

      The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.

      Returns:
      a lazily paged list of CrossConnectScheduleAvailability