IRPCObjectOperations.GetRemoteRelationshipSourceInfo
Vault API / core read session or assertion idempotent returns metadata structure version
Gets what another vault needs to create a stub of this object, or to find a matching object. Used by replication and cross-vault relationships; not for applications.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetRemoteRelationshipSourceInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-remote-relationship-source-info |
| Request | GetRemoteRelationshipSourceInfoRequest |
| Response | GetRemoteRelationshipSourceInfoResponse |
| 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: GetRemoteRelationshipSourceInfoRequest
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 |
|---|---|---|
partial_data | RemoteRelationshipInfo | Partially filled information about the object. The JSON represents RemoteRelationshipInfo structure. |
partial_data.object_guid | string | Object GUID. |
partial_data.vault_guid | string | Object vault GUID. |
partial_data.obj_id | ObjID | Obj ID. May identify the unmanaged object in the remote vault. |
partial_data.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). |
partial_data.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
partial_data.object_type_name | string | Object type name. |
partial_data.object_aliases | string | Object type semantic aliases. |
partial_data.object_class_id | int32 | Class ID. |
partial_data.object_class_name | string | Class name. |
partial_data.object_class_aliases | string | Class semantic aliases. |
partial_data.object_external_id | string | External ID of the object. |
partial_data.object_type_guid | string | Object type GUID. |
partial_data.object_class_guid | string | Class GUID. |
Response: GetRemoteRelationshipSourceInfoResponse
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 |
|---|---|---|
filled_data | RemoteRelationshipInfo | Receives info about the object for creating relationship to another vault. The JSON represents RemoteRelationshipInfo structure. |
filled_data.object_guid | string | Object GUID. |
filled_data.vault_guid | string | Object vault GUID. |
filled_data.obj_id | ObjID | Obj ID. May identify the unmanaged object in the remote vault. |
filled_data.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). |
filled_data.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
filled_data.object_type_name | string | Object type name. |
filled_data.object_aliases | string | Object type semantic aliases. |
filled_data.object_class_id | int32 | Class ID. |
filled_data.object_class_name | string | Class name. |
filled_data.object_class_aliases | string | Class semantic aliases. |
filled_data.object_external_id | string | External ID of the object. |
filled_data.object_type_guid | string | Object type GUID. |
filled_data.object_class_guid | string | Class GUID. |