Skip To Content

/categorySchema: Group Category Schema

  • URL:https://[root]/community/groups/[groupID]/categorySchema

Example usage

The following is a sample ArcGIS Online request URL used to access the categorySchema resource:

https://www.arcgis.com/sharing/rest/community/groups/826ab72ed44c48beb8735c2634e0bfad/categorySchema?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the categorySchema resource:

https://machine.domain.com/webadaptor/sharing/rest/community/groups/826ab72ed44c48beb8735c2634e0bfad/categorySchema?f=pjson

Description

The categorySchema resource returns a group's currently configured category schema. The category schema represents the content categories for the organization, which acts as a hierarchical set of classes to help organize and browse items.

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
categorySchema

A JSON object that consists of a JSON array representing the top level categories. Each category object has title, description and categories properties, where categories consists of an array of objects with each having the same properties and represents the descendant or child categories and so on.

Example


{
  "categorySchema": [
    {
      "title": "Categories",
      "categories": [
        {
          "title": "Basemaps",
          "categories": [
            {
              "title": "Partner Basemap"
            },
            {
              "title": "Esri Basemaps",
              "categories": [
              {
                "title": "Esri Raster Basemap"
              },
              {
                "title": "Esri Vector Basemap"
              }
            ]
          }
        ]
      },
      {
        "title": "Imagery",
        "categories": [
          {
            "title": "Multispectral Imagery"
          },
          {
            "title": "Temporal Imagery"
          }
        ]
      }
    ]
  },
  {
    "title": "Region",
    "categories": [
      {
        "title": "US"
      },
      {
        "title": "World"
      }
    ]
  }
]

JSON Response syntax


{
  "categorySchema": [
    {
      "title": "<root category title>",
      "description": "<root category description>",
      "categories": [
        {
          "title": "<parent category title>",
          "description": "<parent category description>",
          "categories": [
            {
              "title": "<child category title>",
              "description": "<child category description>",
              "categories": [
                {
                  "title": "<grandchild category title>",
                  "description": "<grandchild category description>" 
                }
                ....   
              ]
            }
            ....
          ]
        }
        ....
      ]
    }
    ....
  ]
}

JSON Response example


{
  "categorySchema": [
    {
      "title": "Categories",
      "categories": [
        {
          "title": "Basemaps",
          "categories": [
            {
              "title": "Partner Basemap"
            },
            {
              "title": "Esri Basemaps",
              "categories": [
                {
                  "title": "Esri Raster Basemap"
                },
                {
                  "title": "Esri Vector Basemap"
                }
              ]
            }
          ]
        },
        {
          "title": "Imagery",
          "categories": [
            {
              "title": "Multispectral Imagery"
            },
            {
              "title": "Temporal Imagery"
            }
          ]
        }
      ]
    },
    {
      "title": "Region",
      "categories": [
        {
          "title": "US"
        },
        {
          "title": "World"
        }
      ]
    }
  ]
}