IRPCObjectOperations.PromoteUnmanagedObject
Vault API / core write session or assertion returns metadata structure version
Promotes objects of an external repository (unmanaged objects) to managed M-Files objects by giving them metadata.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/PromoteUnmanagedObject |
| HTTP (mf-http-grpc) | POST /grpc/v1/promote-unmanaged-object |
| Request | PromoteUnmanagedObjectRequest |
| Response | PromoteUnmanagedObjectResponse |
| 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) |
Request: PromoteUnmanagedObjectRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
properties[] | repeated SetPropertiesParams | Parameters (one set of parameters per object). |
properties[].obj_ver | ObjVer | The version to change, by number: the checked-out version if the caller has the object checked out, otherwise the latest checked-in version. The LATEST marker is not accepted. |
properties[].obj_ver.obj_id | ObjID | The object. |
properties[].obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
properties[].allow_modifying_checked_in_object | bool | True to change a checked-in object: the server checks it out, applies the change and checks it in as one new version. |
properties[].fail_if_not_latest_checked_in_version | bool | With allow_modifying_checked_in_object, true to fail if obj_ver is not the latest checked-in version. |
properties[].object_version_guid | string | Optional version_guid of the version in obj_ver, checked together with fail_if_not_latest_checked_in_version. Leave empty normally. |
properties[].set_properties[] | repeated PropertyValue | Property values to add or replace. Other properties stay unchanged. |
properties[].set_properties[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
properties[].set_properties[].value | TypedValue | The value. Its type must match the data type of the property definition. |
properties[].is_full_set | bool | True to treat set_properties as the full set and remove every other property the class does not list. set_properties must then include Class (100). Leave false. |
properties[].remove_properties[] | repeated int32 | Property definition IDs to remove. Properties listed by the class cannot be removed; set them empty instead. |
properties[].options | OBJECTOPFLAGS | Flags that control this operation. |
properties[].options.all | bool | Specifies all flags set; Including any future flags. |
properties[].options.require_read_access_after_operation | bool | Requires read access to the object after the object operation. If available, the operation fails if the user does not have read access to the object after the operation. |
properties[].options.require_edit_access_after_operation | bool | Requires edit access to the object after the object operation. If available, the operation fails if the user does not have edit access to the object after the operation. |
properties[].options.disallow_name_change | bool | If specified, the operation will fail if it causes a change in the object version's name. |
properties[].options.require_change_permissions_access_after_operation | bool | Requires security change access to the object after the object operation. If available, the operation fails if the user does not have security change access to the object after the operation. |
properties[].options.require_full_access_after_operation | bool | Requires full access to the object after the object operation. If available, the operation fails if the user does not have full access to the object after the operation. |
properties[].options.change_acl_in_all_versions | bool | Changes the ACL of all versions of the object. This is currently used to request setting the ACL of all versions of an object, not just a specific version, when calling ChangeSecurity. |
properties[].options.verify_check_in_wopi_locked_document | bool | Verify the document is locked for WOPI Co-authoring or editing during checkin. |
properties[].acl_enforcing_mode | ACLEnforcingMode | Which ACL the server starts from when it updates the permissions; see SetProperties acl_mode. ACLENFORCING_MODE_DISALLOW_CHANGES is rejected.Values: ACLENFORCING_MODE_USE_PREVIOUS (0), ACLENFORCING_MODE_USE_PROVIDED (1), ACLENFORCING_MODE_RESET_TO_DEFAULT (2), ACLENFORCING_MODE_DISALLOW_CHANGES (3). |
properties[].acl | AccessControlList | The permissions to use with ACLENFORCING_MODE_USE_PROVIDED. Unset otherwise. |
properties[].acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
properties[].acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
properties[].acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
properties[].acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
properties[].acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
properties[].acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
check_in | bool | If true, the object is checked in immediately, otherwise the object is left to checked-out state. |
Response: PromoteUnmanagedObjectResponse
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 |
|---|---|---|
promoted_objects[] | repeated ExtObjectInfo | Results. |
promoted_objects[].is_visible | bool | True if any version of the object is visible to the caller. |
promoted_objects[].object_info | ObjectLevelInfo | Object-level information, if is_visible is true. |
promoted_objects[].object_info.obj_id | ObjID | The object type and ID of the object. |
promoted_objects[].object_info.external_id_status | ExtIDStatus | The status of this object'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). |
promoted_objects[].object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
promoted_objects[].object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
promoted_objects[].object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
promoted_objects[].object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
promoted_objects[].object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
promoted_objects[].object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
promoted_objects[].object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
promoted_objects[].object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
promoted_objects[].object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
promoted_objects[].object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
promoted_objects[].object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
promoted_objects[].object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
promoted_objects[].object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
promoted_objects[].object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
promoted_objects[].object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
promoted_objects[].object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
promoted_objects[].object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |
promoted_objects[].is_latest_version_visible | bool | True if the latest version of the object is visible to the caller. |
promoted_objects[].latest_version | ObjectVersionExWP | The latest version of the object with its properties and ACL, if is_latest_version_visible is true. Some methods (for example UndoCheckout) return it without property values. |
promoted_objects[].latest_version.object_version | ObjectVersionEx | Object info. |
promoted_objects[].latest_version.properties[] | repeated PropertyValue | Property values, or an empty array. |
promoted_objects[].latest_version.acl | AccessControlList | If set, ACL. |
promoted_objects[].latest_version.current_user_permissions | ObjectPermissionsForClient | If set, permissions of the object version. |
promoted_objects[].original_obj_ver | ObjVer | The object version the request named, as sent. The version part may be unset. |
promoted_objects[].original_obj_ver.obj_id | ObjID | The object. |
promoted_objects[].original_obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
updated_objects[] | repeated ObjectVersionEx | Information about objects that were also updated during the operation. (represented by ObjectVersionEx structs.) |
updated_objects[].version_info | ObjectVersion | Object Version information. |
updated_objects[].version_info.version | ObjVerVersion | The version number, as a specific version. |
updated_objects[].version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
updated_objects[].version_info.title | string | The title (name) of the object in this version. |
updated_objects[].version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
updated_objects[].version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
updated_objects[].version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
updated_objects[].version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
updated_objects[].version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
updated_objects[].version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
updated_objects[].version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
updated_objects[].version_info.class_id | int32 | The class ID of the version. |
updated_objects[].version_info.version_guid | string | The GUID of this version. |
updated_objects[].version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
updated_objects[].version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
updated_objects[].object_info | ObjectLevelInfo | Object-level information. |
updated_objects[].object_info.obj_id | ObjID | The object type and ID of the object. |
updated_objects[].object_info.external_id_status | ExtIDStatus | The status of this object'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). |
updated_objects[].object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
updated_objects[].object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
updated_objects[].object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
updated_objects[].object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
updated_objects[].object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
updated_objects[].object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
updated_objects[].object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
updated_objects[].object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
updated_objects[].object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
updated_objects[].object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
updated_objects[].object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
updated_objects[].object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
updated_objects[].object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |