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 iteminfo resource stores metadata about a service. Typically, this information is available to clients that want to index or harvest information about the service. Item information is represented in JSON format defined by the schema described below. It can optionally contain thumbnail images associated with the service. The thumbnail images can be accessed with a URL by appending the path of the image to this item information URL.
If the thumbnail is stored under thumbnail/image.jpg, the URL to access this image will be as follows:
https://organization.example.com/<context>/admin/services/<folder>/<service>/iteminfo/thumbnail/image.jpgRequest parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Property name differences
Some of the properties in the item information are visible in ArcGIS Server Manager when you view the service's properties and click the Item Description page. These properties are listed in the following table:
| Property in ArcGIS Server Manager | Property in JSON format |
|---|---|
| "summary" |
| "tags" |
| "description" |
| "licenseInfo" |
| "accessInformation" |
Example usage
The following is a sample request URL used to access the item resource:
https://organization.example.com/<context>/admin/services/Maps/Test.MapServer/itemInfo?f=pjsonJSON Response syntax
{
"culture": "<culture>",
"name": "<namegt>",
"thumbnail": "<thumbnail folder>",
"guid": "<guid>",
"catalogpath": "<path>",
"snippet": "<snippet>",
"description": "<description>",
"summary": "<summary>",
"title": "<title>",
"tags": "<tags>",
"type": "<type>",
"text": "<text>",
"typekeywords": [
"<keyword1>",
"<keyword2>"
],
"documentation": "<documentation>",
"url": "<url>",
"datalastmodifiedtime": "<time>",
"extent": <extent>,
"spatialreference": "<spatial reference>",
"accessinformation": "<access information>",
"licenseinfo": "<license information>"
}JSON Response example
{
"Culture": "en-US",
"name": "usa",
"thumbnail": "thumbnail/image.jpg",
"guid": "FD09F5FF-4031-49D4-8BD3-B310728C8FF7",
"catalogpath": "",
"snippet": "",
"description": "",
"summary": "",
"title": "usa.mxd",
"tags": "",
"type": "Service Definition",
"Text": "",
"typekeywords": [
"Shapefile Feature Class",
"ArcGIS",
"Service Definition",
".sd"
],
"documentation": "",
"url": "",
"datalastmodifiedtime": "",
"extent": {
"xmin": -178.217598362366,
"ymin": 18.9247817993163,
"xmax": -66.9692710360024,
"ymax": 71.4071353542713
},
"spatialreference": "Unknown",
"accessinformation": "",
"licenseinfo": ""
}