GetServiceDatastoreInfo

URL:: https://<root>/System/PublishingTools/GPServer/GetServiceDatastoreInfo/submitJob
Methods:: GETPOST
Version Introduced:: 11.4

Description

The GetServiceDatastoreInfo operation lists the data stores a service uses, and how specifically the service uses the data stores. This operation only supports checking the data stores of a map service. The GetServiceDatastoreInfo operation should be performed as the first step in moving a map service from one organization to another. For more information on this workflow, and supported service types, see the Export Service documentation.

Request parameters

Parameter Details

Parameter	Details
`serviceName` (Required)	The service's name. Use dark colors for code blocksCopy `1 serviceName=MapServiceByreference_Egdb`
`serviceType` (Required)	The service type. The only supported value is `MapServer`.
`serviceFolder` (Optional)	The name of the folder the service is located in. Use dark colors for code blocksCopy `1 serviceFolder=TestFolder`
`options` (Optional)	A set of additional options for the request. At this time, no options are available or supported.
`returnZ` (Optional)	A Boolean that determines if z-values are included as part of the result. If `true`, z-values will be included in the results if the features have z-values. Otherwise, z-values will not be returned. The default is `false`. Values: `true` \| `false`
`returnTrueCurves` (Optional)	A Boolean that specifies whether true curves will be returned in the output geometries (`true`). When `false`, curves will be converted to densified polylines or polygons. The default value is `false`. Values: `true` \| `false`
`simplifyFeatures` (Optional)	A Boolean that specifies whether geometries should be simplified (`true`). Simplifying can siginificantly reduce the size of the response while fulfiling the accuracy needs for most analysis, espeically for complex and large geometries. The default value is `false`. Values: `true` \| `false`
`context` (Optional)	Additional settings that affect the result of the operation: `outSR` is the spatial reference of the output geometries. `processSR` is the spatial reference that the model will use to perform geometry operations. `extent` will only process features that overlap the specified extent. The output features will have an extent that is the same or larger than the `extent` value.
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

serviceName

(Required)

The service's name.

Use dark colors for code blocksCopy
serviceName=MapServiceByreference_Egdb

serviceType

(Required)

The service type. The only supported value is MapServer.

serviceFolder

(Optional)

The name of the folder the service is located in.

Use dark colors for code blocksCopy
serviceFolder=TestFolder

options

(Optional)

A set of additional options for the request. At this time, no options are available or supported.

returnZ

(Optional)

A Boolean that determines if z-values are included as part of the result. If true, z-values will be included in the results if the features have z-values. Otherwise, z-values will not be returned. The default is false.

Values: true | false

returnTrueCurves

(Optional)

A Boolean that specifies whether true curves will be returned in the output geometries (true). When false, curves will be converted to densified polylines or polygons. The default value is false.

Values: true | false

simplifyFeatures

(Optional)

A Boolean that specifies whether geometries should be simplified (true). Simplifying can siginificantly reduce the size of the response while fulfiling the accuracy needs for most analysis, espeically for complex and large geometries. The default value is false.

Values: true | false

context

(Optional)

Additional settings that affect the result of the operation:

outSR is the spatial reference of the output geometries.
processSR is the spatial reference that the model will use to perform geometry operations.
extent will only process features that overlap the specified extent. The output features will have an extent that is the same or larger than the extent value.

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following are sample requests (GET and POST) for the GetServiceDatastoreInfo operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/PublishingTools/GPServer/GetServiceDatastoreInfo/submitJob?serviceName=MapServiceByreference_Egdb&serviceType=MapServer&serviceFolder=&options=&returnZ=false&returnM=false&returnTrueCurves=false&simplifyFeatures=true&context=&f=pjson

Use dark colors for code blocksCopy
POST /<context>/rest/services/System/PublishingTools/GPServer/GetServiceDatastoreInfo/submitJob HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

serviceName=MapServiceByreference_Egdb&serviceType=MapServer&serviceFolder=&options=&returnZ=false&returnM=false&returnTrueCurves=false&simplifyFeatures=true&context=&f=pjson

JSON Response example

The tabbed sections below outline the workflow to obtain data store information for a service.

When the GetServiceDatastoreInfo job request is submitted, the following JSON response is returned:

Use dark colors for code blocksCopy
{
  "jobId": "j5f3aa768e0a24dcfbdff45f379870553",
  "jobStatus": "esriJobSubmitted"
}

The value for jobId can be appended to a modified version of the request URL (shown below) to access the job resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/PublishingTools/GPServer/GetServiceDatastoreInfo/jobs/j5f3aa768e0a24dcfbdff45f379870553?f=pjson

The job resource can be polled to check the status of the GetServiceDatastoreInfo job. When the job is completed successfully, the following JSON response is returned:

Use dark colors for code blocksCopy
{
  "jobId": "j5f3aa768e0a24dcfbdff45f379870553",
  "jobStatus": "esriJobSucceeded",
  "results": {
    "exportedData": {
      "paramUrl": "results/datastoreInfo"
    }
  },
  "inputs": {
    "serviceName": {
      "paramUrl": "inputs/serviceName"
    },
    "serviceType": {
      "paramUrl": "inputs/serviceType"
    }
  },
  "messages": [
    {
      "type": "esriJobMessageTypeInformative",
      "description": "Start Time: Friday, September 20, 2024 5:24:24 PM"
    },
    {
      "type": "esriJobMessageTypeInformative",
      "description": "Succeeded at Friday, September 20, 2024 5:24:27 PM (Elapsed Time: 2.84 seconds)"
    }
  ]
}

The value for the datastoreInfo property's paramUrl can be appended to the job resource URL to access the datastoreInfo resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/PublishingTools/GPServer/GetServiceDatastoreInfo/jobs/j0754c83d71884311a53b9d3018d40500/results/datastoreInfo

The datastoreInfo resource returns the following JSON response:

Use dark colors for code blocksCopy
{
  "paramName": "datastoreInfo",
  "dataType": "GPString",
  "value": {
    "serviceName": "MapServiceByreference_Egdb",
    "serviceType": "MapServer",
    "serviceFolder": "",
    "datastores": [
      {
        "id": "9cd5cdbbb62342b38a881186c29ff744",
        "path": "/enterpriseDatabases/EGDB_shared_db",
        "type": "egdb"
      }
    ],
    "datasets": [
      {
        "id": "7",
        "datasetName": "USER1.States",
        "datasetType": "esriDTFeatureClass",
        "datastoreID": "9cd5cdbbb62342b38a881186c29ff744"
      },
      {
        "id": "33",
        "datasetName": "USER1.Signposts_Streets",
        "datasetType": "esriDTTable",
        "datastoreID": "9cd5cdbbb62342b38a881186c29ff744"
      }
    ],
    "layers": [
      {
        "id": 2,
        "datasetID": "7",
        "name": "States",
        "type": "Feature Layer",
        "byRef": true
      },
      {
        "id": 5,
        "datasetID":"33",
        "name": "Streets_table",
        "type": "esriDTTable",
        "byRef": true
      }
    ]
  }
}