Create Replica (Knowledge Graph Service)

Description

The create operation creates a replica definition based on a knowledge graph service. The operation returns a replica that clients can download and persist in a local database. The sync feature must be enabled in order to execute the create operation. The owner of the knowledge graph service and administrators of the ArcGIS Enterprise organization can enable the sync feature by using the updateFeature operation.

Any user can create a replica of a knowledge graph service. However, the portal user type, in combination with the capabilities of the knowledge graph service, determine the types of replicas that can be created. The following table provides the various combinations of portal user type and knowledge graph service capabilities, and the resulting replicas that can be created.

The difference between the replicas created by different user types allows owners and administrators to sync edits and manage data while providing read-only access to other users. Owners of a knowledge graph service and administrative clients can create a replica of a knowledge graph service regardless of the knowledge graph service capabilities. The user who executes the createReplica operation is assigned ownership of the replica. Users can view, synchronize and unregister replicas they own.

Request parameters

Example usage

The following is a sample request URL used to access the create operation for a knowledge graph service named FieldService:

https://organization.example.com/<context>/rest/services/Hosted/FieldService/KnowledgeGraphServer/replicas/create

The below example POST parameters use the replicaFilter to specify the entity and relationship types that will be added to the replica.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "createReplicaRequest": {
   "replicaFilters": {
    "staticDefinition": {
     "entityTypes": [
      {
       "entityTypeReplicaDefinition": {
        "typeName": "Person"
       }
      },
      {
       "entityTypeReplicaDefinition": {
        "typeName": "Company"
       }
      }
     ],
     "relationshipTypes": [
      {
       "relationshipTypeReplicaDefinition": {
        "typeName": "WORKS_AT"
       }
      }
     ]
    }
   },
   "syncDirection": "BIDIRECTIONAL",
   "dataFormat": "PBF"
  }
 }

Example Response syntax

1
2
3
4
5
6
7
8
9
  {"createReplicaResult": {
      "replicaDataUrl": <url>
      "replicaId": <bytes>,
      "syncDate": <int64>, // milliseconds since epoch
      "replicaName": <string>,
      "syncDirection": BIDIRECTIONAL | UPLOAD | DOWNLOAD
      "replicaDataFormat": PBF
    }
  }

Example Response example

1
2
3
4
5
6
7
8
9
  {"createReplicaResult": {
      "replicaDataUrl": "https://organization.example.com/<context>/rest/directories/arcgisoutput/Hosted/FieldService_KnowledgeGraphServer/_ags_kgs_151bced0-903e-4c56-a8ea-a7d5171d1457.zip",
      "replicaId": {5481F8D0-E519-46D8-9227-EEBEB551FE6E},
      "syncDate": 1775078735036,
      "replicaName": "KGS_33299f84-713e-4634-968d-a9174e1f02c2",
      "syncDirection": BIDIRECTIONAL
      "replicaDataFormat": PBF
    }
  }

Requests and responses

This operation can be performed by sending a PBF-formatted request and receiving a PBF-formatted response. The status of the operation can be queried using a PBF-formatted request. Details of the request and response parameters are provided in the appropriate .proto files.

PBF Request

Create a PBF-formatted request to perform this operation based on the CreateReplicaRequest.proto file.

PBF Response

When executing this operation asynchronously, create a PBF-formatted response to query the status of the operation based on the AsyncStatusResponse.proto file.

Once the operation is complete, download the replica using the replica_data_url in the PBF-formatted response based on the CreateReplicaResponse.proto file.