Get Bulk Destination | Polytomic Docs

curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/bulksync/target \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

{
  "data": {
    "configuration": {
      "advanced": {
        "items": {
          "truncate_existing": {
            "default": "",
            "required": false
          }
        }
      },
      "mirror_schemas": {
        "default": "",
        "required": false
      },
      "schema": {
        "default": "",
        "required": false
      }
    },
    "modes": [
      {
        "description": "Replace all records",
        "id": "snapshot",
        "label": "Replace",
        "requires_identity": false,
        "supports_field_sync_mode": false,
        "supports_target_filters": false
      }
    ],
    "supported_resync_modes": [
      "refetch"
    ]
  }
}

Describes the destination configuration schema a connection accepts when used as a bulk sync destination.

The response is a JSON Schema object describing the shape of the destination_configuration field you must supply when creating or updating a bulk sync that uses this connection as its destination. Required fields vary by connection type.

📘 Fetch this endpoint once per connection type rather than once per sync. The configuration schema is the same for all syncs sharing the same destination connection.

Describes the destination configuration schema a connection accepts when used as a bulk sync destination. The response is a JSON Schema object describing the shape of the `destination_configuration` field you must supply when [creating](../../../../../api-reference/bulk-sync/create) or [updating](../../../../../api-reference/bulk-sync/update) a bulk sync that uses this connection as its destination. Required fields vary by connection type. > 📘 Fetch this endpoint once per connection type rather than once per sync. > The configuration schema is the same for all syncs sharing the same > destination connection.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors