KIO Link
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
KIO Link XC API
KIO Link APIHuawei BMSHuawei Alert
  1. XC Status Histories
  • 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
      GET
    • List XC status history time summary
      GET
    • Get a XC status history record
      GET
  • 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 Status Histories

Overview

XC Status Histories#

Endpoints for reading the status change history of an XC (Cross-Connect) request. This module is read-only — status history records are created internally by the system whenever an XC request's status changes; there is no endpoint to create or edit them directly.

Concepts#

Status history record: one row per status change on an XC request, stored in xc_status_histories. It captures the old status, the new status, who/what triggered the change, an optional reason, and the timestamp.
Source: where the change originated — KIO_LINK (made through this app), SALESFORCE (synced from Salesforce), or SYSTEM (automated).
Business time: elapsed time is measured only during business hours in America/Mexico_City (Mon–Fri, 09:00–18:00), excluding Mexican public holidays. This is used to compute the time summary and to flag delayed stages.
Delay threshold: a request's current stage is considered delayed once it has accumulated more than 72 business hours without progressing to the next status.

Required permission#

All endpoints in this folder require the xc-status-history-read permission (access.permit('xc-status-history-read')).

Endpoints#

List XC status histories#

GET /v1/xc/requests/{id}/status-history
Returns the full, chronologically ordered (changed_at ASC) list of status changes for the given request, with the old_status and new_status relations expanded.

List XC status history time summary#

GET /v1/xc/requests/{id}/status-history/summary
Returns aggregated business-time metrics for the request:
total_time: total business time from request creation to completion (or to now, if still in progress).
stages: per-stage breakdown (recibido, revision, firma, implementacion, acta_entrega) with time spent, percentage of total, and a delayed flag for the current stage.
Returns 404 if the XC request does not exist.

Get a XC status history record#

GET /v1/xc/requests/{id}/status-history/{statusHistoryId}
Returns a single status history record by its ID, including the related XC request and status details. Returns 404 if the record does not exist.

Path parameters#

ParamFormatDescription
idxcr_ + 16 alphanumeric charsID of the XC request the history belongs to.
statusHistoryIdxcsh_ + 16 alphanumeric charsID of a specific status history record.

Source#

Router: routes/v1/xc/status-histories.router.js
Controller: controllers/xc/status-histories.controller.js
Service: services/xc/status-histories.service.js
Business-time logic: services/xc/status-time.js
Entity: entities/xc-status-history.js
Modified at 2026-09-25 18:15:39
Previous
Delete a XC status
Next
List XC status histories
Built with