DataModel

AMD: require(["esri/rest/knowledgeGraph/DataModel"], (DataModel) => { /* code goes here */ });
ESM: import DataModel from "@arcgis/core/rest/knowledgeGraph/DataModel";
Class: esri/rest/knowledgeGraph/DataModel
Inheritance: DataModel Accessor
Since: ArcGIS API for JavaScript 4.25
beta

The data model defines the entity types and relationship types in a knowledge graph service as well as some additional settings. The DataModel resource allows users to query the properties of both entity and relationship types. By defining these types and their properties, the data model defines the schema of the graph.

Sample of a knowledge graph data model.

{
 "dataModel": {
   "declaredClass": "esri.rest.knowledgeGraph.DataModel",
   "timestamp": {},
   "spatialReference": {
     "latestWkid": 0,
     "wkid": 4326,
     "vcsWkid": 0,
     "latestVcsWkid": 0
   },
   "strict": false,
   "entityTypes": [
     {
       "declaredClass": "esri.rest.knowledgeGraph.EntityType",
       "name": "company",
       "alias": "Company",
       "role": "Regular",
       "strict": false,
       "properties": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "Name",
           "alias": "Name",
           "fieldType": "esriFieldTypeString",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": true,
           "editable": true,
           "required": false,
           "defaultVisibility": true,
           "systemMaintained": false,
           "searchable": false,
           "defaultValue": null
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "id",
           "alias": "id",
           "fieldType": "esriFieldTypeOID",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": true,
           "searchable": false,
           "defaultValue": null
         }
       ],
       "fieldIndexes": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.FieldIndex",
           "name": "esri__id_idx",
           "unique": true,
           "ascending": true,
           "description": "",
           "fieldNames": [
             "id"
           ]
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.FieldIndex",
           "name": "esri__name_idx",
           "unique": true,
           "ascending": true,
           "description": "",
           "fieldNames": [
             "name"
           ]
         }
       ]
     }
   ],
   "relationshipTypes": [
     {
       "declaredClass": "esri.rest.knowledgeGraph.RelationshipType",
       "name": "employed_bu",
       "alias": "Employed By",
       "role": "Regular",
       "strict": false,
       "properties": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "id",
           "alias": "id",
           "fieldType": "esriFieldTypeGUID",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": true,
           "searchable": false,
           "defaultValue": null
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "start_date",
           "alias": "Start Date",
           "fieldType": "esriFieldTypeDate",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": false,
           "searchable": false,
           "defaultValue": null
         }
       ],
       "fieldIndexes": [
            {
            "ascending": true,
            "description": "index on id field",
            "fieldNames": ["id"],
            "name": "esri_id_idx",
            "unique": "true",
          }
       ],
       "originEntityTypes": [
         "Person"
       ],
       "destinationEntityTypes": [
         "Company"
       ]
     }
   ]
 }
}
See also

Constructors

new DataModel(properties)
Parameter
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
EntityType[]

A list of the entity types contained in the knowledge graph including their associated properties.

more details
DataModel
RelationshipType[]

A list of the relationship types in the knowledge graph including their associated properties.

more details
DataModel
SpatialReference

Specifies spatial reference information for the knowledge graph.

more details
DataModel
Boolean

Indicates whether users can make changes to the data model.

more details
DataModel
Date

The date the data model was last updated.

more details
DataModel

Property Details

declaredClass Stringreadonly inherited

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

entityTypes EntityType[]

A list of the entity types contained in the knowledge graph including their associated properties.

relationshipTypes RelationshipType[]

A list of the relationship types in the knowledge graph including their associated properties.

spatialReference SpatialReferenceautocast

Specifies spatial reference information for the knowledge graph.

Default Value:null
strict Boolean

Indicates whether users can make changes to the data model. If true, the data model cannot be modified and knowledgeGraphService.executeApplyEdits() will fail. If false, any user can make changes to the data model. The strict property of the data model can only be set by administrators or the knowledge graph service owner from the ArcGIS REST API Update (Edit Data Model).

timestamp Date

The date the data model was last updated.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
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

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

hasHandles(groupKey){Boolean}inherited

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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