v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB

Routes

Create a connector route

Creates a route from one or more source operation bindings to one or more destination operation bindings. The route can be on-demand, scheduled, event-triggered, webhook-triggered, or started by a higher-level platform pipeline.

post/routes

Request body

displayNamestring required

Human-readable route name.

descriptionstring

Route purpose and operational boundaries.

sourceBindingIdsOperationBindingId[] required

Source operation bindings that feed this route. More than one source supports enrichment and reference-data joins.

destinationBindingIdsOperationBindingId[] required

Destination operation bindings written by this route. More than one destination supports fan-out.

transformationIdstring uuid

Stable identifier for a transformation definition.

atomicity'BEST_EFFORT' | 'PER_RECORD' | 'ALL_OR_NOTHING'

Failure and rollback semantics expected for a route run.

purposestring

Processing purpose captured at route design time for audit and future governance checks.

legalBasisstring

Legal, contractual, or policy basis for the route's data movement.

enabledboolean

Whether this route is eligible for scheduled, event, webhook, or on-demand execution.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example request

{
  "displayName": "Employee CSV to license invitations",
  "description": "Imports employee rows, maps them to invitation payloads, and writes them to the invitation service.",
  "sourceBindingIds": [
    "2777417e-82ce-4d3e-b96c-94e00a4d9a93"
  ],
  "destinationBindingIds": [
    "b1313b55-ee8c-41d1-8f4f-f4fe2c15e3be"
  ],
  "transformationId": "0e60abcc-41b5-4cc5-bec2-f0047f129341",
  "trigger": {
    "triggerType": "ON_DEMAND"
  },
  "atomicity": "PER_RECORD",
  "purpose": "credential-issuance",
  "legalBasis": "contract",
  "enabled": true,
  "materializationPolicy": {
    "mode": "NONE"
  }
}

Response

Connector route created.

displayNamestring required

Human-readable route name.

descriptionstring

Route purpose and operational boundaries.

sourceBindingIdsOperationBindingId[] required

Source operation bindings that feed this route. More than one source supports enrichment and reference-data joins.

destinationBindingIdsOperationBindingId[] required

Destination operation bindings written by this route. More than one destination supports fan-out.

transformationIdstring uuid

Stable identifier for a transformation definition.

atomicity'BEST_EFFORT' | 'PER_RECORD' | 'ALL_OR_NOTHING'

Failure and rollback semantics expected for a route run.

purposestring

Processing purpose captured at route design time for audit and future governance checks.

legalBasisstring

Legal, contractual, or policy basis for the route's data movement.

enabledboolean

Whether this route is eligible for scheduled, event, webhook, or on-demand execution.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

routeIdstring uuid required

Stable identifier for a connector route.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

createdByUserIdstring

Optional user id that created the route.

updatedByUserIdstring

Optional user id that last updated the route.

deletedAtstring date-time

Soft-delete timestamp. Deleted routes are hidden from normal route lookup and listing but retained for run lineage.

Example response

{
  "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f",
  "displayName": "Employee CSV to license invitations",
  "description": "Imports employee rows, maps them to invitation payloads, and writes them to the invitation service.",
  "sourceBindingIds": [
    "2777417e-82ce-4d3e-b96c-94e00a4d9a93"
  ],
  "destinationBindingIds": [
    "b1313b55-ee8c-41d1-8f4f-f4fe2c15e3be"
  ],
  "transformationId": "0e60abcc-41b5-4cc5-bec2-f0047f129341",
  "trigger": {
    "triggerType": "ON_DEMAND"
  },
  "atomicity": "PER_RECORD",
  "purpose": "credential-issuance",
  "legalBasis": "contract",
  "enabled": true,
  "materializationPolicy": {
    "mode": "NONE"
  },
  "createdAt": "2026-06-18T10:00:00Z",
  "updatedAt": "2026-06-18T10:05:00Z"
}