POpolytomic
Models

Get Enrichment Source

Changed on

Describes the enrichment source configuration available on a connection.

Not all connections support enrichment. Call this endpoint to determine whether a connection can serve as an enrichment source in a model sync and, if so, what configuration it accepts.

⚠️ If the connection does not support enrichment, this endpoint returns 404. Check for that status before attempting to configure an enrichment source on a sync.

When a connection does support enrichment, the response describes the configuration fields required to set it up. Pass those values in the enrichment block when creating or updating a model sync.

get/api/connections/{id}/modelsync/enrichment-source

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the connection

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

paramsobject

Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration fields returned by previous calls to this endpoint.

Headers

X-Polytomic-Versionstring

Response

OK

Changes

  • 61c2b96f65baRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status