IRPCDocClassGroupsAdmin.AddDocClassGroup
Administration API / specialized admin session
Creates a class group.
| Service | Class groups MFiles.IRPCDocClassGroupsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCDocClassGroupsAdmin/AddDocClassGroup |
| HTTP (mf-http-grpc) | POST /grpc/v1/add-doc-class-group |
| Request | AddDocClassGroupRequest |
| Response | AddDocClassGroupResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires
change_metadata_structureandlicense_allows_modifications. - Only document classes can be grouped:
object_typemust be 0 (Document), otherwise the call fails with an invalid-argument error. - Increments the metadata structure version.
Request: AddDocClassGroupRequest
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 new ClassGroup with its name and member classes. id is ignored and assigned by the server. |
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: AddDocClassGroupResponse
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 |
|---|---|---|
id | int32 | The ID of the new class group. |