- URL:
- https://<kgserver_replicas>/<replicaId>
- Methods:
GET- Version Introduced:
- 12.1
Description
The replica resource provides the replica definition of a specific replica on the knowledge graph service.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the replicas resource for a knowledge graph service named Field:
https
JSON Response syntax
{
"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
{
"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"
}
}
]
}
}
}
}PBF Response
Create a PBF-formatted response to get feedback from the operation based on the replica file.