ServiceDefinition

AMD: require(["esri/rest/knowledgeGraph/ServiceDefinition"], (ServiceDefinition) => { /* code goes here */ });
ESM: import ServiceDefinition from "@arcgis/core/rest/knowledgeGraph/ServiceDefinition.js";
Object: esri/rest/knowledgeGraph/ServiceDefinition
Since: ArcGIS Maps SDK for JavaScript 4.26
beta

Outlines the service capabilities for a knowledgeGraphService.

Example
{
	"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 Object
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 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.

capabilities String[]readonly

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.

Properties
respectsDaylightSaving Boolean

Indicates if datetime fields respects daylight savings.

timeZone String

the timezone for all datetime fields.

description Stringreadonly

The description of the service.

maxRecordCount Numberreadonly

The maximum number of records returned by a query operation.

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.

searchMaxRecordCount Numberreadonly

The maximum number of records returned by a search operation.

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 Boolean

Specifies if the system supports creating unique constraints for relationship types

supportsRelationshipIndex Boolean

Specifies if the service supports indexes on relationships.

applyEditsCapabilities Object

Information 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 Object

Information on the supported capabilities of search operations in the knowledge graph service.

Specification
searchTypeFilterCapabilities String

The search category filters supported by this service.

Possible Values:"esriTypeEntity"|"esriTypeRelationship"|"esriTypeBoth"

allowLeadingWildcardQueries Boolean

Specifies if search strings can contain a leading wildcard operator (*).

geometryCapabilities Object

Information on the supported capabilities of geometries in the knowledge graph service.

Specification
geometryMaxBoundingRectangleSizeX Number

The maximum bounding rectangle size along the x-axis.

geometryMaxBoundingRectangleSizeY Number

The maximum bounding rectangle size along the y-axis.

supportsMValues Number

Specifies if the knowledge graph service supports m-values on geometry.

supportsZValues Number

Specifies if the knowledge graph service supports z-values on geometry.

supportedGeometryTypes String[]

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.

spatialReference SpatialReferenceautocastreadonly

Specifies the SpatialReference information for the knowledge graph service.

Default Value:null
supportedQueryFormats String[]readonly

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.

Example
units: "esriDecimalDegrees"

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.