IRPCDocClassGroupsAdmin.GetDocClassGroups

View as Markdown

Administration API / specialized admin session idempotent

Gets all class groups with their member classes.

Service	Class groups `MFiles.IRPCDocClassGroupsAdmin`
gRPC method	`/MFiles.IRPCDocClassGroupsAdmin/GetDocClassGroups`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-doc-class-groups`
Request	`GetDocClassGroupsRequest`
Response	`GetDocClassGroupsResponse`
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 read_all_metadata_structure; a normal user gets "Access denied.". Without that right, use GetObjectClassesAndGroups.
Returned 7 groups in the Sample Vault. The order is undefined.

Request: GetDocClassGroupsRequest

No fields.

Response: GetDocClassGroupsResponse

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
`class_groups[]`	repeated `ClassGroup`	One ClassGroup per class group.
`class_groups[].id`	`int32`	The ID of the class group (an item ID in value list 2, Class groups).
`class_groups[].name`	`string`	The name of the group.
`class_groups[].member_classes[]`	repeated `int32`	The IDs of the classes in the group.
`class_groups[].object_type`	`int32`	The object type with which this class group is used.

IRPCPropertyDefs.GetObjectClassesAndGroups -- Gets all classes and class groups that the user is allowed to see.