IRPCValueLists.GetValueListItemProposals
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the values that the calling user has most recently used for a lookup property.
| Service | Value lists MFiles.IRPCValueLists |
|---|---|
| gRPC method | /MFiles.IRPCValueLists/GetValueListItemProposals |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-value-list-item-proposals |
| Request | GetValueListItemProposalsRequest |
| Response | GetValueListItemProposalsResponse |
| Book and level | Vault API, core |
| Kind | read |
| 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
- Requires a vault session. Returns at most five items, the most recently used first. Deleted items and items the user cannot see are left out.
- A property that is not a lookup, or that the user has not used yet, gives an empty list.
- Use it to offer quick picks next to a lookup control filled with GetLookupItems.
Request: GetValueListItemProposalsRequest
Request for getting proposed values for a lookup property.
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 |
|---|---|---|
property_def_id | uint32 | The ID of the lookup property definition whose recently used values are wanted. |
Response: GetValueListItemProposalsResponse
Response for getting proposed values for a lookup property.
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 |
|---|---|---|
proposed_values[] | repeated ValueListItem | Up to five items, most recently used first. |
proposed_values[].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. |
proposed_values[].item_info.obj_id | ObjID | The object id or value list item id. Includes the object type or value list id. |
proposed_values[].item_info.name | string | The name of the item. |
proposed_values[].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). |
proposed_values[].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. |
proposed_values[].item_info.guid | string | GUID for the item. |
proposed_values[].item_info.options | ITEMFLAGS | Bit flags that provide additional information on the item (e.g. is the object deleted). |
proposed_values[].item_info.external_repository_icon_id | string | The ID of the item's icon. |
proposed_values[].has_parent | bool | True if the item has a parent item in the same (hierarchical) list. |
proposed_values[].has_owner | bool | True if the item belongs to an item of the owner list (ValueList.owner_object_type). |
proposed_values[].parent_id | int32 | With has_parent, the item ID of the parent item; otherwise ignored. |
proposed_values[].owner_id | int32 | With has_owner, the item ID of the owner item in the owner list. |
proposed_values[].owner_name | string | The name of the owner item. |
proposed_values[].automatic_permissions | AutomaticPermissions | If set, specifies the automatic permissions for an object for which the user selects this item. |
proposed_values[].automatic_permissions.permissions | NamedACL | The automatic permissions for an object for which the user selects this item. |
proposed_values[].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. |
proposed_values[].automatic_permissions.use_object_permissions | bool | If true the object/item's own permissions are used as its automatic permissions. |
proposed_values[].icon | Bytes | If set, contains the icon of this item in .ICO format. |
proposed_values[].icon.value | bytes | Array of bytes. |
Related methods
- GetLookupItems -- Gets the selectable items of one or more value lists or object types in one call, for example to fill lookup controls.
- GetValueList -- Gets one value list or object type by ID, without its icon.