ServiceDefinition | References | ArcGIS Maps SDK for JavaScript

import ServiceDefinition from "@arcgis/core/rest/knowledgeGraph/ServiceDefinition.js";

Inheritance:: ServiceDefinition→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.26

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"
}

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ServiceDefinitionProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`allowGeometryUpdates` readonly	`boolean`
`capabilities` readonly	`string[]`
`copyrightText` readonly	`string`
`currentVersion` readonly	`number \| null \| undefined`
`dataEditingNotSupported` readonly	`boolean`
`dateFieldsTimeReference` readonly	`ServiceDefinitionDateFieldsTimeReference \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`description` readonly	`string`
`maxRecordCount` readonly	`number \| null \| undefined`
`schemaEditingNotSupported` readonly	`boolean`
`searchMaxRecordCount` readonly	`number \| null \| undefined`
`serviceCapabilities` readonly	`ServiceDefinitionServiceCapabilities`
`serviceItemId` readonly	`string`
`spatialReference` readonly	`SpatialReference \| null \| undefined`
`supportedQueryFormats` readonly	`string[]`
`supportsDocuments` readonly	`boolean`
`supportsProvenance` readonly	`boolean`
`supportsSearch` readonly	`boolean`
`units` readonly	`string`

allowGeometryUpdates

readonly Property

Type: boolean

Indicates if geometry data in the graph can be modified. If false executeApplyEdits() on geometry properties will fail.

Default value: false

capabilities

readonly Property

Type: string[]

Specifies the operational capabilities of the knowledge graph.

Example

["Query", "Editing", "Delete", "Create", "Update"]

copyrightText

readonly Property

Type: string

Default value: ""

currentVersion

readonly Property

Type: number | null | undefined

The version number of the ArcGIS Enterprise instance where the knowledge graph service is hosted.

dataEditingNotSupported

readonly Property

Type: boolean

Indicates if data editing is not supported. If true executeApplyEdits() will fail.

Default value: false

dateFieldsTimeReference

readonly Property

Type: ServiceDefinitionDateFieldsTimeReference | null | undefined

Specifies the timezone for dateTime fields.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

description

readonly Property

Type: string

The description of the service.

Default value: ""

maxRecordCount

readonly Property

Type: number | null | undefined

The maximum number of records returned by a query operation.

schemaEditingNotSupported

readonly Property

Type: boolean

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.

Default value: false

searchMaxRecordCount

readonly Property

Type: number | null | undefined

The maximum number of records returned by a search operation.

serviceCapabilities

readonly Property

Type: ServiceDefinitionServiceCapabilities

specifies the details of the index, edit, search and geometry capabilities of the service.

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

readonly Property

Type: string

The ArcGIS Enterprise Portal item id of the knowledge graph service.

Default value: ""

spatialReference

readonly Property

Type: SpatialReference | null | undefined

Specifies the SpatialReference information for the knowledge graph service.

supportedQueryFormats

readonly Property

Type: string[]

The query formats supported by the service.

supportsDocuments

readonly Property

Type: boolean

Indicates if the service supports entity types with a document GraphProperty.role.

Default value: false

supportsProvenance

readonly Property

Type: boolean

Indicates if the service supports provenance. If false provenance cannot be used or returned in GraphQueryStreaming.provenanceBehavior.

See also

Default value: false

supportsSearch

readonly Property

Type: boolean

Indicates if the services supports search operations. If false, executeSearch() will fail.

Default value: false

units

readonly Property

Type: string

The units for the spatial reference.

Default value: ""

Example

units: "esriDecimalDegrees"

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	A 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.