- URL:
- https://<root>/services/Utilities
- 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 Utilities folder contains automatically deployed services that can be used by application developers. The table below outlines the services included in the Utilities folder.
| Service | Details |
|---|---|
| The |
| The |
| The |
| The |
| The |
| The |
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the Utilities folder resource:
https://organization.example.com/<context>/admin/services/Utilities?f=pjsonJSON Response example
{
"folderName": "Utilities",
"description": "The Utilities folder contains automatically deployed services that can be used by application developers.",
"webEncrypted": false,
"isDefault": true,
"services": [
{
"folderName": "Utilities",
"serviceName": "GeocodingTools",
"type": "GPServer",
"description": "The GeocodingTools service is used for supporting asynchronous batch geocoding capability in Portal for ArcGIS."
},
{
"folderName": "Utilities",
"serviceName": "Geometry",
"type": "GeometryServer",
"description": "The Geometry service is used by application developers to perform geometric calculations to support querying, analysis, and editing operations from client applications."
},
{
"folderName": "Utilities",
"serviceName": "OfflinePackaging",
"type": "GPServer",
"description": "The OfflinePackaging service is used to create and set up map areas. Map areas make it faster for your users to work offline by packaging up your map for a specific area ahead of time."
},
{
"folderName": "Utilities",
"serviceName": "PrintingTools",
"type": "GPServer",
"description": "The PrintingTools service is used by web application developers to export the contents of a web map to pdf, jpeg, png, or other format. This service is generally used in the context of providing applications with printing functionality."
},
{
"folderName": "Utilities",
"serviceName": "RasterUtilities",
"type": "GPServer",
"description": "The RasterUtilities service contains tools that enable raster analysis and processing."
},
{
"folderName": "Utilities",
"serviceName": "Symbols",
"type": "SymbolServer",
"description": "The Symbol service is used by application developers to perform symbol related functions."
}
]
}