inputLayer

(Required)

The multipoint, line, or polygon features that will be used to generate centroid point features.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features
• A feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

pointLocation

A Boolean value that determines the output location of the points.

Values: true | false

• true—Output points will be the nearest point to the actual centroid, but located inside or contained by the bounds of the input feature.
• false—Output point locations will be determined by the calculated geometric center of each input feature. This is the default.

Example:"pointLocation" : "false"

outputName

If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection.

{
  "serviceProperties": {
    "name": "<service name>"
  }
}

{

  "itemProperties": {
			"itemId": "<itemID of the existing feature service>",
			"overwrite": True
	}
}

{
"serviceProperties": {
    "name": "<existing service name>"
  },
"itemProperties": {
				"itemId": "<itemID of the existing feature service>",
				"overwrite": True
	}
}

context

The Context parameter contains the following additional settings that affect task operation:

• Extent (extent)—A bounding box that defines the analysis area. Only input features that intersect the bounding box will be analyzed.
• Output spatial reference (outSR)—The output features will be projected into the output spatial reference.

{
"extent" : {extent},
"outSR" : {spatial reference}
}

f

The response format. The default response format is html.

Values: html | json

outputLayer

The centroid points.

{"url": 
"http://<analysis url>/FindCentroids/jobs/<jobId>/results/outputLayer"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request.

• If outputName was provided, value contains the URL to the feature service layer.
  {
  "paramName":"outputLayer", 
  "dataType":"GPString",
  "value":{"url":"<hosted featureservice layer url>"}
  }

• If outputName was not provided, value contains a feature collection.
  {
  "paramName":"outputLayer",
  "dataType":"GPString",
  "value":{"layerDefinition": {}, "featureSet": {}  }
  }

See Feature Output for more information about how the result layer or collection is accessed.