Start Service

URL:
https://<root>/services/<serviceName.serviceType>/start
Methods:
POST
Version Introduced:
10.9

Description

This operation starts a service and loads the service's configuration.

Request parameters

ParameterDetails

async

(Optional)

Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If false , the operation is run synchronously. If true , the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false .

Values: true | false

f

The response format. The default response is html .

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/services/SampleService.MapServer/start HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

async=false&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response examples

If async is false , the following response is returned once a service is started successfully:

Use dark colors for code blocksCopy
1
{"status": "success"}

If async is true , the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource topic.

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}

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