IRPCDocClassGroupsAdmin.ModifyDocClassGroup

View as Markdown

Administration API / specialized admin session idempotent

Saves a changed class group: its name and member classes.

Service	Class groups `MFiles.IRPCDocClassGroupsAdmin`
gRPC method	`/MFiles.IRPCDocClassGroupsAdmin/ModifyDocClassGroup`
HTTP (mf-http-grpc)	`POST /grpc/v1/modify-doc-class-group`
Request	`ModifyDocClassGroupRequest`
Response	`ModifyDocClassGroupResponse`
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 change_metadata_structure and license_allows_modifications, and read access to the group. object_type must be 0 (Document), as in AddDocClassGroup.
Classes added to or removed from member_classes change the class-group information of existing documents of those classes.
Increments the metadata structure version.

Request: ModifyDocClassGroupRequest

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

Response: ModifyDocClassGroupResponse

No fields.

AddDocClassGroup -- Creates a class group.