KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Requests
  • 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 a XC connection
    • Create a XC connection
    • Update a XC connection
    • Delete a XC connection
  • 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
    • Get a XC request
      GET
    • Get a XC request (complete details)
      GET
    • Create a XC request
      POST
    • Upsert a XC request draft
      PUT
    • Update a XC request's general data
      PATCH
    • Change a XC request's status
      PATCH
    • Delete a XC request
      DELETE
    • Revert a XC request to Revision
      PATCH
  • 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 Requests

Overview

XC Requests#

The central resource of the Cross-Connect module: an XC request is the client-facing "ticket" that tracks a cross-connect from intake through implementation, and is the parent of connections, documents, status history, contract setting, and DocuSign envelopes.

Concepts#

Lifecycle: a request moves through statuses such as RECIBIDO → REVISION → FIRMA → IMPLEMENTACION → COMPLETADO (see XC Statuses). Status changes are tracked in XC Status Histories and can trigger notification emails and downstream automation (e.g. via the DocuSign webhook).
Drafts: a request can be created as a draft (PUT /xc/requests/draft) with relaxed validation (requester name/email may be blank, no status assigned) and later finalized. Re-submitting the same draft id updates it in place; omitting id creates a new one.
Revert to revision: a dedicated endpoint resets a request back to REVISION and undoes SOW-related state in one transaction — deletes the contract setting, relabels SOW documents to EXTRA, and voids open DocuSign envelopes.
Business scoping: business users only ever see/act on requests belonging to their own business; this is enforced automatically, not by a filter they control.
Salesforce opportunity linkage: external_opportunity_parent_id/external_opportunity_parent_optional_id reference Salesforce opportunities; the corresponding _number fields are auto-resolved from Salesforce rather than meant to be set directly.
List summary: List XC requests returns not just paginated data, but also a summary object keyed by canonical status code (e.g. COMPLETA, FALTA_INFO) with total and delayed counts, computed over the same filters as the list (minus pagination). If a text search matches nothing locally, it automatically retries against Salesforce opportunities.
Connections at creation: Create and the draft upsert both accept an initial connections array (up to 100), using the same fields as XC Connections — see that folder for the full Side A/Side B field reference.

Endpoints#

List XC requests#

GET /v1/xc/requests
Paginated, filterable, sortable list plus a per-status summary.

Create a XC request#

POST /v1/xc/requests
Creates a non-draft request, optionally with initial connections.

Upsert a XC request draft#

PUT /v1/xc/requests/draft
Creates or updates a draft (relaxed validation, no status).

Get a XC request#

GET /v1/xc/requests/{id}
Core record only (status + contract setting).

Get a XC request (complete details)#

GET /v1/xc/requests/{id}/details
Request + connections + documents + status history + DocuSign envelopes.

Update a XC request's general data#

PATCH /v1/xc/requests/{id}
Updates general fields; does not change status.

Change a XC request's status#

PATCH /v1/xc/requests/{id}/status
Transitions the request to a new status.

Revert a XC request to Revision#

PATCH /v1/xc/requests/{id}/revert-to-revision
Resets the request to REVISION and clears SOW-related state.

Delete a XC request#

DELETE /v1/xc/requests/{id}
Deletes the request and its documents.

Source#

Router: routes/v1/xc/requests.router.js
Controller: controllers/xc/requests.controller.js
Service: services/xc/requests.service.js
Entity: entities/xc-request.js
Modified at 2026-09-25 18:09:43
Previous
Download XC connections report
Next
List XC requests
Built with