IRPCValueLists.UpdateValueListItemFromClient
Vault API / core write session or assertion returns metadata structure version
Updates an item of a plain value list or a traditional folder, as a user.
| Service | Value lists MFiles.IRPCValueLists |
|---|---|
| gRPC method | /MFiles.IRPCValueLists/UpdateValueListItemFromClient |
| HTTP (mf-http-grpc) | POST /grpc/v1/update-value-list-item-from-client |
| Request | UpdateValueListItemFromClientRequest |
| Response | UpdateValueListItemFromClientResponse |
| 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_modificationsandmanage_value_list_items_from_client(for Traditional folders, list 4:manage_traditional_folders), and read access to the item. - Not for real object types ("Not found."), the Classes list (1) or the Class groups list (2)
("The parameter is incorrect."), or lists whose
options.is_externalis set (this includes built-in lists such as Users and Workflows). - Send the complete item: read it first (for example with SearchValueListItemsWithPermissions), change what you need and send it back.
- The response echoes the item you sent; fields you left out (such as the GUID) come back empty even though the stored values are unchanged. Re-read the item if you need them.
Request: UpdateValueListItemFromClientRequest
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 |
|---|---|---|
vl_item | ValueListItem | The complete item, identified by item_info.obj_id (value list ID and item ID). |
vl_item.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. |
vl_item.item_info.obj_id | ObjID | The object id or value list item id. Includes the object type or value list id. |
vl_item.item_info.name | string | The name of the item. |
vl_item.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). |
vl_item.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. |
vl_item.item_info.guid | string | GUID for the item. |
vl_item.item_info.options | ITEMFLAGS | Bit flags that provide additional information on the item (e.g. is the object deleted). |
vl_item.item_info.external_repository_icon_id | string | The ID of the item's icon. |
vl_item.has_parent | bool | True if the item has a parent item in the same (hierarchical) list. |
vl_item.has_owner | bool | True if the item belongs to an item of the owner list (ValueList.owner_object_type). |
vl_item.parent_id | int32 | With has_parent, the item ID of the parent item; otherwise ignored. |
vl_item.owner_id | int32 | With has_owner, the item ID of the owner item in the owner list. |
vl_item.owner_name | string | The name of the owner item. |
vl_item.automatic_permissions | AutomaticPermissions | If set, specifies the automatic permissions for an object for which the user selects this item. |
vl_item.automatic_permissions.permissions | NamedACL | The automatic permissions for an object for which the user selects this item. |
vl_item.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. |
vl_item.automatic_permissions.use_object_permissions | bool | If true the object/item's own permissions are used as its automatic permissions. |
vl_item.icon | Bytes | If set, contains the icon of this item in .ICO format. |
vl_item.icon.value | bytes | Array of bytes. |
Response: UpdateValueListItemFromClientResponse
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 |
|---|---|---|
result | ValueListItem | The item as sent in the request. |
result.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. |
result.item_info.obj_id | ObjID | The object id or value list item id. Includes the object type or value list id. |
result.item_info.name | string | The name of the item. |
result.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). |
result.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. |
result.item_info.guid | string | GUID for the item. |
result.item_info.options | ITEMFLAGS | Bit flags that provide additional information on the item (e.g. is the object deleted). |
result.item_info.external_repository_icon_id | string | The ID of the item's icon. |
result.has_parent | bool | True if the item has a parent item in the same (hierarchical) list. |
result.has_owner | bool | True if the item belongs to an item of the owner list (ValueList.owner_object_type). |
result.parent_id | int32 | With has_parent, the item ID of the parent item; otherwise ignored. |
result.owner_id | int32 | With has_owner, the item ID of the owner item in the owner list. |
result.owner_name | string | The name of the owner item. |
result.automatic_permissions | AutomaticPermissions | If set, specifies the automatic permissions for an object for which the user selects this item. |
result.automatic_permissions.permissions | NamedACL | The automatic permissions for an object for which the user selects this item. |
result.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. |
result.automatic_permissions.use_object_permissions | bool | If true the object/item's own permissions are used as its automatic permissions. |
result.icon | Bytes | If set, contains the icon of this item in .ICO format. |
result.icon.value | bytes | Array of bytes. |
Related methods
- SearchValueListItemsWithPermissions -- Searches the items of one value list or object type by item ID, name, owner, parent or deleted state.