Connector requests and results

These six entry points use top-level paths and X-Workspace-ID. Route assembly handles the formal boundaries for product identity and runtime task identity separately. Examples use ordinary PATs; task proof is not arbitrary data-access permission.

Before you call this API

BASE_URL includes the product prefix for the same environment. MOI_KEY is the product credential; WORKSPACE_ID is an accessible workspace. Request connector_id comes from a saved connector. Fill database, schema, and table using the previous actual metadata result. Example connectors and results are fixed placeholders.

/db reads require connector.use. The service also reads connector configuration and calls a Worker. /mo target reads additionally require export_task.create. There are no pagination or total parameters; do not construct next-page links.

Success results

Success uses string code=OK, msg=OK, and a data object. databases/schemas/tables are string arrays. Legacy database/schema nil slices may return null; this is not API failure or proof that the entire system has no objects. Table lists project names from transport objects without retaining all original location information.

columns fields

Type

Description

name

string

Source field name.

data_type

string

Source type.

mapped_type

string

Mapped type.

is_primary_key

boolean

Whether this is a primary key.

is_nullable

boolean

Whether null values are allowed.

is_auto_incr

boolean

Whether the field auto-increments; HTTP may omit it when false.

Current dedicated SDKs retain these field type semantics. Reencoding JSON may omit default false values; absence does not mean true. This result is not a modern schema_snapshot or a complete target-field compatibility report.

Errors and empty results

Some parameter or operation failures in the old /db handler still return HTTP 200 with a non-OK business code. Even after normal request construction, SDK response decoding may return a business error. Check HTTP status, code, and actual results together. Identity/permission/dependency errors follow their own mappings; not every error returns HTTP 200.

MatrixOne entry points use the shared service error adapter rather than the old /db fixed error status. An empty result describes only this read under the current permissions, connector, and source target. It does not verify source connectivity, engine compatibility, or production availability.

Last updated on