Skip To Content
ArcGIS Developers
Dashboard

Big Data Catalog Service

Description

License:

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

This resource returns the root response for a big data catalog service. Big data catalog services are a new service type introduced in ArcGIS Enterprise 10.5. Web clients can browse this service to find information about datasets registered as a big data file share and use it as input to GeoAnalytics tasks.

The response returns an array containing each dataset's name, type, and geometryType, when applicable. It also returns the dataStoreID property, which corresponds to the ID of the big data file share item. As of 10.7, the response returns outputTemplates if it has been defined for the Big Data File Share resource.

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 a Big Data Catalog Service resource:

https://machine.domain.com/webadaptor/rest/services/DataStoreCatalogs/bigDataFileShares_SFOData/BigDataCatalogServer?f=pjson

JSON Response syntax

{
  "dataStoreID": "<dataStoreId value>",
  "outputTemplates": [
    {
      "name": "<name>",
      "title": "<title>"
    }
  ],
  "currentVersion": <currentVersion>,
  "children": [
    {
      "name": "<name>",
      "type": "<type>"
    },
    {
      "name": "<name>",
      "geometryType": "<geometryType>",
      "type": "<type>"
    }
  ]
}

JSON Response example

{
  "dataStoreID": "4c2b8b9b-89b0-4fba-b20c-37771121f7b5",
  "outputTemplates": [
    {
      "name": "csv",
      "title": "csv"
    }
  ],
  "currentVersion": 10.7,
  "children": [
    {
      "name": "2016",
      "type": "table"
    },
    {
      "name": "SFPlantFinder",
      "geometryType": "esriGeometryPolygon",
      "type": "featureClass"
    },
    {
      "name": "SF_Urban_Tree_Canopy",
      "geometryType": "esriGeometryPolygon",
      "type": "featureClass"
    }
  ]
}