/categorySchema: Organization Category Schema—REST APIs

URL:https://[root]/portals/[portalID]/categorySchema

Example usage

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

https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/categorySchema?f=pjson

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

https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/categorySchema?f=pjson

Description

Content category schema of an organization.

Request parameters


Parameter	Details
f	The response format. The default format is html. Values: html \| json \| pjson

Response properties

Property Details

Property	Details
categorySchema	A JSON object that consists of a JSON array representing the top level categories. Each category object has title, description and categories properties, categories consists of an array of objects with each having the same properties and represents the descendant or child categories and so on. Example [ { "title": "Categories", "description": "Current news and trends.", "categories": [ { "title": "Trending", "description": "Trending news.", "categories": [ { "title": "New and noteworthy", "description": "This is used to categorize all new and noteworthy news.", "categories": [] }, { "title": "Current events", "description": "This is used to categorize all current events.", "categories": [] } ] }, { "title": "Basemaps", "description": "All types of maps.", "categories": [ { "title": "Reference maps", "description": "This is used to categorize all Reference maps.", "categories": [] }, { "title": "Creative maps", "description": "This is used to categorize all creative maps.", "categories": [] }, { "title": "Vector tiles", "description": "This is used to categorize all Vector tile layers.", "categories": [] }, { "title": "Component layers", "description": "This is used to categorize all component layers.", "categories": [] }, { "title": "Historical maps", "description": "This is used to categorize all historic maps.", "categories": [] } ] }, { "title": "Imagery", "description": "All types of Imagery.", "categories": [ { "title": "Basemap imagery", "description": "This is used to categorize all basemap imagery.", "categories": [] }, { "title": "Multispectral imagery", "description": "This is used to categorize all multispectral imagery.", "categories": [] }, { "title": "Temporal imagery", "description": "This is used to categorize all temporal imagery.", "categories": [] }, { "title": "Event imagery", "description": "This is used to categorize all event imagery.", "categories": [] } ] } ] } ]

categorySchema

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

Example


[
  {
    "title": "Categories",
    "description": "Current news and trends.",
    "categories": [
      {
        "title": "Trending",
        "description": "Trending news.",
        "categories": [
          {
            "title": "New and noteworthy",
            "description": "This is used to categorize all new and noteworthy news.",
            "categories": []
          },
          {
            "title": "Current events",
            "description": "This is used to categorize all current events.",
            "categories": []
          }
        ]
      },
      {
        "title": "Basemaps",
        "description": "All types of maps.",
        "categories": [
          {
            "title": "Reference maps",
            "description": "This is used to categorize all Reference maps.",
            "categories": []
          },
          {
            "title": "Creative maps",
            "description": "This is used to categorize all creative maps.",
            "categories": []
          },
          {
            "title": "Vector tiles",
            "description": "This is used to categorize all Vector tile layers.",
            "categories": []
          },
          {
            "title": "Component layers",
            "description": "This is used to categorize all component layers.",
            "categories": []
          },
          {
            "title": "Historical maps",
            "description": "This is used to categorize all historic maps.",
            "categories": []
          }
        ]
      },
      {
        "title": "Imagery",
        "description": "All types of Imagery.",
        "categories": [
          {
            "title": "Basemap imagery",
            "description": "This is used to categorize all basemap imagery.",
            "categories": []
          },
          {
            "title": "Multispectral imagery",
            "description": "This is used to categorize all multispectral imagery.",
            "categories": []
          },
          {
            "title": "Temporal imagery",
            "description": "This is used to categorize all temporal imagery.",
            "categories": []
          },
          {
            "title": "Event imagery",
            "description": "This is used to categorize all event imagery.",
            "categories": []
          }
        ]
      }
    ]
  }
]

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",
      "description": "Main description",
      "categories": [
        {
          "title": "Basemaps",
          "description": "This is used to categorize basemaps.",          
          "categories": [
            {
              "title": "Partner Basemap"
            },
            {
              "title": "Esri Basemaps",
              "description": "This is used to categorize Esri Basemaps.",
              "categories": [
                {
                  "title": "Esri Redlands Basemap"
                },
                {
                  "title": "Esri Highland Basemap"
                }
              ]
            }
          ]
        },
        {
          "title": "Imagery",
          "description": "This is used to categorize different types of imagery.",
          "categories": [
            {
              "title": "Multispectral Imagery"
            },
            {
              "title": "Temporal Imagery"
            }
          ]
        }
      ]
    },
    {
      "title": "Region",
      "description": "This is used to categorize maps by region.",
      "categories": [
        {
          "title": "US"
        },
        {
          "title": "World"
        }
      ]
    }
  ]
}

Feedback on this topic?