Start Services

URL:
https://<root>/services/startServices
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.3

Description

The startServices operation starts the specified services on all reachable server machines that are part of the site. If the minimum instances are 0, the instances are created dynamically based on the incoming requests. This operation requires three properties: the folder name the service is located in (if applicable), the service's name, and the service type. If the service resides in the root folder, leave the folder property blank ("folderName": "" ).

Request Parameters

ParameterDetails

services

The folder name, service name, and type of the service being started in JSON format. See the service properties table below.

f

The response format. The default response format is html.

Values: html | json | pjson

Service properties

PropertyDetails

folderName

The name of the folder containing the service. If the service resides in the root folder, leave the folder property blank ("folderName": "" ).

Example
Use dark colors for code blocksCopy
1
2
3
4
5
//Root folder
"folderName": ""

//Specific folder
"folderName": "Planning"

serviceName

The name of the service.

Example
Use dark colors for code blocksCopy
1
"serviceName": "FireHydrants"

type

The service type.

Example
Use dark colors for code blocksCopy
1
"type": "FeatureServer"

Example usage

The following is a sample POST request for the startServices operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST /webadaptor/admin/services/startServices HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

{services=[{
  "folderName": "",
  "serviceName": "SampleWorldCities",
  "type": "MapServer"
},
{
  "folderName": "Planning",
  "serviceName": "FireHydrants",
  "type": "FeatureServer"
}]}&f=json

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "services": [
    {
      "folderName": "",
      "serviceName": "SampleWorldCities",
      "type": "MapServer"
    },
    {
      "folderName": "Planning",
      "serviceName": "FireHydrants",
      "type": "FeatureServer"
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.