IRPCObjectOperations.SetObjectActive
Vault API / core write session or assertion
Clears the draft (pending-upload) flag on an object, leaving it checked out. Used when the file upload has completed and the object should become a normal checked-out object without being checked in. Never checks the object in; a safe no-op on a non-draft.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/SetObjectActive |
| HTTP (mf-http-grpc) | POST /grpc/v1/set-object-active |
| Request | SetObjectActiveRequest |
| Response | SetObjectActiveResponse |
| 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 | no |
| Streaming | none (unary) |
Remarks
Completes the draft flow of
AddObjectWithFiles (draft: true): after
the file content has been uploaded, this clears the draft flag. The object stays checked out; check
it in with CheckIn.
Request: SetObjectActiveRequest
A request structure for the SetObjectActive RPC call. It contains all request data. Identifies the draft object whose draft (pending-upload) flag is cleared.
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 |
|---|---|---|
obj_ver | ObjVer | The draft object version to make active. |
obj_ver.obj_id | ObjID | The object. |
obj_ver.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_ver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
obj_ver.version.type | ObjVerVersionType | What internal_version means. OBJ_VER_VERSION_TYPE_SPECIFIC for a version number.Values: OBJ_VER_VERSION_TYPE_UNINITIALIZED (0), OBJ_VER_VERSION_TYPE_LATEST (1), OBJ_VER_VERSION_TYPE_ANY (2), OBJ_VER_VERSION_TYPE_ALL (3), OBJ_VER_VERSION_TYPE_SPECIFIC (4), OBJ_VER_VERSION_TYPE_VALUE_LIST_ITEM (6), OBJ_VER_VERSION_TYPE_OBJECT_LEVEL_REFERENCE (7). |
obj_ver.version.internal_version | int32 | The version number, starting from 1, when type is OBJ_VER_VERSION_TYPE_SPECIFIC. The server returns -1 with OBJ_VER_VERSION_TYPE_LATEST. |
obj_ver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
obj_ver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
Response: SetObjectActiveResponse
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 |
|---|---|---|
updated_object | ObjectVersionExWP | The object after clearing the draft flag (still checked out), with its properties and ACL. |
updated_object.object_version | ObjectVersionEx | Object info. |
updated_object.object_version.version_info | ObjectVersion | Object Version information. |
updated_object.object_version.object_info | ObjectLevelInfo | Object-level information. |
updated_object.properties[] | repeated PropertyValue | Property values, or an empty array. |
updated_object.properties[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
updated_object.properties[].value | TypedValue | The value. Its type must match the data type of the property definition. |
updated_object.acl | AccessControlList | If set, ACL. |
updated_object.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. |
updated_object.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. |
updated_object.acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
updated_object.acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
updated_object.acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
updated_object.acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
updated_object.current_user_permissions | ObjectPermissionsForClient | If set, permissions of the object version. |
updated_object.current_user_permissions.can_user_see | bool | The object is visible for the current user (provided for symmetry). |
updated_object.current_user_permissions.can_user_edit | bool | The current user can edit the object. |
updated_object.current_user_permissions.can_user_delete | bool | The current user can delete the object. |
updated_object.current_user_permissions.can_user_change_permissions | bool | The current user can change the object permissions. |
Related methods
- AddObjectWithFiles -- Creates a new object, optionally with its files, and optionally checks it in.
- CheckIn -- Checks in one object.