Big Data Catalog Service Manifest

URL:
https://<BigDataCatalogService-url>/manifest
Methods:
GET
Version Introduced:
10.5

Description

The Manifest resource provides the schema for a big data file share. A manifest will be autogenerated for each big data file share that is registered with your GeoAnalytics server. You can also edit a big data file share and upload an updated manifest file.

Request parameters

ParameterDetails

f

The response format. The default response format is html. Values: html | json | pjson

Example usage

Below is a sample request URL for the big data file share Manifest resource:

Use dark colors for code blocksCopy
1
https://services.myserver.com/arcgis/rest/services/DataStoreCatalogs/bigDataFileShares_SFOData/BigDataCatalogServer/manifest?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
  "datasets": [
    {
      "name": "<name>", //the name of the dataset
      "type": "<table|featureClass>",
      "description": "<description>",
      "format": { //more information about how the files are structured
        "fieldDelimiter": "<fieldDelimiter>",
        "recordTerminator": "<recordTerminator>",
        "hasHeaderRow": <true|false>,
        "path": "<path>", //the path of the dataset in the data store
        "extension": "<extension>", //how the files are named
      },
      "schema": { //listing of every field with its type
        "fields": [
          {
            "name": "<name>",
            "type": "<esriFieldTypeInteger|esriFieldTypeDouble|esriFieldTypeString>" //only simple types as users need to define these
          }
        ]
      },
      "pseudoFields": [ //interpretations of the fields to make them meaningful
        {
          "name": "<name_of_pseudo_field>",
          "type": "<space|time>", //only supported types of interpretations for now
          "subType": "<point|line|polygon|instant|interval>",
          "fields": [
            {
              "name": "<fieldName>",
              "formats": [
                "<format1>",
                "<format2>"
              ],
              "role": "<startTime|endTime>"
            }, //format dictates the parsing logic for the fields, role is needed in the case of interval composition
            {
              "name": "<fieldName>",
              "formats": [
                "<format1>",
                "<format2>"
              ],
              "role": "<startTime|endTime>"
            }
          ],
          "reference": <reference_for_field_type>, //reference for the type
        }
      ],
      "geometry": {
        "geometryType": "<esriGeometryPoint|esriGeometryPolyline|esriGeometryPolygon>",
        "fields": [
          {
            "name": "<fieldName>",
            "formats": [
              "<format1>",
              "<format2>"
            ],
            "role": "<startTime|endTime>"
          }, //format dictates the parsing logic for the fields, role is needed in the case of interval composition
          {
            "name": "<fieldName>",
            "formats": [
              "<format1>",
              "<format2>"
            ],
            "role": "<startTime|endTime>"
          }
        ],
        "spatialReference": {<spatialReference>}
      },
      "time": {
        "timeType": "<instant|interval>",
        "fields": [
          {
            "name": "<fieldName>",
            "formats": [
              "<format1>",
              "<format2>"
            ],
            "role": "<startTime|endTime>"
          }, //format dictates the parsing logic for the fields, role is need in the case of interval composition
          {
            "name": "<fieldName>",
            "formats": [
              "<format1>",
              "<format2>"
            ],
            "role": "<startTime|endTime>"
          }
        ],
        "timeReference": {<timeReference>}
      }
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
{
  "datasets": [
    {
      "name": "folder space",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "date time",
            "type": "esriFieldTypeString"
          },
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeInteger"
          },
          {
            "name": "lat",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "long",
            "type": "esriFieldTypeDouble"
          }
        ]
      },
      "geometry": {
        "geometryType": "esriGeometryPoint",
        "spatialReference": {"wkid": 4326},
        "fields": [
          {
            "name": "long",
            "formats": ["x"]
          },
          {
            "name": "lat",
            "formats": ["y"]
          }
        ]
      },
      "time": {
        "timeType": "instant",
        "timeReference": {
          "timeZone": "UTC"
        },
        "fields": [
          {
            "name": "date time",
            "formats": ["MM/dd/yyyy"]
          }
        ]
      }
    },
    {
      "name": "geo_only",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeBigInteger"
          },
          {
            "name": "x",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "y",
            "type": "esriFieldTypeDouble"
          }
        ]
      }
    },
    {
      "name": "multipart",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "datetime",
            "type": "esriFieldTypeString"
          },
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeBigInteger"
          },
          {
            "name": "lat",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "long",
            "type": "esriFieldTypeDouble"
          }
        ]
      }
    },
    {
      "name": "no_time_or_geo",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeBigInteger"
          },
          {
            "name": "new_val",
            "type": "esriFieldTypeBigInteger"
          }
        ]
      }
    },
    {
      "name": "time_and_geo",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "datetime",
            "type": "esriFieldTypeString"
          },
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeBigInteger"
          },
          {
            "name": "lat",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "long",
            "type": "esriFieldTypeDouble"
          }
        ]
      },
      "geometry": {
        "geometryType": "esriGeometryPoint",
        "spatialReference": {"wkid": 4326},
        "fields": [
          {
            "name": "long",
            "formats": ["x"]
          },
          {
            "name": "lat",
            "formats": ["y"]
          }
        ]
      },
      "time": {
        "timeType": "instant",
        "timeReference": {
          "timeZone": "UTC"
        },
        "fields": [
          {
            "name": "datetime",
            "formats": ["MM/dd/yyyy"]
          }
        ]
      }
    },
    {
      "name": "time_only_mixed",
      "format": {
        "type": "delimited",
        "extension": "csv",
        "fieldDelimiter": ",",
        "recordTerminator": "\n",
        "hasHeaderRow": true
      },
      "schema": {
        "fields": [
          {
            "name": "datetime",
            "type": "esriFieldTypeString"
          },
          {
            "name": "stringfields",
            "type": "esriFieldTypeString"
          },
          {
            "name": "value",
            "type": "esriFieldTypeBigInteger"
          }
        ]
      },
      "time": {
        "timeType": "instant",
        "timeReference": {
          "timeZone": "UTC"
        },
        "fields": [
          {
            "name": "datetime",
            "formats": ["MM/dd/yyyy"]
          }
        ]
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.