Skip to main content

Passthrough Read

Loading...
API endpoint path: /mx/{mxReportingResourcePath}

Transparent passthrough for GET requests to the MX Reporting APIs. The service provides a RESTful interface to retrieve change data for MX user resources, removing the need to query each user individually. Change files are requested by date, resource, and action, and are delivered as Avro files with embedded schema metadata. Endpoint paths, headers, query parameters, and response schemas are defined in the MX documentation.

Use this endpoint to:

  • Download daily MX change files for supported combinations of date, resource type, and action.
    • Daily change files are generated once per day and remain available for up to seven days.
    • If no data exists for a given resource on a specific day, MX returns an Avro file containing headers only, with no data records.
    • A 410 Gone response indicates that the requested daily file is no longer available.
  • List or retrieve institution snapshot files.
  • Access MX Reporting read operations through the Candescent API Gateway instead of calling MX directly.

Behavior and capabilities:

  • The gateway validates the OAuth V2 bearer token, correlationId, and ext_host, injects MD-API-KEY for MX Reporting routing, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{mxReportingResourcePath}, where institutionId corresponds to the MX client_id (used in MX paths such as /{client_id}/...), must match the value in the OAuth V2 token, and is used when forwarding requests to MX.
  • Forwards all MX-supported headers, paths, and query parameters without modification.
  • Returns MX HTTP status codes and Avro (or empty Avro header-only) response payloads without modification.

Request​

Responses​

Avro-encoded file returned by the target MX Reporting endpoint without modification. The file includes an embedded writer schema. For daily change files, records reflect object changes for the requested date, resource type, and action. If no data exists for the specified day, MX returns an Avro file containing headers only, with no data records.

Refer to the MX Reporting APIs documentation for supported schemas and examples.