IRPCObjectTypesAdmin.RemoveObjectTypeItem

View as Markdown

Administration API / specialized admin session

Deletes an item of a value list as an administrator.

Service	Object type administration `MFiles.IRPCObjectTypesAdmin`
gRPC method	`/MFiles.IRPCObjectTypesAdmin/RemoveObjectTypeItem`
HTTP (mf-http-grpc)	`POST /grpc/v1/remove-object-type-item`
Request	`RemoveObjectTypeItemRequest`
Response	`RemoveObjectTypeItemResponse`
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_structure and license_allows_modifications.
The item is marked deleted. Only for plain value lists: real object types fail with "Not found.", classes (1), class groups (2) and list 18 with an invalid-argument error, and external lists are refused.
If the item owns items in other lists, set allow_removing_owned_items to true to allow removing them as well.

Request: RemoveObjectTypeItemRequest

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
`obj_id`	`ObjID`	The item: `type` is the value list ID, `item_id.internal_id` the item ID.
`obj_id.type`	`int32`	The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID).
`obj_id.item_id`	`ItemID`	The ID of the object within its type, in `item_id.internal_id`.
`obj_id.item_id.internal_id`	`int32`	The ID of the object or value list item.
`obj_id.item_id.external_repository_id`	`ExternalRepositoryID`	Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.
`allow_removing_owned_items`	`bool`	True if removing the owned items of the object type item is allowed. The owned items reside in different object types.

Response: RemoveObjectTypeItemResponse

No fields.

RemoveObjectType -- Removes an object type or value list together with its items, classes and dependent views.