require(["esri/rest/knowledgeGraph/ServiceDefinition"], (ServiceDefinition) => { /* code goes here */ });
import ServiceDefinition from "@arcgis/core/rest/knowledgeGraph/ServiceDefinition.js";
esri/rest/knowledgeGraph/ServiceDefinition
Outlines the service capabilities for a knowledgeGraphService.
{
"allowGeometryUpdates": false,
"capabilities": [
"Delete",
"Query",
"Create",
"Editing",
"Update"
],
"copyrightText": "2023 Esri, all rights reserved",
"currentVersion": 11.0,
"dataEditingNotSupported": false,
"dateFieldsTimeReference": {
"respectsDaylightSaving": false,
"timeZone": "UTC"
},
"description": "Supply chain data",
"maxRecordCount": 2000,
"schemaEditingNotSupported": false,
"searchMaxRecordCount": 2000,
"serviceCapabilities": {
"applyEditsCapabilities": {
"graphDefaultRollbackOnFailure": false
},
"geometryCapabilities": {
"geometryMaxBoundingRectangleSizeX": 180,
"geometryMaxBoundingRectangleSizeY": 180,
"supportedGeometryTypes": [
"Point",
"Mulitpoint",
"Polyline",
"Polygon"
],
"supportsMValues": false,
"supportsZValues": false
},
"indexCapabilities": {
"supportsDecendingIndex": false,
"supportsRelationshipIndex": true,
"supportsUniqueRelationshipConstraint": false
}
},
"searchCapabilities": {
"allowLeadingWildcardQueries": true,
"searchTypeFilterCapabilities": [
"esriTypeEntity",
"esriTypeRelationship",
"esriTypeBoth"
]
},
"serviceItemId": "87941a7420e84933882502ff2e9a5c34",
"spatialReference": {
"wkid": 4326
},
"supportedQueryFormats": [
"PBF"
],
"supportsDocuments": true,
"supportsSearch": true,
"units": "esriDecimalDegrees",
"url": "https://myHostName.domain.com/server/rest/services/Hosted/myServiceName/KnowledgeGraphServer"
}
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Boolean | Indicates if geometry data in the graph can be modified. more details | ServiceDefinition | |
String[] | Specifies the operational capabilities of the knowledge graph. more details | ServiceDefinition | |
String | Copyright information for the knowledge graph. more details | ServiceDefinition | |
Number | The version number of the ArcGIS Enterprise instance where the knowledge graph service is hosted. more details | ServiceDefinition | |
Boolean | Indicates if data editing is not supported. more details | ServiceDefinition | |
Object | Specifies the timezone for dateTime fields. more details | ServiceDefinition | |
String | The name of the class. more details | Accessor | |
String | The description of the service. more details | ServiceDefinition | |
Number | The maximum number of records returned by a query operation. more details | ServiceDefinition | |
Boolean | Indicates if the knowledge graph schema (data model) can be edited. more details | ServiceDefinition | |
Number | The maximum number of records returned by a search operation. more details | ServiceDefinition | |
Object | specifies the details of the index, edit, search and geometry capabilities of the service. more details | ServiceDefinition | |
String | The ArcGIS Enterprise Portal item id of the knowledge graph service. more details | ServiceDefinition | |
SpatialReference | Specifies the SpatialReference information for the knowledge graph service. more details | ServiceDefinition | |
String[] | The query formats supported by the service. more details | ServiceDefinition | |
Boolean | Indicates if the service supports entity types with a document role. more details | ServiceDefinition | |
Boolean | Indicates if the services supports search operations. more details | ServiceDefinition | |
String | The units for the spatial reference. more details | ServiceDefinition |
Property Details
-
allowGeometryUpdates Booleanreadonly
-
Indicates if geometry data in the graph can be modified. If
false
executeApplyEdits on geometry properties will fail.
-
Specifies the operational capabilities of the knowledge graph.
Example["Query", "Editing", "Delete", "Create", "Update"]
-
copyrightText Stringreadonly
-
Copyright information for the knowledge graph.
-
currentVersion Numberreadonly
-
The version number of the ArcGIS Enterprise instance where the knowledge graph service is hosted.
-
dataEditingNotSupported Booleanreadonly
-
Indicates if data editing is not supported. If
true
executeApplyEdits will fail.
-
dateFieldsTimeReference Objectreadonly
-
Specifies the timezone for dateTime fields.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description Stringreadonly
-
The description of the service.
-
schemaEditingNotSupported Booleanreadonly
-
Indicates if the knowledge graph schema (data model) can be edited. Schema editing is not currently supported in the JS API, if
false
any updates to the schema must be made through the ArcGIS REST API for Knowledge Graph.
-
serviceCapabilities Objectreadonly
-
specifies the details of the index, edit, search and geometry capabilities of the service.
- Properties
-
indexCapabilities Object
Information on the supported capabilities of indexes in the knowledge graph service.
- Specification
-
supportsDescendingIndex Boolean
Specifies if the service supports indexes in descending order.
supportsUniqueRelationshipConstraint BooleanSpecifies if the system supports creating unique constraints for relationship types
supportsRelationshipIndex BooleanSpecifies if the service supports indexes on relationships.
applyEditsCapabilities ObjectInformation on the supported capabilities of the the executeApplyEdits operation.
- Specification
-
graphDefaultRollbackOnFailure Boolean
If
true
, when an apply edits operation fails, the data will revert to it's state before the change.
searchCapabilities ObjectInformation on the supported capabilities of search operations in the knowledge graph service.
geometryCapabilities ObjectInformation on the supported capabilities of geometries in the knowledge graph service.
- Specification
-
geometryMaxBoundingRectangleSizeX Number
The maximum bounding rectangle size along the x-axis.
geometryMaxBoundingRectangleSizeY NumberThe maximum bounding rectangle size along the y-axis.
supportsMValues NumberSpecifies if the knowledge graph service supports m-values on geometry.
supportsZValues NumberSpecifies if the knowledge graph service supports z-values on geometry.
Specifies what geometry types are supported by the graph such as
Point
,Multipoint
,Polyline
,Polygon
.
Example"serviceCapabilities": { "applyEditsCapabilities": { "graphDefaultRollbackOnFailure": false }, "geometryCapabilities": { "geometryMaxBoundingRectangleSizeX": 180, "geometryMaxBoundingRectangleSizeY": 180, "supportedGeometryTypes": [ "Point", "Mulitpoint", "Polyline", "Polygon" ], "supportsMValues": false, "supportsZValues": false }, "indexCapabilities": { "supportsDecendingIndex": false, "supportsRelationshipIndex": true, "supportsUniqueRelationshipConstraint": false } }, "searchCapabilities": { "allowLeadingWildcardQueries": true, "searchTypeFilterCapabilities": [ "esriTypeEntity", "esriTypeRelationship", "esriTypeBoth" ] }
-
serviceItemId Stringreadonly
-
The ArcGIS Enterprise Portal item id of the knowledge graph service.
-
-
Specifies the SpatialReference information for the knowledge graph service.
- Default Value:null
-
The query formats supported by the service.
-
supportsDocuments Booleanreadonly
-
Indicates if the service supports entity types with a document role.
-
supportSearch Booleanreadonly
-
Indicates if the services supports search operations. If false, executeSearch will fail.
-
units Stringreadonly
-
The units for the spatial reference.
Exampleunits: "esriDecimalDegrees"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ServiceDefinition | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | ServiceDefinition |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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.
-
fromJSON(json){*}static
-
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.
-
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"); }
-
removeHandles(groupKey)inherited
-
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(){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.