Unregister Replica (Knowledge Graph Service)

Description

The unregister operation allows a client to remove a knowledge graph service replica. Administrative clients can call the unregister operation for all replicas on the knowledge graph service. Non-administrative clients can only call the unregister operation for replicas they are registered as the owner. Clients can remove all accessible replicas in a request. Use the replicas resource to learn about the list of replicas on a knowledge graph service.

Request parameters

Example usage

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

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

The following POST request example demonstrates the unregister operation being called to unregister specific replicaIds.

Example syntax

1
2
3
4
5
6
7
{
  "unregisterReplicaRequest": {
   "replicaIds": [
      <bytes>
   ]
  }
 }

1
2
3
4
5
6
7
8
{
  "unregisterReplicaRequest": {
   "replicaIds": [
    "00000000-aaaa-bbbb-cccc-111111111111",
    "12345abc-abcd-ef12-5555-012345670000"
   ]
  }
 }

JSON Response syntax

1
{"unregisterResults": [{"replicaId": <bytes>}]}

JSON Response example

1
2
3
4
{"unregisterResults": [
 {"replicaId": "{00000000-aaaa-bbbb-cccc-111111111111}"},
 {"replicaId": "{12345abc-abcd-ef12-5555-012345670000}"}
]}

Requests and responses

This operation can also 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 UnregisterReplicaRequest.proto file.

PBF Response

Create a PBF-formatted request to query the status of the operation based on the UnregisterReplicaResponse.proto file.