IRPCValueLists.RemoveOrDestroyTraditionalFolder

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

Deletes or destroys a traditional folder and everything in it.

Service	Value lists `MFiles.IRPCValueLists`
gRPC method	`/MFiles.IRPCValueLists/RemoveOrDestroyTraditionalFolder`
HTTP (mf-http-grpc)	`POST /grpc/v1/remove-or-destroy-traditional-folder`
Request	`RemoveOrDestroyTraditionalFolderRequest`
Response	`RemoveOrDestroyTraditionalFolderResponse`
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

Requires the vault rights license_allows_modifications and manage_traditional_folders, and read access to the folder.
With destroy true the folder and its contents are destroyed permanently.

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
`folder_structure`	`int32`	Must be 4 (Traditional folders); any other value fails.
`folder`	`int32`	The item ID of the folder.
`destroy`	`bool`	True to destroy the folder and its contents permanently, false to mark them deleted.

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
`objects[]`	repeated `ObjID`	The IDs of the objects that were deleted or destroyed.
`objects[].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).
`objects[].item_id`	`ItemID`	The ID of the object within its type, in `item_id.internal_id`.
`objects[].item_id.internal_id`	`int32`	The ID of the object or value list item.
`objects[].item_id.external_repository_id`	`ExternalRepositoryID`	Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.