Services/Root Folder

URL:: https://<root>/services
Methods:: GET
Operations:: Can Create Service, Create Folder, Create Service, Delete Services, Edit Folder, Exists, Export Services, Federate, Import Services, Rename Service, Start Services, Stop Services, Unfederate
Child Resources:: Report, Permissions, Types, Folders, Service, Properties, Webhooks
Required Capability:: Access allowed with any authorized privilege
Version Introduced:: 10.1

Description

The services resource acts as the root folder and container for all subfolders and GIS services. You can create a new subfolder by using the Create Folder operation and a new GIS service by using the Create Service operation.

Request parameters

Parameter Description

Parameter	Description
`detail`	Indicates that a detailed description is expected. The default value is `false`. Values: `true` \| `false`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

detail

Indicates that a detailed description is expected. The default value is false.

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the services resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/services?detail=true&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "folderName": "/",
  "description": "Root folder",
  "webEncrypted": <webEncrypted>,
  "isDefault": <isDefault>,
  "folders": [
    "<folderName1>",
    "<folderName2>"
  ],
  "foldersDetail": [
    {
      "folderName": "<folderName>",
      "description": "<description>",
      "webEncrypted": <webEncrypted>,
      "isDefault": <isDefault>
    }
  ],
  "services": [
    {
      "folderName": "<folderName>",
      "serviceName": "<serviceName>",
      "type": "<serviceType>",
      "description": "<description>"
    }
  ]
}

The full name of a service is represented in JSON as follows

Use dark colors for code blocksCopy
{
  "folderName”: <folderName>,
  "serviceName”: <name>,
  "serviceType”: <type>,
  "description”: <description>
}

JSON Response example

Use dark colors for code blocksCopy
{
  "folderName": "/",
  "description": "Root folder",
  "webEncrypted": false,
  "isDefault": false,
  "folders": [
    "System",
    "Utilities"
  ],
  "foldersDetail": [
    {
      "folderName": "System",
      "description": "The System folder contains automatically deployed services that are used by ArcGIS Server.",
      "webEncrypted": false,
      "isDefault": true
    },
    {
      "folderName": "Utilities",
      "description": "The Utilities folder contains automatically deployed services that can be used by application developers.",
      "webEncrypted": false,
      "isDefault": true
    }
  ],
  "services": [
    {
      "folderName": "/",
      "serviceName": "SampleWorldCities",
      "type": "MapServer",
      "description": "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."
    }
  ]
}