Get Harbor Connection Schema

Beta

GET

https://app.polytomic.com/api/harbor/connections/:connection_id/schemas/:schema_id

GET

/api/harbor/connections/:connection_id/schemas/:schema_id

$ curl https://app.polytomic.com/api/harbor/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/schema_id \
>      -H "Authorization: Bearer <token>"

200Retrieved

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

Returns one schema resource authorized by the current Harbor profile.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

connection_idstringRequiredformat: "uuid"

schema_idstringRequired

Response

dataobjectOptional

Authentication

Path parameters

Headers

Response