B U S I N E S S A N A L Y S T 10.5 R E S T R E P O S I T O R Y U T I L I T Y
Delete Features Endpoint
Deletes features in a repository feature layer.
Availability: Business Analyst Server.
URL Example
http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/DeleteFeatures/execute
Parameters
Parameter |
Description |
|---|---|
ChangedItem (required) |
Folder item containing a feature layer to be modified. Type esriFolderItem. |
OIDs (required) |
|
f (optional) |
Response format. Type string. Available formats: HTML, JSON, 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 true value means that at least one feature was deleted.
Remarks
This endpoint deletes features whose Object ID value is listed in the input OIDs array. Typically, values of Object ID are enumerated in a repository feature layer from zero (for shapefile workspace type) or one (in other cases). When features are removed from a repository feature layer, Object IDs of remaining features can be changed. For example, in the case of shapefile workspace, Object IDs of remaining features are renumbered.
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, deleting a feature 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". You can recognize the Object ID field by its type "esriFieldTypeOID" returned within the "fields" array when the feature layer is retrieved with Open Feature Layer task.
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.4329,
37.805748
],
...
[
-122.4329,
37.805748
]
]
],
"spatialReference":
{
"wkid":4326
}
},
"attributes":
{
"OBJECTID":2,
"AREA_DESC":"0 - 5 Miles",
"AREA_ID":"2_1",
"RING":1,
"RING_DEFN":"5",
"STORE_ID":"2",
"Shape.area":0.0180074758195,
"Shape.len":0.498103034899043
}
}
]
}
}
],
"messages":
[
]
}
NOTE: The response has been abbreviated where "..." is noted.
See Also