IRPCValueLists.RenameValueListItemFromClient

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

Renames a traditional folder.

Service	Value lists `MFiles.IRPCValueLists`
gRPC method	`/MFiles.IRPCValueLists/RenameValueListItemFromClient`
HTTP (mf-http-grpc)	`POST /grpc/v1/rename-value-list-item-from-client`
Request	`RenameValueListItemFromClientRequest`
Response	`RenameValueListItemFromClientResponse`
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	yes
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 "The parameter is incorrect.". The new name must not be empty.
Requires the vault rights license_allows_modifications and manage_traditional_folders, and read access to the folder.

Request: RenameValueListItemFromClientRequest

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.
`new_name`	`string`	The new name; must not be empty.

Response: RenameValueListItemFromClientResponse

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
`items[]`	repeated `ValueListItem`	The renamed folder and its parent folders.
`items[].item_info`	`ItemInfo`	The item's identity and name: `obj_id.type` is the value list ID, `obj_id.item_id.internal_id` the item ID (unique within the list only), plus `name`, `guid`, `external_id` and flags. `options.is_deleted` marks a deleted item.
`items[].item_info.obj_id`	`ObjID`	The object id or value list item id. Includes the object type or value list id.
`items[].item_info.name`	`string`	The name of the item.
`items[].item_info.external_id_status`	`ExtIDStatus`	The status of this item's external ID.Values: `EXT_IDSTATUS_UNKNOWN` (0), `EXT_IDSTATUS_EXTERNAL` (1), `EXT_IDSTATUS_INTERNAL` (2), `EXT_IDSTATUS_DISCARDED` (3), `EXT_IDSTATUS_NOT_AVAILABLE` (4), `EXT_IDSTATUS_EXTERNAL_REDUCED` (5).
`items[].item_info.external_id`	`string`	The external ID (display ID) of this item. unset means that the external ID is the same as the internal ID.
`items[].item_info.guid`	`string`	GUID for the item.
`items[].item_info.options`	`ITEMFLAGS`	Bit flags that provide additional information on the item (e.g. is the object deleted).
`items[].item_info.external_repository_icon_id`	`string`	The ID of the item's icon.
`items[].has_parent`	`bool`	True if the item has a parent item in the same (hierarchical) list.
`items[].has_owner`	`bool`	True if the item belongs to an item of the owner list (`ValueList.owner_object_type`).
`items[].parent_id`	`int32`	With `has_parent`, the item ID of the parent item; otherwise ignored.
`items[].owner_id`	`int32`	With `has_owner`, the item ID of the owner item in the owner list.
`items[].owner_name`	`string`	The name of the owner item.
`items[].automatic_permissions`	`AutomaticPermissions`	If set, specifies the automatic permissions for an object for which the user selects this item.
`items[].automatic_permissions.permissions`	`NamedACL`	The automatic permissions for an object for which the user selects this item.
`items[].automatic_permissions.is_default`	`bool`	True if these automatic permissions are not private i.e. they are not directly specified for (owned by) this item but they come from somewhere else, e.g. from the default/common automatic permissions of the object type.
`items[].automatic_permissions.use_object_permissions`	`bool`	If true the object/item's own permissions are used as its automatic permissions.
`items[].icon`	`Bytes`	If set, contains the icon of this item in .ICO format.
`items[].icon.value`	`bytes`	Array of bytes.
`current_version_on_server`	`int64`	The current version of the Traditional folders list's items.