FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.2   R E S T   R E P O S I T O R Y   U T I L I T Y

Add Features Endpoint

Adds features to a repository feature layer.

 

Availability: Business Analyst Server.

 

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/AddFeatures/execute

Parameters

Parameter

Description

SourceLayer (required)

Source data layer to get features from. The SourceLayer layer should be specified by the RecordSet or Item or Points property value. Type PointLayer.

DestinationItem (required)

Folder item containing a feature layer to be updated. Type esriFolderItem.

f (optional)

Response format. Type string. Available formats: HTML, JSON, PJSON, XML.

Default: HTML.

IsFullErrorMessage (optional)

Mode for composing error messages. Type boolean.

Default: false.

token

Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type boolean whose value is always true.

Remarks

This method allows user to add features to a feature layer having a point or polygon geometry. The SourceLayer and DestinationItem layers should have the same type of geometry and the same spatial reference.

 

While adding features to the destination layer, alien attributes of features are ignored. If the destination layer contains attributes that are missing in the source layer, its values for added features are initialized to default values.

 

When added to the destination layer, features of the source layer receive serial values for the Object ID attribute starting after the last feature Object ID in the destination layer. Because the Object ID attribute value is automatically assigned to new features of the destination layer, you do not need to specify the Object ID attribute for features of the source feature layer. If this attribute is specified, it is ignored.

Example Usage

The example below illustrates a workflow consisting of uploading a custom trade area layer to Business Analyst Server Repository with the Upload Feature Set endpoint, adding features with this endpoint, and retrieving the modified layer with the Open Feature Layer endpoint. The retrieved feature layer is shown here in the case of a shapefile-based repository.

 

NOTE: The name of the Object ID attribute of features depends on a feature class workspace type used. Typical names for Object ID are "FID", "OID", or "OBJECTID".

 

STEP 1: Upload Feature Set

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/UploadCustomTradeArea/execute?
FeatureSet={"Recordset":{
  "geometryType":"esriGeometryPolygon",
  "spatialReference":{"wkid":4269},
  "features":[
    {
      "geometry":{
        "rings":[[
          [-122.4346,37.8566476371076],[-122.360655858915,37.826739954428],
          [-122.347749703146,37.761714833162],[-122.406398364369,37.7151967133423],
          [-122.488250155425,37.7254855017619],[-122.525947479981,37.784114591287],
          [-122.488335196333,37.8427896412311],[-122.4346,37.8566476371076]
        ]],
        "spatialReference":{"wkid":4269}
      },
      "attributes":{"AREA_ID":"1_1","STORE_ID":"1","RING":1,"RING_DEFN":"5","AREA_DESC":"0 - 5 Miles"}
    },
    {
      "geometry":{
        "rings":[[
          [-122.4329,37.8057482650651],[-122.35900658434,37.775840365754],
          [-122.346109142864,37.7108146974946],[-122.404717633044,37.6642961225184],
          [-122.48651348554,37.6745850161913],[-122.524184911958,37.7332146557964],
          [-122.486598312884,37.791890171551],[-122.4329,37.8057482650651]
        ]],
        "spatialReference":{"wkid":4269}
      },
      "attributes":{"AREA_ID":"2_1","STORE_ID":"2","RING":1,"RING_DEFN":"5","AREA_DESC":"0 - 5 Miles"}
    }
  ]
}}&
OutputAnalysisItem={
  "workspaceName":"Default Workspace",
  "projectName":"Default Project",
  "folderType":"esriFolderTradeAreas",
  "itemName":"AddFeaturesSample"
}&
f=PJSON

 

STEP 2: Add Features

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/AddFeatures/execute?
SourceLayer={"Recordset":{
  "geometryType":"esriGeometryPolygon",
  "spatialReference":{"wkid":4269},
  "features":[
    {
      "geometry":{
        "rings":[[
          [-122.2346,38.0566476371076],[-122.160655858915,38.026739954428],
          [-122.147749703146,37.961714833162],[-122.206398364369,37.9151967133423],
          [-122.288250155425,37.9254855017619],[-122.325947479981,37.984114591287],
          [-122.288335196333,38.0427896412311],[-122.2346,38.0566476371076]
        ]],
        "spatialReference":{"wkid":4269}
      },
      "attributes":{"AREA_ID":"3_1","STORE_ID":"1","RING":1,"RING_DEFN":"6","AREA_DESC":"additional 1"}
    },
    {
      "geometry":{
        "rings":[[
          [-122.2329,38.0057482650651],[-122.15900658434,37.975840365754],
          [-122.146109142864,37.9108146974946],[-122.204717633044,37.8642961225184],
          [-122.28651348554,37.8745850161913],[-122.324184911958,37.9332146557964],
          [-122.286598312884,37.991890171551],[-122.2329,38.0057482650651]
        ]],
        "spatialReference":{"wkid":4269}
      },
      "attributes":{"AREA_ID":"4_1","STORE_ID":"2","RING":1,"RING_DEFN":"7","AREA_DESC":"additional 2"}
    }
  ]
}}&
DestinationItem={
  "workspaceName":"Default Workspace",
  "projectName":"Default Project",
  "folderType":"esriFolderTradeAreas",
  "itemName":"AddFeaturesSample"
}&
f=PJSON

 

STEP 3: Open Feature Layer

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/OpenFeatureLayer/execute?
Item={
  "workspaceName":"Default Workspace",
  "projectName":"Default Project",
  "folderType":"esriFolderTradeAreas",
  "itemName":"AddFeaturesSample"
}&
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"OutputFeatureClass",
      "dataType":"GPFeatureRecordSetLayer",
      "value":
      {
        "geometryType":"esriGeometryPolygon",
        "spatialReference":
        {
          "wkid":4326
        },
        "fieldAliases":
        {
          "OBJECTID":"Object ID",
          "AREA_DESC":"AREA_DESC",
          "AREA_ID":"AREA_ID",
          "RING":"RING",
          "RING_DEFN":"RING_DEFN",
          "STORE_ID":"STORE_ID",
          "Shape.area":"Shape.area",
          "Shape.len":"Shape.len"
        },
        "fields":
        [
          {
            "name":"OBJECTID",
            "type":"esriFieldTypeOID",
            "alias":"Object ID"
          },
          ...
          {
            "name":"Shape.len",
            "type":"esriFieldTypeDouble",
            "alias":"Shape.len"
          }
        ],
        "features":
        [
          {
            "geometry":
            {
              "rings":
              [
                [
                  [
                    -122.4346,
                    37.856648
                  ],
                  ...
                  [
                    -122.4346,
                    37.856648
                  ]
                ]
              ],
              "spatialReference":
              {
                "wkid":4326
              }
            },
            "attributes":
            {
              "OBJECTID":1,
              "AREA_DESC":"0 - 5 Miles",
              "AREA_ID":"1_1",
              "RING":1,
              "RING_DEFN":"5",
              "STORE_ID":"1",
              "Shape.area":0.0180196727515,
              "Shape.len":0.49830034470522
            }
          },
          ...
          {
            "geometry":
            {
              "rings":
              [
                [
                  [
                    -122.2329,
                    38.005748
                  ],
                  ...
                  [
                    -122.2329,
                    38.005748
                  ]
                ]
              ],
              "spatialReference":
              {
                "wkid":4326
              }
            },
            "attributes":
            {
              "OBJECTID":4,
              "AREA_DESC":"additional 2",
              "AREA_ID":"4_1",
              "RING":1,
              "RING_DEFN":"7",
              "STORE_ID":"2",
              "Shape.area":0.0180074758195,
              "Shape.len":0.498103034899043
            }
          }
        ]
      }
    }
  ],
  "messages":
  [
  ]
}

 

NOTE: The response has been abbreviated where "..." is noted.

 

See Also

Delete Features Endpoint

Edit Features Endpoint

Open Feature Layer Endpoint

Upload Feature Set Endpoint

Business Analyst Server Repository

Business Analyst Server REST Reference