IRPCObjectOperations.GetRemoteRelationshipTargetInfo
Vault API / core read session or assertion idempotent returns metadata structure version
Finds the local object that matches an object of another vault, or the information for creating a stub of it. Used by replication and cross-vault relationships; not for applications.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetRemoteRelationshipTargetInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-remote-relationship-target-info |
| Request | GetRemoteRelationshipTargetInfoRequest |
| Response | GetRemoteRelationshipTargetInfoResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Request: GetRemoteRelationshipTargetInfoRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
remote_ | RemoteRelationshipInfo | Info about the object in the remote vault. The JSON represents RemoteRelationshipInfo structure. |
remote_.object_guid | string | Object GUID. |
remote_.vault_guid | string | Object vault GUID. |
remote_.obj_id | ObjID | Obj ID. May identify the unmanaged object in the remote vault. |
remote_.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
remote_.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
remote_.object_type_name | string | Object type name. |
remote_.object_aliases | string | Object type semantic aliases. |
remote_.object_class_id | int32 | Class ID. |
remote_.object_class_name | string | Class name. |
remote_.object_class_aliases | string | Class semantic aliases. |
remote_.object_external_id | string | External ID of the object. |
remote_.object_type_guid | string | Object type GUID. |
remote_.object_class_guid | string | Class GUID. |
Response: GetRemoteRelationshipTargetInfoResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
found | bool | True if the object exists already in the local vault, false if it needs to be created. |
local_ | RemoteRelationshipInfo | Receives info about the object in the local vault. The JSON represents RemoteRelationshipInfo structure. |
local_.object_guid | string | Object GUID. |
local_.vault_guid | string | Object vault GUID. |
local_.obj_id | ObjID | Obj ID. May identify the unmanaged object in the remote vault. |
local_.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
local_.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
local_.object_type_name | string | Object type name. |
local_.object_aliases | string | Object type semantic aliases. |
local_.object_class_id | int32 | Class ID. |
local_.object_class_name | string | Class name. |
local_.object_class_aliases | string | Class semantic aliases. |
local_.object_external_id | string | External ID of the object. |
local_.object_type_guid | string | Object type GUID. |
local_.object_class_guid | string | Class GUID. |