KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Documents
  • 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
    • Get a XC document's metadata
      GET
    • Get a XC document download URL
      GET
    • Get a XC document binary file
      GET
    • Upload a XC document
      POST
    • Delete a XC document
      DELETE
  • 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 Documents

Overview

XC Documents#

Endpoints for uploading, listing, retrieving, and deleting files attached to an XC (Cross-Connect) request — LOAs, generated/signed SOW and Acta de Entrega documents, implementation evidence, etc. Files are stored in S3; this API manages both the file content and its metadata (xc_documents).

Concepts#

document_type: a free-text type describing what the file is. Common values seen in the codebase: LOA_A, LOA_B, SOW_GENERADO, SOW_FIRMADO, ACTA_ENTREGA, ACTA_ENTREGA_FIRMADA, EVIDENCIA_IMPLEMENTACION. Signed documents (_FIRMADO/_FIRMADA) are typically created automatically by the DocuSign webhook rather than uploaded directly.
Optional connection scoping: a document can be tied to a specific xc_connection_id, or left request-wide if omitted.
Three ways to access a file:
Get metadata — returns the database record only (name, type, size, MIME type, timestamps, relations), no file bytes.
Get download URL — returns a short-lived, pre-signed S3 URL for the client to fetch the file directly from storage (expires, 60–86400s, default 600s).
Get binary file — streams the file through the API itself, with inline=1 to render in-browser (e.g. PDF preview) instead of triggering a download.
Upload is multipart/form-data: file and document_type are required; xc_connection_id is optional.
Delete removes both the S3 object and the database record; the database record is removed even if the S3 deletion fails, to avoid orphaned rows.

Endpoints#

List XC documents#

GET /v1/xc/requests/{id}/documents
All documents for a request, optionally filtered by type, most recent first.

Upload a XC document#

POST /v1/xc/requests/{id}/documents
Uploads a file and attaches it to the request.

Get a XC document's metadata#

GET /v1/xc/documents/{documentId}
Metadata only — no file content.

Get a XC document download URL#

GET /v1/xc/documents/{documentId}/download
A pre-signed, time-limited S3 URL.

Get a XC document binary file#

GET /v1/xc/documents/{documentId}/file
Streams the file through the API (inline or attachment).

Delete a XC document#

DELETE /v1/xc/documents/{documentId}
Deletes the file and its record.

Source#

Router: routes/v1/xc/documents.router.js
Controller: controllers/xc/documents.controller.js
Service: services/xc/documents.service.js
Entity: entities/xc-document.js
Modified at 2026-09-25 18:11:36
Previous
Delete a XC datacenter
Next
List XC documents
Built with