IRPCValueLists.RemoveValueListItemFromClient

View as Markdown

Vault API / core write session or assertion returns metadata structure version

Deletes a traditional folder (marks it deleted).

Service	Value lists `MFiles.IRPCValueLists`
gRPC method	`/MFiles.IRPCValueLists/RemoveValueListItemFromClient`
HTTP (mf-http-grpc)	`POST /grpc/v1/remove-value-list-item-from-client`
Request	`RemoveValueListItemFromClientRequest`
Response	`RemoveValueListItemFromClientResponse`
Book and level	Vault API, core
Kind	write
Session	Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotent	no
Returns metadata structure version	yes (in the mfiles-metadata-version-bin trailer)
Streaming	none (unary)

Remarks

Works only for Traditional folders (value list 4); other lists fail with "Access denied.". allow_removing_owned_items must be false; true also fails with "Access denied.".
Requires the vault rights license_allows_modifications and manage_traditional_folders, and read access to the folder.
Related: RemoveOrDestroyTraditionalFolder also handles the folder's contents.

Request: RemoveValueListItemFromClientRequest

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 folder: `type` 4 and the folder's 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`	Must be false; the server rejects true with "Access denied.".

Response: RemoveValueListItemFromClientResponse

No fields.

RemoveOrDestroyTraditionalFolder -- Deletes or destroys a traditional folder and everything in it.