IRPCObjectOperations.FollowObject
Vault API / core write session or assertion returns metadata structure version
Starts or stops following the specified object. While the object is being followed, the current user will be notified if the object changes.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/FollowObject |
| HTTP (mf-http-grpc) | POST /grpc/v1/follow-object |
| Request | FollowObjectRequest |
| Response | FollowObjectResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Starts (follow_state: true) or stops (false) following the object for the caller.
Request: FollowObjectRequest
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 |
|---|---|---|
obj_id | ObjID | The object ID. |
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). |
obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id.item_id.internal_id | int32 | The ID of the object or value list item. |
obj_id.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
follow_state | bool | True if the objects should be followed, false if not followed. |
Response: FollowObjectResponse
No fields.