Skip To Content
ArcGIS Developers
Dashboard

Big Data Catalog Service Manifest

Description

License:

As of 10.5, you must license your ArcGIS Server as an ArcGIS GeoAnalytics Server to use this resource.

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 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:

https://services.myserver.com/arcgis/rest/services/DataStoreCatalogs/bigDataFileShares_SFOData/BigDataCatalogServer/manifest?f=pjson

JSON Response syntax

{
  "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

{
  "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"]
          }
        ]
      }
    }
  ]
}