Sign in

v2

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

Attach a resource descriptor to a connector

Attaches a reusable resource descriptor to a connector instance. For example, the same employee profile descriptor can be attached to an HTTP/OpenAPI connector over HTTPS, a CSV resource accessed over VAULT, and a SQL connector accessed over JDBC without changing the descriptor.

post/connectors/{connectorInstanceId}/resources

Path parameters

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Stable identifier of the configured connector instance. This is not the Party id; the connector instance has its own id and points at its backing Party.

Request body

resourceDescriptorIdstring uuid required

Stable identifier for a described external or internal resource shape.

role'SOURCE' | 'DESTINATION' required

How a connector participates in data movement. Use SOURCE for reads and DESTINATION for writes. Connectors that support both roles declare both values in supportedRoles.

externalResourceNamestring

Connector-local table, endpoint, bucket, object, claim set, form, topic, or collection name.

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.

endpointIdstring uuid

Optional connector endpoint used to access this resource.

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

{
  "resourceDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
  "role": "SOURCE",
  "externalResourceName": "/employees/{employee_id}",
  "accessProtocol": "HTTPS",
  "endpointId": "27d8bfc5-6c75-4e4e-a78a-63ad7a924cb1",
  "metadata": {
    "operation_group": "employee-profile"
  }
}

Response

Resource attached to the connector.

resourceDescriptorIdstring uuid required

Stable identifier for a described external or internal resource shape.

role'SOURCE' | 'DESTINATION' required

How a connector participates in data movement. Use SOURCE for reads and DESTINATION for writes. Connectors that support both roles declare both values in supportedRoles.

externalResourceNamestring

Connector-local table, endpoint, bucket, object, claim set, form, topic, or collection name.

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.

endpointIdstring uuid

Optional connector endpoint used to access this resource.

metadataStringMap

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

connectorResourceIdstring uuid required

Stable identifier for a resource attached to a connector instance.

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

Example response

{
  "connectorResourceId": "b4cf21b1-0292-4803-8d32-9ebf9f5359a2",
  "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
  "resourceDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
  "role": "SOURCE",
  "externalResourceName": "/employees/{employee_id}",
  "accessProtocol": "HTTPS",
  "endpointId": "27d8bfc5-6c75-4e4e-a78a-63ad7a924cb1"
}