Get Connection Type

GET

Path parameters

idstringRequired

Headers

X-Polytomic-VersionstringOptional

Response

This endpoint returns an object.

$anchorstringOptional

$commentstringOptional

$defsmap from strings to objectsOptional

$dynamicRefstringOptional

$idstringOptional

$refstringOptional

$schemastringOptional

additionalPropertiesobjectOptional

allOflist of objectsOptional

anyOflist of objectsOptional

constanyOptional

containsobjectOptional

contentEncodingstringOptional

contentMediaTypestringOptional

contentSchemaobjectOptional

defaultanyOptional

dependentRequiredmap from strings to lists of stringsOptional

dependentSchemasmap from strings to objectsOptional

deprecatedbooleanOptional

descriptionstringOptional

elseobjectOptional

enumlist of anyOptional

exampleslist of anyOptional

exclusiveMaximumstringOptional

exclusiveMinimumstringOptional

formatstringOptional

ifobjectOptional

itemsobjectOptional

maxContainsintegerOptional>=0

maxItemsintegerOptional>=0

maxLengthintegerOptional>=0

maxPropertiesintegerOptional>=0

maximumstringOptional

minContainsintegerOptional>=0

minItemsintegerOptional>=0

minLengthintegerOptional>=0

minPropertiesintegerOptional>=0

minimumstringOptional

multipleOfstringOptional

notobjectOptional

oneOflist of objectsOptional

patternstringOptional

patternPropertiesmap from strings to objectsOptional

prefixItemslist of objectsOptional

propertiesmap from strings to anyOptional

propertyNamesobjectOptional

readOnlybooleanOptional

requiredlist of stringsOptional

thenobjectOptional

titlestringOptional

typestringOptional

uniqueItemsbooleanOptional

writeOnlybooleanOptional

Errors

GET

1 curl https://app.polytomic.com/api/connection_types/postgresql \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "$anchor": "anchor",
3   "$comment": "comment",
4   "$dynamicRef": "dynamicRef",
5   "$id": "id",
6   "$ref": "ref",
7   "$schema": "schema",
8   "const": {
9     "key": "value"
10   },
11   "contentEncoding": "contentEncoding",
12   "contentMediaType": "contentMediaType",
13   "default": {
14     "key": "value"
15   },
16   "dependentRequired": {
17     "key": [
18       "value"
19     ]
20   },
21   "deprecated": true,
22   "description": "description",
23   "enum": [
24     {
25       "key": "value"
26     }
27   ],
28   "examples": [
29     {
30       "key": "value"
31     }
32   ],
33   "exclusiveMaximum": "exclusiveMaximum",
34   "exclusiveMinimum": "exclusiveMinimum",
35   "format": "format",
36   "maxContains": 1,
37   "maxItems": 1,
38   "maxLength": 1,
39   "maxProperties": 1,
40   "maximum": "maximum",
41   "minContains": 1,
42   "minItems": 1,
43   "minLength": 1,
44   "minProperties": 1,
45   "minimum": "minimum",
46   "multipleOf": "multipleOf",
47   "pattern": "pattern",
48   "properties": {
49     "key": "value"
50   },
51   "readOnly": true,
52   "required": [
53     "required"
54   ],
55   "title": "title",
56   "type": "type",
57   "uniqueItems": true,
58   "writeOnly": true
59 }

List Connections

Up Next

1	curl https://app.polytomic.com/api/connection_types/postgresql \
2	-H "Authorization: Bearer <token>"

1	{
2	"$anchor": "anchor",
3	"$comment": "comment",
4	"$dynamicRef": "dynamicRef",
5	"$id": "id",
6	"$ref": "ref",
7	"$schema": "schema",
8	"const": {
9	"key": "value"
10	},
11	"contentEncoding": "contentEncoding",
12	"contentMediaType": "contentMediaType",
13	"default": {
14	"key": "value"
15	},
16	"dependentRequired": {
17	"key": [
18	"value"
19	]
20	},
21	"deprecated": true,
22	"description": "description",
23	"enum": [
24	{
25	"key": "value"
26	}
27	],
28	"examples": [
29	{
30	"key": "value"
31	}
32	],
33	"exclusiveMaximum": "exclusiveMaximum",
34	"exclusiveMinimum": "exclusiveMinimum",
35	"format": "format",
36	"maxContains": 1,
37	"maxItems": 1,
38	"maxLength": 1,
39	"maxProperties": 1,
40	"maximum": "maximum",
41	"minContains": 1,
42	"minItems": 1,
43	"minLength": 1,
44	"minProperties": 1,
45	"minimum": "minimum",
46	"multipleOf": "multipleOf",
47	"pattern": "pattern",
48	"properties": {
49	"key": "value"
50	},
51	"readOnly": true,
52	"required": [
53	"required"
54	],
55	"title": "title",
56	"type": "type",
57	"uniqueItems": true,
58	"writeOnly": true
59	}