Get Bulk Destination

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

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

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

Get Bulk Destination

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

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

1	{
2	"data": {
3	"configuration": {
4	"advanced": {
5	"items": {
6	"truncate_existing": {
7	"default": "",
8	"items": null,
9	"required": false
10	}
11	}
12	},
13	"mirror_schemas": {
14	"default": "",
15	"items": null,
16	"required": false
17	},
18	"schema": {
19	"default": "",
20	"items": null,
21	"required": false
22	}
23	},
24	"modes": [
25	{
26	"description": "Replace all records",
27	"id": "snapshot",
28	"label": "Replace",
29	"requires_identity": false,
30	"supports_field_sync_mode": false,
31	"supports_target_filters": false
32	}
33	],
34	"supported_resync_modes": [
35	"refetch"
36	]
37	}
38	}