Get Bulk Source Schema

curl https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/schema/schema_id \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": {
    "fields": [
      {
        "association": {
          "id": "assoc_01",
          "name": "User to Orders",
          "reference_to": [
            "orders"
          ],
          "referenced_field": "user_id"
        },
        "id": "email",
        "is_primary_key": true,
        "name": "Email",
        "path": "$.contact.email",
        "remote_type": "varchar(255)",
        "type": "string",
        "user_managed": true,
        "values": [
          {
            "label": "Work Email",
            "value": "work@example.com"
          }
        ]
      }
    ],
    "id": "contact",
    "name": "Contact"
  }
}

Returns a single schema from a connection's cached schemas.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

connection_idstringRequiredformat: "uuid"

Unique identifier of the connection.

schema_idstringRequired

Identifier of the schema within the connection.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Get Bulk Source Schema

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

$	curl https://app.polytomic.com/api/bulk/source/248df4b7-aa70-47b8-a036-33ac447e668d/schema/schema_id \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>"

1	{
2	"data": {
3	"fields": [
4	{
5	"association": {
6	"id": "assoc_01",
7	"name": "User to Orders",
8	"reference_to": [
9	"orders"
10	],
11	"referenced_field": "user_id"
12	},
13	"id": "email",
14	"is_primary_key": true,
15	"name": "Email",
16	"path": "$.contact.email",
17	"remote_type": "varchar(255)",
18	"type": "string",
19	"user_managed": true,
20	"values": [
21	{
22	"label": "Work Email",
23	"value": "work@example.com"
24	}
25	]
26	}
27	],
28	"id": "contact",
29	"name": "Contact"
30	}
31	}