Skip to content
URL:
https://<kgserver_replicas><replicaId>
Methods:
GET
Version Introduced:
12.1

Description

The replicaInfo resource provides the replica definition of a specific replica on the knowledge graph service.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | pbf

Example usage

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

https://organization.example.com/<context>/rest/services/Hosted/FieldService/KnowledgeGraphServer/replicas/13034e5f-177d-4754-af3e-298bc708cbc4

JSON Response syntax

Use dark colors for code blocksCopy
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
30
31
32
33
{
  "ReplicaDefinition": {
    "replicaName": <string>,
    "replicaId": <bytes>,
    "replicaOwner": <string>
    "lastSyncDate": <int64>,
    "creationDate": <int64>
    "syncDirection": BIDIRECTIONAL | UPLOAD | DOWNLOAD
    "replicaFilters": {
        "staticDefinition": {
          "entityTypes": [
          {
            "entityTypeReplicaDefinition": {
              "typeName": <string>
            }
          },
          {
            "entityTypeReplicaDefinition": {
              "typeName": <string>
            }
          }
          ],
          "relationshipTypes": [
            {
            "relationshipTypeReplicaDefinition": {
              "typeName": <string>
            }
          }
          ]
        }
      }
    }
  }

JSON Response example

Use dark colors for code blocksCopy
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
30
31
32
33
34
35
36
37
38
{
  "ReplicaDefinition": {
    "replicaName": "FieldService_replica",
    "replicaId": "13034e5f-177d-4754-af3e-298bc708cbc4",
    "replicaOwner": "user"
    "lastSyncDate": 1760126801000,
    "creationDate": 1725494400000
    "syncDirection": BIDIRECTIONAL
    "replicaFilters": {
        "staticDefinition": {
     "entityTypes": [
      {
       "entityTypeReplicaDefinition": {
        "typeName": "Person"
       }
      },
      {
       "entityTypeReplicaDefinition": {
        "typeName": "Species"
       }
      },
      {
       "entityTypeReplicaDefinition": {
        "typeName": "Observation"
       }
      }
     ],
     "relationshipTypes": [
      {
       "relationshipTypeReplicaDefinition": {
        "typeName": "Recorded"
       }
      }
    ]
    }
    }
  }
}

Requests and responses

This operation can also be performed by sending a PBF-formatted request and receiving a PBF-formatted response. 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 replicaInfoRequest.proto file.

PBF Response

Create a PBF-formatted response to get feedback from the operation based on the replicaInfoResponse.proto file.

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