IRPCPropertyDefsAdmin.RemoveObjectClass
Administration API / specialized admin session
Deletes a class.
| Service | Property definition and class administration MFiles.IRPCPropertyDefsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCPropertyDefsAdmin/RemoveObjectClass |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-object-class |
| Request | RemoveObjectClassRequest |
| Response | RemoveObjectClassResponse |
| 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, and read access to the class. - Built-in classes cannot be removed.
- Objects of the class may exist: the class is then only marked deleted, new objects cannot use it, and existing objects keep their property values.
- Removes the class from its class groups. Increments the metadata structure version.
Request: RemoveObjectClassRequest
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_id | int32 | The ID of the object class to remove. |
Response: RemoveObjectClassResponse
No fields.