ArcGIS Server Services Directory root

URL:: https://machine.domain.com/webadaptor/rest/services
Methods:: GET
Version Introduced:: 9.3

Description

The root resource page resource is the initial entry point into the ArcGIS Server Services Directory. This resource represents a catalog of published folders and services on an ArcGIS Server site. The current version of ArcGIS Server is also returned in the response. The value of the version is a number such that its value at a future release is guaranteed to be greater than its value at a previous release.

Request parameters

Parameter Details

Parameter	Details
`option`	Note Support for footprints has been removed at ArcGIS Enterprise 11.1, and the `footprints` value for this parameter has been deprecated. If `option` is `footprints` , the footprints of all map, feature, and image services in that folder are returned as a feature collection. This is only supported the response format (`f` ) is set to `json` . Value: `footprints`
`outSR`	Note Support for footprints has been removed at ArcGIS Enterprise 11.1. The spatial reference of the geometry returned in footprints. This parameter is supported only when `option` is specified as `footprints` . The spatial reference should be specified as a well-known ID. If `outSR` is not specified, the geometry is returned in `GCS_WGS_1984` .
`f`	The response format. The default response format is `html` . Note The `sitemap` and `geositemap` formats generate XML sitemaps that can be submitted to various search engines. The `sitemap` format includes the Services Directory URLs to all your services. The `geositemap` format includes the KMZ footprint URLs to your map and image services. Note that if you've enabled security, an empty sitemap will be generated. Values: `html` \| `json` \| `kmz` \| `sitemap` \| `geositemap`

option

If option is footprints , the footprints of all map, feature, and image services in that folder are returned as a feature collection. This is only supported the response format (f ) is set to json .

Value: footprints

outSR

The spatial reference of the geometry returned in footprints. This parameter is supported only when option is specified as footprints . The spatial reference should be specified as a well-known ID. If outSR is not specified, the geometry is returned in GCS_WGS_1984 .

f

The response format. The default response format is html .

Values: html | json | kmz | sitemap | geositemap

Example usage

The following is a sample request URL used to access the root resource of the ArcGIS REST Services Directory API:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services

JSON Response syntax

The following is a sample JSON response syntax for the root resource:

Use dark colors for code blocksCopy
{
  "currentVersion": <currentVersion>,
  "folders": [
    "<folderName1>",
    "<folderName2>"
  ],
  "services": [
    {
      "name": "<serviceName1>",
      "type": "<serviceType1>"
    },
    {
      "name": "<serviceName2>",
      "type": "<serviceType2>"
    }
  ]
}

The following is a sample JSON response syntax for a root resource when option is set to footprints and f is set to json .

Use dark colors for code blocksCopy
{
  "featureCollection": {
    "layers": [
      {
        "layerDefinition": {
          "type": "Feature Layer",
          "geometryType": "esriGeometryPoint",
          "extent": {
            <envelope>
          }
        },
        "objectIdField": "id",
        "displayFieldName": "name",
        "drawingInfo": {
          "renderer": {
            "type": "simple",
            "label": <label>,
            "description": "<description>",
            "symbol": {
              "height": <height>,
              "xoffset": <xoffset>,
              "yoffset": <yoffset>,
              "width": <width>,
              "contentType": "image/png",
              "type": "esriPMS",
              "imageData": "<imageData>",
              "url": "<url>"
            }
          }
        },
        "fields": [
          {
            "name": "id",
            "alias": "ID",
            "type": "esriFieldTypeOID"
          },
          {
            "name": "title",
            "alias": "Title",
            "type": "esriFieldTypeString"
          },
          {
            "name": "type",
            "alias": "Type",
            "type": "esriFieldTypeString"
          },
          {
            "name": "thumbnail",
            "alias": "Thumbnail",
            "type": "esriFieldTypeString"
          },
          {
            "name": "xmin",
            "alias": "xmin",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "ymin",
            "alias": "ymin",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "xmax",
            "alias": "xmax",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "ymax",
            "alias": "ymax",
            "type": "esriFieldTypeDouble"
          },
          {
            "name": "link",
            "alias": "Link",
            "type": "esriFieldTypeString"
          },
          {
            "name": "arcgisJslink",
            "alias": "ArcgisJsLink",
            "type": "esriFieldTypeString"
          }
        ]
      },
      "featureSet": {
        "geometryType": "esriGeometryPoint",
        "spatialReference": {
          "wkid": <wkid>
        },
        "features": [
          {
            "geometry": {
              <point>
            },
            "attributes": {
              "id": <id0>,
              "title": "<title>",
              "summary": "<summary>",
              "type": "<serviceType>",
              "thumbnail": "<thumbnailUrl>",
              "xmin": <xmin>,
              "ymin": <ymin>,
              "xmax": <xmax>,
              "ymax": <ymax>,
              "link": "<serviceResource>",
              "arcgisJslink": "<View In JSAPI link>"
            }
          },
          {
            "geometry": {
              <point>
            },
            "attributes": {
              "id": <id1>,
              "title": "<title>",
              "summary": "<summary>",
              "type": "<serviceType>",
              "thumbnail": "<thumbnailUrl>",
              "xmin": <xmin>,
              "ymin": <ymin>,
              "xmax": <xmax>,
              "ymax": <ymax>,
              "link": "<serviceResource>",
              "arcgisJslink": "<View In JSAPI link>"
            }
          },
          {
            "geometry": {
              <point>
            },
            "attributes": {
              "id": <id2>,
              "title": "<title>",
              "summary": "<summary>",
              "type": "<serviceType>",
              "thumbnail": "<thumbnailUrl>",
              "xmin": <xmin>,
              "ymin": <ymin>,
              "xmax": <xmax>,
              "ymax": <ymax>,
              "link": "<serviceResource>",
              "arcgisJslink": "<View In JSAPI link>"
            }
          },
          {
            "geometry": {
              <point>
            },
            "attributes": {
              "id": <id3>,
              "title": "<title>",
              "summary": "<summary>",
              "type": "<serviceType>",
              "thumbnail": "<thumbnailUrl>",
              "xmin": <xmin>,
              "ymin": <ymin>,
              "xmax": <xmax>,
              "ymax": <ymax>,
              "link": "<serviceResource>",
              "arcgisJslink": "<View In JSAPI link>"
            }
          }
        ]
      },
      "popupInfo": {
        "title": "{title}",
        "fieldInfos": [
          {
            "fieldName": "id",
            "label": "ID",
            "visible": false
          },
          {
            "fieldName": "title",
            "label": "Title",
            "visible": true
          },
          {
            "fieldName": "type",
            "label": "Type",
            "visible": true
          },
          {
            "fieldName": "thumbnail",
            "label": "Thumbnail",
            "visible": false
          },
          {
            "fieldName": "link",
            "label": "Link",
            "visible": true
          }
        ],
        "description": null,
        "showAttachments": false,
        "mediaInfos": [
          {
            "type": "image",
            "value": {
              "sourceURL": "{thumbnail}",
              "linkURL": "{arcgisJslink}"
            }
          }
        ]
      }
    ]
  }
}

JSON Response examples

The following is a sample response returned by the root resource:

Use dark colors for code blocksCopy
{
  "currentVersion":11.1,
  "folders": [
    "Utilities"
  ],
  "services": [
    {
      "name":"SampleWorldCities",
      "type":"MapServer"
    }
  ]
}

The following is a sample response returned when option is set to footprints and f is set to json :

Use dark colors for code blocksCopy
{
  "featureCollection": {
    "layers": [
      {
        "layerDefinition":{
          "type":"Feature Layer",
          "geometryType":"esriGeometryPoint",
          "extent": {
            "xmin":-120.53020709870626,
            "ymin":-18.471925275660684,
            "xmax":120.35704494206294,
            "ymax":64.90814663394004,
            "spatialReference": {
              "wkid":4326
            }
          },
          "objectIdField":"id",
          "displayFieldName":"name",
          "drawingInfo":{
            "renderer":{
              "type":"simple",
              "label":"",
              "description":"",
              "symbol": {
                "height":24,
                "xoffset":0,
                "yoffset":0,
                "width":24,
                "contentType":"image/png",
                "imageData":"...",
                "url":"https://machine.domain.com/webadaptor/rest/static/images/GreenShinyPin.png"
              }
            }
          },
          "fields": [
            {
              "name": "id",
              "alias": "ID",
              "type": "esriFieldTypeOID"
            },
            {
              "name": "title",
              "alias": "Title",
              "type": "esriFieldTypeString"
            },
            {
              "name": "type",
              "alias": "Type",
              "type": "esriFieldTypeString"
            },
            {
              "name": "summary",
              "alias": "Summary",
              "type": "esriFieldTypeString"
            },
            {
              "name": "thumbnail",
              "alias": "Thumbnail",
              "type": "esriFieldTypeString"
            },
            {
              "name": "xmin",
              "alias": "xmin",
              "type": "esriFieldTypeDouble"
            },
            {
              "name": "ymin",
              "alias": "ymin",
              "type": "esriFieldTypeDouble"
            },
            {
              "name": "xmax",
              "alias": "xmax",
              "type": "esriFieldTypeDouble"
            },
            {
              "name": "ymax",
              "alias": "ymax",
              "type": "esriFieldTypeDouble"
            },
            {
              "name": "link",
              "alias": "Link",
              "type": "esriFieldTypeString"
            },
            {
              "name": "arcgisJslink",
              "alias": "ArcgisJslink",
              "type": "esriFieldTypeString"
            }
          ]
        },
        "featureSet": {
          "geometryType": "esriGeometryPoint",
          "spatialReference": {
            "wkid": 4326
          },
          "features": [
            {
              "geometry": {
                "x": -14.586581078321657,
                "y": 13.218110679139677
              },
              "attributes": {
                "id": 0,
                "title": "SampleWorldCities",
                "type": "MapServer",
                "summary": "The SampleWorldCities service is provided so you can quickly and easily preview the functionality of the GIS server. Click the thumbnail image to open in a web application. This sample service is optional and can be deleted.",
                "thumbnail": "https://machine.domain.com/webadaptor/rest/services/SampleWorldCities/MapServer/info/thumbnail",
                "xmin": -103.80966151584494,
                "ymin": -40.27311509271942,
                "xmax": 74.63649935920162,
                "ymax": 66.70933645099878,
                "link": "https://machine.domain.com/webadaptor/rest/services/SampleWorldCities/MapServer",
                "arcgisJslink": "https://machine.domain.com/webadaptor/rest/services/SampleWorldCities/MapServer?f=jsapi"
              }
            }
          ]
        },
        "popupInfo": {
          "title": "{title} ({type})",
          "fieldInfos": [
            {
              "fieldName": "id",
              "label": "ID",
              "visible": false
            },
            {
              "fieldName": "title",
              "label": "Title",
              "visible": true
            },
            {
              "fieldName": "type",
              "label": "Type",
              "visible": true
            },
            {
              "fieldName": "summary",
              "label": "Summary",
              "visible": true
            },
            {
              "fieldName": "thumbnail",
              "label": "Thumbnail",
              "visible": false
            },
            {
              "fieldName": "link",
              "label": "Link",
              "visible": true
            }
          ],
          "description": null,
          "showAttachments": false,
          "mediaInfos": [
            {
              "type": "image",
              "value": {
                "sourceURL": "{thumbnail}",
                "linkURL": "{arcgisJslink}"
              }
            }
          ]
        }
      }
    ]
  }
}

ArcGIS REST APIs

ArcGIS Server Services Directory root

Was this page helpful?