IRPCSearch.GetPrefillProperties
Vault API / core read session or assertion idempotent
Gets the property values that a new object created in the given folder gets from that folder.
| Service | Search MFiles.IRPCSearch |
|---|---|
| gRPC method | /MFiles.IRPCSearch/GetPrefillProperties |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-prefill-properties |
| Request | GetPrefillPropertiesRequest |
| Response | GetPrefillPropertiesResponse |
| 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 | no |
| Streaming | none (unary) |
Remarks
Used by the M-Files clients to prefill the metadata card when the user creates an object in a view or grouping folder.
Request: GetPrefillPropertiesRequest
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 |
|---|---|---|
object_type | int32 | Target object type. |
value[] | repeated Folder | Describes the parent folder. |
value[].type | FolderType | The type of the folder, for example FOLDER_TYPE_VIEW_FOLDER or FOLDER_TYPE_PROPERTY_FOLDER.Values: FOLDER_TYPE_UNKNOWN (0), FOLDER_TYPE_ANY_FOLDER (1), FOLDER_TYPE_VIEW_FOLDER (2), FOLDER_TYPE_PROPERTY_FOLDER (3), FOLDER_TYPE_TRADITIONAL_FOLDER (4), FOLDER_TYPE_SEARCH_FOLDER (5), FOLDER_TYPE_EXTERNAL_VIEW_FOLDER (6). |
value[].data | FolderInfoUnion | Additional folder type -specific information as a union. |
value[].data.any_folder | FolderInfoUnion.AnyFolderData (oneof data) | Any folder type. |
value[].data.view_folder | FolderInfoUnion.ViewFolderData (oneof data) | View folder type. |
value[].data.property_folder | FolderInfoUnion.PropertyFolderData (oneof data) | Property (virtual) folder type. |
value[].data.traditional_folder | FolderInfoUnion.TraditionalFolderData (oneof data) | Traditional folder type. |
value[].data.search_folder | FolderInfoUnion.SearchFolderData (oneof data) | Search folder (extended view folder) type. |
value[].data.external_view_folder | FolderInfoUnion.ExternalViewFolderData (oneof data) | External view folder type. |
Response: GetPrefillPropertiesResponse
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 |
|---|---|---|
propertyvaluearray[] | repeated PropertyValue | List of prefill properties. |
propertyvaluearray[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
propertyvaluearray[].value | TypedValue | The value. Its type must match the data type of the property definition. |
propertyvaluearray[].value.is_null_value | bool | True if the value is empty. data is then unset. |
propertyvaluearray[].value.type | Datatype | The data type of the value. |
propertyvaluearray[].value.data | TypedValueUnion | The value, in the member that matches type. Unset for an empty value. |