IRPCObjectTypesAdmin.RemoveObjectType
Administration API / specialized admin session
Removes an object type or value list together with its items, classes and dependent views.
| Service | Object type administration MFiles.IRPCObjectTypesAdmin |
|---|---|
| gRPC method | /MFiles.IRPCObjectTypesAdmin/RemoveObjectType |
| HTTP (mf-http-grpc) | POST /grpc/v1/remove-object-type |
| Request | RemoveObjectTypeRequest |
| Response | RemoveObjectTypeResponse |
| 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
- Destroys the list's items, the classes of the object type, the views and similar elements that use it, the external locations that create objects of the type, and the type's owner, default and conflict property definitions. This cannot be undone.
- Requires
change_metadata_structureandlicense_allows_modifications. - Fails for built-in object types and value lists, for a type or list that owns another one, for a real object type that still has objects (destroy them first), and when other property definitions are based on the list (the error names them).
- For an external object type only the cached items are removed; the external database is not touched.
- Increments the metadata structure version.
Request: RemoveObjectTypeRequest
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 |
|---|---|---|
object_type | int32 | The ID of the object type to remove. |
Response: RemoveObjectTypeResponse
No fields.
Related methods
- RemoveObjectTypeItem -- Deletes an item of a value list as an administrator.