Skip to content
URL:
https://<root>/services/<folderName>
Methods:
GET
Version Introduced:
10.9

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.


Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The resource for an individual folder returns the folder's properties, including the folder's name and the services it contains.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/services/folderName?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "folderName": "<folder_name>",
  "services": [<full_service_name1>, <full_service_name2>]
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
  "folderName": "Test",
  "services": [
    {
      "allowedUploadFileTypes": "",
      "private": false,
      "maxUsageTime": 600,
      "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.",
      "maxInstancesPerNode": 1,
      "minInstancesPerNode": 1,
      "datasets": [],
      "type": "MapServer",
      "frameworkProperties": {},
      "serverId": "vb4fb43f2-19b0-4bcd-842a-789a2299a282",
      "instancesPerContainer": 1,
      "recycleStartTime": "00:00",
      "maxUploadFileSize": 0,
      "provider": "ArcObjects",
      "clusterName": "default",
      "id": "s0b4d74be-79d5-49f4-9424-c5c236cc7b42",
      "maxStartupTime": 300,
      "capabilities": "Map,Query,Data",
      "maxWaitTime": 60,
      "recycleInterval": 24,
      "maxIdleTime": 180,
      "serviceName": "SampleWorldCities",
      "loadBalancing": "ROUND_ROBIN",
      "keepAliveInterval": -1,
      "configuredState": "STARTED",
      "isDefault": false,
      "extensions": [
        {
          "allowedUploadFileTypes": "",
          "capabilities": "GetCapabilities,GetFeatureInfo,GetLegendGraphic,GetMap,GetSchemaExtension,GetStyles",
          "maxUploadFileSize": 0,
          "typeName": "WMSServer",
          "enabled": "true",
          "properties": {
            "name": "SampleWorldCities",
            "title": "WMS"
          }
        },
        {
          "allowedUploadFileTypes": "",
          "capabilities": "SingleImage,SeparateImages,Vectors",
          "maxUploadFileSize": 0,
          "typeName": "KmlServer",
          "enabled": "true",
          "properties": {
            "compatibilityMode": "GoogleEarth",
            "useDefaultSnippets": "true",
            "featureLimit": "1000000",
            "minRefreshPeriod": "30",
            "imageSize": "1024",
            "dpi": "96"
          }
        },
        {
          "allowedUploadFileTypes": "",
          "capabilities": "Create,Query,Update,Delete,Uploads",
          "maxUploadFileSize": 0,
          "typeName": "FeatureServer",
          "enabled": "false",
          "properties": {}
        }
      ],
      "isolationLevel": "HIGH",
      "properties": {
        "useLocalCacheDir": "true",
        "outputDir": "${arcgisoutput}",
        "cacheDir": "${arcgiscache}",
        "maxScale": "4000",
        "filePath": "/arcgis/framework/etc/data/WorldCities/WorldCities.msd",
        "maxRecordCount": "1000",
        "supportedImageReturnTypes": "MIME+URL",
        "clientCachingAllowed": "true",
        "isCached": "false",
        "virtualOutputDir": "/rest/directories/arcgisoutput",
        "maxExportTilesCount": "100000",
        "ignoreCache": "false",
        "exportTilesAllowed": "false",
        "cacheOnDemand": "false",
        "minScale": "295000000"
      },
      "portalProperties": {
        "isHosted": false,
        "portalItems": [
          {
            "itemID": "40c7a59f475742638586a3ac0585b797",
            "type": "MapServer"
          },
          {
            "itemID": "bfbaa9025383449ebc6b0f98650b903d",
            "type": "WMSServer"
          }
        ]
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.