IRPCDataExport.GetExportedValueListItems
Vault API / standard read session idempotent
Gets the items of a value list in batches ordered by item ID.
| Service | Data export MFiles.IRPCDataExport |
|---|---|
| gRPC method | /MFiles.IRPCDataExport/GetExportedValueListItems |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-exported-value-list-items |
| Request | GetExportedValueListItemsRequest |
| Response | GetExportedValueListItemsResponse |
| Book and level | Vault API, standard |
| Kind | read |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Returns items whose ID is greater than
last_received_item_id, ascending by ID. Deleted items are left out. Parents of matching items are not added. - Works for value lists and object types. An unknown list fails with "Not found.".
- Stop when a batch is empty.
Request: GetExportedValueListItemsRequest
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 |
|---|---|---|
value_list | int32 | The ID of the value list or object type. |
last_received_item_id | uint32 | The ID of the last item received in the previous batch; 0 for the first batch. |
batch_size | uint32 | The maximum number of items to return; 0 returns all. |
Response: GetExportedValueListItemsResponse
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 |
|---|---|---|
pexportedvlitems[] | repeated ValueListItem | The items. See ValueListItem. |
pexportedvlitems[].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. |
pexportedvlitems[].item_info.obj_id | ObjID | The object id or value list item id. Includes the object type or value list id. |
pexportedvlitems[].item_info.name | string | The name of the item. |
pexportedvlitems[].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). |
pexportedvlitems[].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. |
pexportedvlitems[].item_info.guid | string | GUID for the item. |
pexportedvlitems[].item_info.options | ITEMFLAGS | Bit flags that provide additional information on the item (e.g. is the object deleted). |
pexportedvlitems[].item_info.external_repository_icon_id | string | The ID of the item's icon. |
pexportedvlitems[].has_parent | bool | True if the item has a parent item in the same (hierarchical) list. |
pexportedvlitems[].has_owner | bool | True if the item belongs to an item of the owner list (ValueList.owner_object_type). |
pexportedvlitems[].parent_id | int32 | With has_parent, the item ID of the parent item; otherwise ignored. |
pexportedvlitems[].owner_id | int32 | With has_owner, the item ID of the owner item in the owner list. |
pexportedvlitems[].owner_name | string | The name of the owner item. |
pexportedvlitems[].automatic_permissions | AutomaticPermissions | If set, specifies the automatic permissions for an object for which the user selects this item. |
pexportedvlitems[].automatic_permissions.permissions | NamedACL | The automatic permissions for an object for which the user selects this item. |
pexportedvlitems[].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. |
pexportedvlitems[].automatic_permissions.use_object_permissions | bool | If true the object/item's own permissions are used as its automatic permissions. |
pexportedvlitems[].icon | Bytes | If set, contains the icon of this item in .ICO format. |
pexportedvlitems[].icon.value | bytes | Array of bytes. |
Related methods
- GetExportedValueListItemsByID -- Gets the given items of a value list.