Metadata

The Metadata section contains settings that define connector objects, stored procedures, and complex types. The metadata section contains the following sections:

Objects — this section contains settings that define the objects and their fields in the connector.

Types — this section contains settings that define complex structured objects — complex types.

Procedures — this section contains settings that define connector’s stored procedures.

Metadata Section Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
"Metadata": {
    "Objects": [{
        "Name": "Customers",
        "Url": "/customers",
        "ResultPath": "data",
        "Columns": [{
                "Name": "Id",
                "APIPath": "id",
                "DbType": "String",
                "Length": 50,
                "Primary": true,
                "Createable": false,
                "Updateable": false
            },
            {
                "Name": "Name",
                "APIPath": "name",
                "DbType": "String",
                "Length": 100,
                "Required": true
            },
            {
                "Name": "Balance",
                "APIPath": "balance",
                "DbType": "Int32"
            },
            {
                "Name": "Addresses",
                "APIPath": "addresses",
                "DbType": "JsonArray",
                "SubType": "AddressType"
            },
        ]
    }],
    "Types": [{
        "Name": "AddressType",
        "Columns": [{
                "Name": "Country",
                "APIPath": "country",
                "DbType": "String",
                "Length": 50
            },
            {
                "Name": "City",
                "APIPath": "city",
                "DbType": "String",
                "Length": 100
            },
            {
                "Name": "Addr",
                "APIPath": "addr",
                "DbType": "String",
                "Length": 500
            }
        ]
    }],
    "Procedures": [{
        "Name": "Ping",
        "Url": "/accounts",
        "Method": "GET",
        "ResultPath": "data"
    }]
}