Manifest - Service"

URL:: https://<root>/services/<serviceName>.<serviceType>/iteminfo/manifest/manifest.json
Methods:: GET
Version Introduced:: 10.1.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.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

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 generateToken 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.

Learn how to generate a token

Description

The service manifest resource documents the data and other resources that define the service origins and power the service. This resource will tell you underlying databases and their location along with other supplementary files that make up the service.

Request parameters

Parameter	Description
`f`	The response format. The only supported format is `json`.

Response properties

Properties Description

Properties	Description
`databases`	The `database` property contains the following information: `byReference`—Indicates whether the service data is referenced from a registered folder or database (`true`) or if it was copied to the server at the time the service was published (`false`). `onPremiseConnectionString`—Path to publisher data location. `onServerConnectionString`—Path to data location after publishing completes. When both the server machine and the publisher machine are using the same folder or database, `byReference` is `true` and the `onPremiseConnectionString` and `onServerConnectionString` properties have the same value. When the server machine and the publisher machine are using different folders or databases, `byReference` is `true` and the `onPremiseConnectionString` and `onServerConnectionString` properties have different values. When the data is copied to the server automatically at publish time, `byReference` is `false`.
`resources`	The `resources` property contains the following information: `clientName`—Machine where ArcGIS Pro was used to publish the service. `onPremisePath`—Path, relative to the `clientName` machine, where the source resource (.mxd, .3dd, .tbx files, geodatabases, and so on) originated. `serverPath`—Path to the document after publishing completes. Note `OnPremisePath` is not valid for geoprocessing services because the geoprocessing publishing framework creates an in-memory toolbox in the user's profile and that path is what is saved. You cannot use this path to return to a meaningful .tbx file. At the same time, you are able to publish geoprocessing services from the aggregation of multiple results, and the multiple sources for the service are not saved.

databases

The database property contains the following information:

byReference—Indicates whether the service data is referenced from a registered folder or database (true) or if it was copied to the server at the time the service was published (false).
onPremiseConnectionString—Path to publisher data location.
onServerConnectionString—Path to data location after publishing completes.

When both the server machine and the publisher machine are using the same folder or database, byReference is true and the onPremiseConnectionString and onServerConnectionString properties have the same value.

When the server machine and the publisher machine are using different folders or databases, byReference is true and the onPremiseConnectionString and onServerConnectionString properties have different values.

When the data is copied to the server automatically at publish time, byReference is false.

resources

The resources property contains the following information:

clientName—Machine where ArcGIS Pro was used to publish the service.
onPremisePath—Path, relative to the clientName machine, where the source resource (.mxd, .3dd, .tbx files, geodatabases, and so on) originated.
serverPath—Path to the document after publishing completes.

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/Maps/California.MapServer/iteminfo/manifest/manifest.json

JSON Response example

Use dark colors for code blocksCopy
{
  "databases": [
    {
      "byReference": true,
      "onServerWorkspaceFactoryProgID": "esriDataSourcesGDB.FileGDBWorkspaceFactory.1",
      "onServerConnectionString": "DATABASE=\\\\server\\sharedb\\California.gdb",
      "onPremiseConnectionString": "DATABASE=C:\\data\\California\\California.gdb",
      "onServerName": "California.gdb",
      "onPremisePath": "",
      "datasets": [
        {
          "onServerName": "Airports"
        },
        {
          "onServerName": "Cities"
        },
        {
          "onServerName": "EarthquakeHistory"
        },
        {
          "onServerName": "GolfCourses"
        },
        {
          "onServerName": "Places"
        },
        {
          "onServerName": "Volcanos"
        },
        {
          "onServerName": "Highways"
        },
        {
          "onServerName": "Rivers"
        },
        {
          "onServerName": "Counties"
        },
        {
          "onServerName": "Lakes"
        },
        {
          "onServerName": "StateBND"
        },
        {
          "onServerName": "UrbanAreas"
        }
      ]
    }
  ],
  "resources": [
    {
      "onPremisePath": "C:\\data\\California\\California.mxd",
      "clientName": "client",
      "serverPath": "C:\\arcgisserver\\directories\\arcgissystem\\arcgisinput\\California1.MapServer\\extracted\\v101\\California.msd"
    }
  ]
}