require(["esri/rest/networks/support/ValidateNetworkTopologyParameters"], (ValidateNetworkTopologyParameters) => { /* code goes here */ });
import ValidateNetworkTopologyParameters from "@arcgis/core/rest/networks/support/ValidateNetworkTopologyParameters.js";
esri/rest/networks/support/ValidateNetworkTopologyParameters
ValidateNetworkTopologyParameters describes the optional and required parameters for validating a network topology. Optional parameters include gdbVersion, sessionID, validationType, and validationSet. The only required property is validateArea.
- See also
const validationResult = await network.submitTopologyValidationJob(
new ValidateNetworkTopologyParameters({
validateArea: extent,
gdbVersion: "sde.DEFAULT",
validationType: "rebuild",
sessionID: "{7865BAA6-ED9C-4346-9F72-894A49E10C73}",
validationSet: [
{
sourceId: 4134325151,
globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"]
}
]
})
);
console.log("result: ", validationResult);
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
Specifies the geodatabase version name. | ValidateNetworkTopologyParameters | ||
SpatialReference | The spatial reference of the returned geometry. | ValidateNetworkTopologyParameters | |
Specifies the GUID used to lock the version. | ValidateNetworkTopologyParameters | ||
Specifies the envelope of the area to validate. | ValidateNetworkTopologyParameters | ||
Specifies the set of features and objects to validate. | ValidateNetworkTopologyParameters | ||
Specifies the validation to perform. | ValidateNetworkTopologyParameters |
Property Details
-
gdbVersion
gdbVersion String
-
Specifies the geodatabase version name. Defaults to
SDE.DEFAULT
when no version is provided.
-
The spatial reference of the returned geometry. If not specified, the geometry is returned in the spatial reference of the feature service.
-
sessionID
sessionID String
-
Specifies the GUID used to lock the version. If the client is editing
SDE.DEFAULT
, thesessionID
should not be used because this version cannot be locked.
-
validateArea
validateArea Extent
-
Specifies the envelope of the area to validate. This property is required.
-
validationSet
validationSet ValidationSetItemJSON[]
-
Specifies the set of features and objects to validate.
Note
This parameter is available at ArcGIS Enterprise 10.9.
-
validationType
validationType String
-
Specifies the validation to perform.
Possible Values:"normal" |"rebuild" |"force-rebuild"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ValidateNetworkTopologyParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | ValidateNetworkTopologyParameters |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
Type Definitions
-
ValidationSetItemJSON
ValidationSetItemJSON Object
-
ValidationSetItemJSON represents the set of features and objects to validate.
Exampleconst validationResult = await network.submitTopologyValidationJob( new ValidateNetworkTopologyParameters({ validateArea: extent, gdbVersion: "sde.DEFAULT", validationType: "rebuild", sessionID: "{7865BAA6-ED9C-4346-9F72-894A49E10C73}", validationSet: [ { sourceId: 4134325151, globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"] } ] }) ); console.log("result: ", validationResult);