Sign in

v2

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

Create an operation binding

Creates a source or destination operation binding. A source READ binding can later be paired with a destination WRITE binding in a route, optionally with a transformation between their resource descriptors.

post/operation/bindings

Request body

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

connectorResourceIdstring uuid required

Stable identifier for a resource attached to a connector instance.

operationKind'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE' required

Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.

transferMode'SINGLE' | 'BATCH' | 'STREAM'

Transfer semantics for an operation binding. Streaming and batching are execution modes of a logical operation, not operation kinds.

direction'INBOUND' | 'OUTBOUND' | 'BIDIRECTIONAL'

Direction of data movement represented by an operation binding.

accessProtocol'HTTP' | 'HTTPS' | 'JDBC' | 'ODBC' | 'SFTP' | 'FILE' | 'S3' | 'AZURE_BLOB' | 'GCS' | 'KAFKA' | 'AMQP' | 'MQTT' | 'OIDC' | 'DIDCOMM' | 'VAULT' | 'INTERNAL' | 'CUSTOM'

Transport or access protocol. This is intentionally separate from ResourceKind and RepresentationKind: for example, CSV data can be read over HTTPS, S3, SFTP, FILE, or VAULT.

operationNamestring

Connector-local operation name, for example OpenAPI operationId, SQL statement name, file action, or vault operation.

requestDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

responseDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

transformationIdstring uuid

Stable identifier for a transformation definition.

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

{
  "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
  "connectorResourceId": "b4cf21b1-0292-4803-8d32-9ebf9f5359a2",
  "operationKind": "READ",
  "transferMode": "SINGLE",
  "direction": "INBOUND",
  "accessProtocol": "HTTPS",
  "operationName": "getEmployeeProfile",
  "responseDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
  "egressPolicy": {
    "allowedHosts": [
      "hr.example.com"
    ],
    "allowedProtocols": [
      "HTTPS"
    ],
    "maxPayloadBytes": 1048576,
    "requiresTenantBoundary": true
  },
  "metadata": {
    "source_lookup_key": "employee_id"
  }
}

Response

Operation binding created.

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

connectorResourceIdstring uuid required

Stable identifier for a resource attached to a connector instance.

operationKind'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE' required

Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.

transferMode'SINGLE' | 'BATCH' | 'STREAM'

Transfer semantics for an operation binding. Streaming and batching are execution modes of a logical operation, not operation kinds.

direction'INBOUND' | 'OUTBOUND' | 'BIDIRECTIONAL'

Direction of data movement represented by an operation binding.

accessProtocol'HTTP' | 'HTTPS' | 'JDBC' | 'ODBC' | 'SFTP' | 'FILE' | 'S3' | 'AZURE_BLOB' | 'GCS' | 'KAFKA' | 'AMQP' | 'MQTT' | 'OIDC' | 'DIDCOMM' | 'VAULT' | 'INTERNAL' | 'CUSTOM'

Transport or access protocol. This is intentionally separate from ResourceKind and RepresentationKind: for example, CSV data can be read over HTTPS, S3, SFTP, FILE, or VAULT.

operationNamestring

Connector-local operation name, for example OpenAPI operationId, SQL statement name, file action, or vault operation.

requestDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

responseDescriptorIdstring uuid

Stable identifier for a described external or internal resource shape.

transformationIdstring uuid

Stable identifier for a transformation definition.

metadataStringMap

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

bindingIdstring uuid required

Stable identifier for a connector operation binding.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

Example response

{
  "bindingId": "2777417e-82ce-4d3e-b96c-94e00a4d9a93",
  "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
  "connectorResourceId": "b4cf21b1-0292-4803-8d32-9ebf9f5359a2",
  "operationKind": "READ",
  "transferMode": "SINGLE",
  "direction": "INBOUND",
  "accessProtocol": "HTTPS",
  "operationName": "getEmployeeProfile",
  "responseDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
  "createdAt": "2026-06-18T09:20:00Z",
  "updatedAt": "2026-06-18T09:25:00Z"
}