KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Salesforce
  • 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 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 Salesforce

Overview

XC Salesforce#

A live read/write integration layer over Salesforce for the Cross-Connect/Intra-Connect sales and delivery pipeline. Every endpoint here talks to Salesforce directly (via jsforce) on each request — nothing in this folder tree is cached locally, and nothing here is the same as the MySQL-backed XC Requests, XC Connections, etc. resources elsewhere in this project (those are KIO Link's own data; this is Salesforce's).

How the pieces fit together#

A typical flow moves through these objects in order:
1.
Accounts — the client company.
2.
Opportunities — the commercial deal for that account (account_id), with pricing/term/PM assignment.
3.
XC/IC Requests (LOA__c) — one per physical connection under an Opportunity, each with a Point A and Point B spec.
4.
Project Requests (Implementacion_de_Proyectos__c) — the delivery/implementation tracking record for an Opportunity, auto-inheriting PM/site/quote info from it.
5.
Products and Users are supporting read-only catalogs (pricing catalog; Salesforce internal users for PM/lead assignment).
Quotes and Quote Lines are a related part of this integration but are covered separately, not in this documentation pass.

Cross-cutting patterns#

Live, uncached lookups: search/limit/offset pagination is the norm on list endpoints; limit defaults vary by resource (10 or 20) but the max is always 100.
Salesforce ID validation: any :id path param is validated as a 15- or 18-character Salesforce ID.
Attachments use two different transport conventions depending on the object:
Opportunities and XC/IC Requests accept file uploads as raw application/octet-stream bytes (not multipart/form-data), with filename/content-type passed via X-Filename/X-Content-Type headers, and their "download" endpoints return a { url } JSON pointer to Salesforce rather than streaming the file.
XC/IC Requests additionally merge two Salesforce attachment systems (classic Attachment and modern ContentDocument) into one listing.
Auto-filled/derived fields are common: Opportunities auto-fill several fields from account_id; Project Requests auto-fill PM/site/quote from the linked Opportunity; XC/IC requests intentionally leave account_id on Point A/B blank on create (filled in later by the XC Lead, since clients don't have Salesforce customer-list access).

Folders#

Accounts — client companies.
Opportunities (+ Attachments) — commercial deals.
XC/IC Requests (+ Attachments) — per-connection requests (LOA__c) and the enriched connections listing.
Project Requests — implementation tracking.
Products — pricing catalog.
Users — Salesforce internal users.
Each folder has its own Overview with resource-specific detail.
Modified at 2026-09-25 18:47:19
Previous
Revert a XC request to Revision
Next
Overview
Built with