Get Bulk Destination

GET

https://app.polytomic.com/api/bulk/dest/:id

GET

/api/bulk/dest/:id

curl -G https://app.polytomic.com/api/bulk/dest/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>" \
     -d source_connection_id=248df4b7-aa70-47b8-a036-33ac447e668d

{
  "data": {
    "configuration": {
      "advanced": {
        "items": {
          "truncate_existing": {
            "default": "",
            "items": null,
            "required": false
          }
        }
      },
      "mirror_schemas": {
        "default": "",
        "items": null,
        "required": false
      },
      "schema": {
        "default": "",
        "items": null,
        "required": false
      }
    },
    "initial_configuration": {},
    "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"
    ],
    "supports_history_mode": false
  }
}

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

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Connection ID

Query parameters

source_connection_idstringOptionalformat: "uuid"

Source Connection ID used to suggest initial destination configuration values

Response

dataobjectOptional

The connection's bulk sync destination capabilities

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors