Skip To Content
ArcGIS Developers
Dashboard

Calculate Field

Description

Calculate Field

The CalculateField operation works with a layer to create and populate a new field or edit an existing field. The output is a new feature service that is the same as the input features, with the newly calculated values.

Request parameters

ParameterDetails
inputLayer

(Required)

The input features that will have a field added and calculated.

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

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

REST Examples

//REST web example
{"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September;"}

//REST scripting example
"inputLayer": {"url": "https://myportal.domain.com/server/rest/services/Hosted/HurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}
fieldName

(Required)

A string representing the name of the new field. If the name already exists in the dataset, a numeric value will be appended to the field name.

REST Example

//REST web example
MyNewField

//REST scripting example
"fieldName": "AccumulatedValues"
dataType

(Required)

The type for the new field.

Values: Date | Double | Integer | String

REST Examples

//REST web example
Double

//REST scripting example
"dataType": "Integer"
expression

(Required)

An Arcade expression used to calculate the new field values. You can use any of the Date, Logical, Mathematical, or Text functions available with Arcade expressions.

REST Examples

//REST web example
$feature["Field1"] + abs($feature["Field2"])

//REST scripting example
"expression": "$feature[\"Field1\"] + abs($feature[\"Field2\"])"
trackAware

A Boolean value denoting if the expression is track-aware.

Values: true | false

REST Examples

//REST web example
true

//REST scripting example
trackAware: "false"
trackFields

(Required if trackAware is true)

The fields used to identify distinct tracks. There can be multiple trackFields. trackFields are only required when trackAware is true.

REST Examples

//REST web example
AircraftID

//REST scripting example
trackAware: "AirID,DepartureCity"
timeBoundarySplit

(Optional)

A time boundary allows your to analyze values within a defined time span. For example, if you use a time boundary of 1 day, starting on January 1, 1980 tracks will be analyzed one day at a time.

The time boundary parameters are only applicable if the analysis is trackAware.

REST Examples

//REST web example
2

//REST scripting example
"timeBoundarySplit": 1
timeBoundarySplitUnit

(Optional)

The unit applied to the time boundary. timeBoundarySplitUnit is required if a timeBoundarySplit is provided.

REST Examples

//REST web example
Weeks

//REST scripting example
"timeBoundarySplitUnit": "Days"
timeBoundaryReference

(Optional)

A date that specifies the reference time to align the time boundary to, represented in milliseconds from epoch. The default is January 1, 1970, at 12:00 a.m. (epoch time stamp 0). This option is only available if the timeBoundarySplit and timeBoundarySplitUnit are set.

REST Examples

//REST web example
9466835800000

//REST scripting example
"timeBoundaryReference": 946684800000
outputName

(Optional)

The task will create a feature service of the results. You define the name of the service.

REST Examples

//REST web example
myOutput

//REST scripting example
"outputName": "myOutput"
context

The context parameter contains additional settings that affect task execution. For this task, there are four settings:

  • Extent (extent)—A bounding box that defines the analysis area. Only those features that intersect the bounding box will be analyzed.
  • Processing spatial reference (processSR)—The features will be projected into this coordinate system for analysis.
  • Output spatial reference (outSR)—The features will be projected into this coordinate system after the analysis to be saved. The output spatial reference for the spatiotemporal big data store is always WGS84.
  • Data store (dataStore)—Results will be saved to the specified data store. The default is the spatiotemporal big data store.

Syntax:
{
"extent" : {extent},
"processSR" : {spatial reference},
"outSR" : {spatial reference},
"dataStore":{data store}
}

f

The response format. The default response format is html.

Values: html | json

Example usage

Below is a sample request URL for CalculateField:

https://webadaptor.domain.com/server/rest/services/System/GeoAnalyticsTools/GPServer/CalculateField/submitJob?inputLayer={"url":"https://webadaptor.domain.com/server/rest/services/Hurricane/hurricaneTrack/0"}&fieldName=MyNewField&dataType=Integer&expression=$feature["Field1"] + abs($feature["Field2"])&trackAware=false&trackFields&timeBoundarySplit=2&timeBoundarySplitUnit=Hours&timeBoundaryReference=946684800000&outputName=myOutput&context={"extent":{"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,"spatialReference":{"wkid":4326}}}&f=json

Response

When you submit a request, the service assigns a unique job ID for the transaction.

Syntax:
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

https://<analysis url>/CalculateField/jobs/<jobId>

Access results

When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:

https://<analysis-url>/CalculateField/jobs/<jobId>/results/output?token=<your token>&f=json

ResponseDescription

output

output will always contain a feature service.

{"url": "https://<analysis-url>/CalculateField/jobs/<jobId>/results/output"}

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

{
  "paramName":"output", 
  "dataType":"GPRecordSet",
  "value":{"url":"<hosted feature service layer url>"}
}