- URL:
- https://<root>/services/report
- Methods:
GET- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The report resource provides a configurable summary of all the services in a folder, listing the following parameters for each service in the folder:
- Folder name (
folder)—Name of the folder in which the service is located.Name - Service name (
service)—Name of the service.Name - Service type (
type)—Type of the service. - Description (
description)—Description of the service as added to the service configuration. - State (
status)—Configured and runtime status of the service. - Instances (
instances)— Statistical information about the service. - Properties (
properties)—Collection of properties for the server object within the service. - Item information (
iteminfo)—JSON representation of the item information configured for the service. - Permissions (
permissions)—JSON representation of the permissions configured for the service.
Request parameters
| Parameter | Description |
|---|---|
| The list of properties about a service to be returned in the summary report. By default all the properties are listed. Values: |
| A list of services for which to generate the report. By default all the services in the folder are listed. You need to specify the list as an array of JSON objects representing the fully qualified name of a service. |
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the report resource:
https://organization.example.com/<context>/admin/services/Maps/report?f=pjsonJSON Response syntax
{
"reports": [
{
"folderName": "<folder name>",
"serviceName": "<service name>",
"type": "<service type>",
"provider": "<service provider>
"description": "<description>",
"isDefault": <true|false>,
"isPrivate": <true|false>,
"hasManifest": <true|false>,
"portalProperties": <portal properties JSON information>,
"status": <status JSON information>,
"instances": <instances JSON information>,
"properties": <service properties JSON information>,
"extensions": <extensions JSON information>,
"iteminfo": <item info JSON information>,
"permissions": <permissions JSON information>
}
]
}JSON Response example
{
"reports": [
{
"folderName": "/",
"serviceName": "SampleWorldCities",
"type": "MapServer",
"provider": "ArcObjects",
"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.",
"isDefault": false,
"isPrivate": false,
"hasManifest": false,
"portalProperties": {
"isHosted": false,
"portalItems": [
{
"itemID":
"type": "MapServer"
},
{
"itemID":
"type": "WMSServer",
}
]
},
"status": {
"configuredState": "STARTED",
"realTimeState": "STARTED"
},
"instances": {
"folderName": "/",
"serviceName": "SampleWorldCities",
"type": "MapServer",
"max": 1,
"busy": 0,
"free": 1,
"initializing": 0,
"notCreated": 0,
"transactions": 1,
"totalBusyTime": 4343,
"isStatisticsAvailable": true
},
"properties": {
"outputDir": "C:\\arcgisserver\\directories\\arcgisoutput",
"virtualOutputDir": "/rest/directories/arcgisoutput",
"supportedImageReturnTypes": "MIME+URL",
"minScale": "295000000",
"isCached": "false",
"filePath": "${AGSSERVER}/framework/etc/data/WorldCities/WorldCities.msd",
"ignoreCache": "false",
"cacheOnDemand": "false",
"maxScale": "4000",
"clientCachingAllowed": "true",
"useLocalCacheDir": "true",
"cacheDir": "C:\\arcgisserver\\directories\\arcgiscache"
},
"extensions": [
{
"typeName": "WMServer",
"enabled": true
},
{
"typeName": "KmlServer",
"enabled": true
}
]
"iteminfo": {
"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.",
"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.",
"tags": [
"sample",
"map",
"service"
],
"thumbnail": "thumbnail.png"
},
"permissions": [{
"principal": "esriEveryone",
"permission": {"isAllowed": true},
"childURL": null,
"operation": null,
}]
}
]
}