IRPCVaultAdmin.CheckAnnotationsAndRedlining
Administration API / specialized admin session idempotent
Checks whether the vault has the metadata structure that the annotations and redlining feature needs.
| Service | Vault administration MFiles.IRPCVaultAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultAdmin/CheckAnnotationsAndRedlining |
| HTTP (mf-http-grpc) | POST /grpc/v1/check-annotations-and-redlining |
| Request | CheckAnnotationsAndRedliningRequest |
| Response | CheckAnnotationsAndRedliningResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session; no special rights (a normal user can call it). Read-only.
- If it returns false, a vault administrator can enable the feature with EnableAnnotationsAndRedlining.
Request: CheckAnnotationsAndRedliningRequest
No fields.
Response: CheckAnnotationsAndRedliningResponse
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 |
|---|---|---|
enabled | bool | True if all metadata structure elements of the feature exist in the vault. |
Related methods
- EnableAnnotationsAndRedlining -- Enables annotations and redlining in the vault by creating the metadata structure elements that the feature needs.