KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Connections
  • DocuSign
    • Overview
    • List a XC request's DocuSign envelopes
      GET
    • Get an embeded URL signature for a XC Request
      GET
    • Regenerate a URL signature for the current signer
      GET
    • List the order of signers of a DocuSign Envelope
      GET
    • Create a DocuSign envelope for a XC request
      POST
    • Resend email & recover URL signature for a XC request
      POST
    • Create a DocuSign envelope for multiple signers
      POST
  • XC Client Prices
    • Overview
    • List XC client prices
      GET
    • Get a XC client's price
      GET
    • Create a XC client's price
      POST
    • Update a XC client's price
      PATCH
    • Delete a XC client's price
      DELETE
  • XC Comments
    • Overview
    • List XC comments
      GET
    • Get a XC comment
      GET
    • Create a XC comment
      POST
    • Update a XC comment
      PATCH
    • Delete a XC comment
      DELETE
  • XC Connections
    • Overview
    • List XC connections
      GET
    • Get a XC connection
      GET
    • Create a XC connection
      POST
    • Update a XC connection
      PATCH
    • Delete a XC connection
      DELETE
  • XC Contract Settings
    • Overview
    • List XC contract settings
    • Get a XC contract setting
    • Get a XC Request's contract setting
    • Create a XC contract setting
    • Update a XC contract setting
    • Delete a XC contract setting
  • XC Contract Setting Participants
    • Overview
    • List all XC contract settings participants
    • List a XC contract settings participants
    • Get a XC contract settings participant
    • Create a XC contract settings participant
    • Update a XC contract settings participant
    • Delete a XC contract settings participant
  • XC Data Centers
    • Overview
    • List XC datacenters
    • Create a XC datacenter
    • Update a XC datacenter
    • Delete a XC datacenter
  • XC Documents
    • Overview
    • List XC documents
    • Get a XC document's metadata
    • Get a XC document download URL
    • Get a XC document binary file
    • Upload a XC document
    • Delete a XC document
  • XC Reports
    • Overview
    • Download XC requests report
    • Download XC satisfaction survey report
    • Download XC connections report
  • XC Requests
    • Overview
    • List XC requests
    • Get a XC request
    • Get a XC request (complete details)
    • Create a XC request
    • Upsert a XC request draft
    • Update a XC request's general data
    • Change a XC request's status
    • Delete a XC request
    • Revert a XC request to Revision
  • XC Salesforce
    • Overview
    • Accounts
      • Overview
      • List accounts
      • Get an account
    • Opportunities
      • Overview
      • Attachments
        • Overview
        • List opportunity attachments
        • Upload an opportunity attachment
        • Download an opportunity file
      • List opportunities
      • Get an opportunity
      • Create an opportunity
      • Update an opportunity
    • Products
      • Overview
      • List products
      • Get a product
    • Project Requests
      • Overview
      • List project requests
      • Get a project request
      • Create a project request
      • Update a project request
    • Users
      • Overview
      • List users
      • Get a user
    • XC/IC Requests
      • Overview
      • Attachments
        • Overview
        • List XC/IC attachments
        • Upload a XC/IC attachment
        • Download a XC/IC file
      • List XC/IC requests
      • List all KIO Link connections from Salesforce XC/IC requests
      • Get a XC/IC request
      • Create a XC/IC request
      • Update a XC/IC request
  • XC Satisfaction Survey
    • Overview
    • List XC satisfaction surveys
    • Get a XC satisfaction survey
    • Get a XC satisfaction survey per user
    • Create XC satisfaction survey
  • XC Statuses
    • Overview
    • List XC statuses
    • Get a XC status
    • Create a XC status
    • Update a XC status
    • Delete a XC status
  • XC Status Histories
    • Overview
    • List XC status histories
    • List XC status history time summary
    • Get a XC status history record
  • Schemas
    • DocuSign
      • DocuSign Envelope Signer
      • DocuSign Signing URL Result
      • DocuSign Signer Routing
      • DocuSign Resend Result
      • DocuSign Envelope
    • XC Client Prices
      • XC Client Price
    • XC Comments
      • XC Comment
    • XC Connections
      • XC Connection
    • XC Contract Settings
      • XC Contract Setting
    • XC Contract Setting Participants
      • XC Contract Setting Participant
    • XC Data Centers
      • XC Datacenter
    • XC Documents
      • XC Document
    • XC Requests
      • XC Request With Relations
      • XC Request List Item
      • XC Request
      • XC Request With Details
    • XC Salesforce
      • Salesforce Connection
      • Salesforce Account
      • Salesforce User
      • Salesforce Product
      • Salesforce Opportunity List Item
      • Salesforce Opportunity
      • Salesforce Opportunity Write Result
      • Salesforce Attachment
      • Salesforce Attachment Upload Result
      • Salesforce Attachment Download Result
      • Salesforce Request List Item
      • Salesforce Request Point
      • Salesforce Request
      • Salesforce Request Write Result
      • Salesforce Project Request
      • Salesforce Project Request Write Result
      • Salesforce Quote
      • Salesforce Quote Line
    • XC Satisfaction Surveys
      • XC Satisfaction Survey
    • XC Statuses
      • XC Status
    • XC Status Histories
      • XC Status Time
      • XC Status Stage Time
      • XC Status History
    • Error
    • Date Metadata
    • Pagination Metadata
  1. XC Connections

Overview

XC Connections#

CRUD endpoints for the individual physical Cross-Connect port pairs within an XC request. A single XC request can have multiple connections (e.g. a client ordering several ports); each connection describes one Side A ↔ Side B link.

Concepts#

Side A / Side B: every field describing the physical termination is duplicated per side — company_a/company_b, phase_a/phase_b, cabinet_a/cabinet_b, rack_unit_a/rack_unit_b, endpoint_label_a/endpoint_label_b (serial/hostname/panel/ODF), port_a/port_b, connector_a/connector_b (e.g. LC, SC, RJ45).
deliver_on_tip_a / _b: when true, the service is left at the point without equipment/port detail ("leave on tip").
allow_alternative_port_a / _b: authorizes presenting the service on an alternative port if there's an issue with the originally requested one.
Data center & phase validation: if data_center_id is provided, phase_a (and phase_b, against linked_data_center_id when set, otherwise the same data center) must match one of that data center's active phase codenames.
Wire & connector validation: if wire_id is provided, connector_a and connector_b must be among that wire's supported connectors. wire_name_snapshot freezes the wire's name at creation time.
index: connections are auto-numbered per request (1, 2, 3…) in creation order; List returns them ordered by this index.
Salesforce LOA sync: setting external_opportunity_child_id (a Salesforce child opportunity ID) automatically looks up and fills external_opportunity_child_folio from the matching Salesforce LOA record.

Endpoints#

List XC connections#

GET /v1/xc/requests/{id}/connections
All connections for a request, in index order.

Create a XC connection#

POST /v1/xc/requests/{id}/connections
Adds a new connection to a request.

Get a XC connection#

GET /v1/xc/connections/{id}
Returns a single connection by its own ID.

Update a XC connection#

PATCH /v1/xc/connections/{id}
Updates one or more fields of a connection.

Delete a XC connection#

DELETE /v1/xc/connections/{id}
Permanently deletes a connection.

Source#

Router: routes/v1/xc/connections.router.js
Controller: controllers/xc/connections.controller.js
Service: services/xc/connections.service.js
Entity: entities/xc-connection.js
Modified at 2026-09-25 18:13:30
Previous
Delete a XC comment
Next
List XC connections
Built with