--- title: "Create a route exposure descriptor" method: POST path: "/route/exposures" tags: ["RouteExposures"] --- # Create a route exposure descriptor `POST /route/exposures` Creates or replaces a route exposure descriptor for an externally initiated connector capability. This registers the externally callable surface but does not by itself implement the runtime endpoint for the external caller. ## Request body - RouteExposureDescriptorCreateRequest — Request to persist a route exposure descriptor. - `exposure` RouteExposureDescriptor, required — Externally callable connector route capability and its caller, schema, subset, payload, rate, and audit constraints. - `exposureDescriptorId` string, required — Stable identifier of an externally callable route exposure descriptor. - `exposedCapabilityId` string, required - `owningTenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `logicalConnectionBindingId` string, required — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `exchangeMode` 'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC', required — Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses. - `allowedOperation` '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. - `acceptedAuthMethods` string[], required - `callerPartyConstraints` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `callerRelationshipConstraints` RelationshipRef[] - `relationshipId` string - `relationshipType` string, required - `fromParty` PartyRef, required — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `toParty` PartyRef, required — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `requestSchemaRef` string - `responseSchemaRef` string - `subsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `cursorStrategy` string - `idempotencyKeyStrategy` string - `payloadLimitBytes` integer - `rateLimitKey` string - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' — Audit category used by governed connector invocations, runs, and externally callable route exposures. ## Response `201` Route exposure descriptor created. - RouteExposureDescriptor — Externally callable connector route capability and its caller, schema, subset, payload, rate, and audit constraints. - `exposureDescriptorId` string, required — Stable identifier of an externally callable route exposure descriptor. - `exposedCapabilityId` string, required - `owningTenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `logicalConnectionBindingId` string, required — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `exchangeMode` 'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC', required — Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses. - `allowedOperation` '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. - `acceptedAuthMethods` string[], required - `callerPartyConstraints` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `callerRelationshipConstraints` RelationshipRef[] - `relationshipId` string - `relationshipType` string, required - `fromParty` PartyRef, required — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `toParty` PartyRef, required — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `requestSchemaRef` string - `responseSchemaRef` string - `subsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `cursorStrategy` string - `idempotencyKeyStrategy` string - `payloadLimitBytes` integer - `rateLimitKey` string - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' — Audit category used by governed connector invocations, runs, and externally callable route exposures. ## Other responses - `400` — Validation error. - `401` — Authentication is required. --- [API](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/connector-integration-profile-api/versions/60cb8c70871b/schema)