Skip to main content

ObjectLevelInfo

Object-level information.

NameDescriptionType
obj_idObject ID.ObjID
external_id_statusThe status of this object's external ID.ExtIDStatus
external_idThe external ID (display ID) of this object. NULL means that the external ID is the same as the internal ID.string
checked_out_versionThe object version that is currently checked out, or zero if the object is not checked out.ObjVerVersion
checked_out_to_user_idThe ID of the user who has the object checked out.number
checked_out_to_user_nameThe user name of the user who has the object checked out.string
checked_out_to_host_nameThe host name of the computer to which the object was checked out.string
checked_out_at_utcThe timestamp of the moment the object was checked out.google.protobuf.Timestamp
checked_in_versionThe latest object version that is checked in, or uninitialized if the object has no checked-in version.ObjVerVersion
created_at_utcThe time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue).google.protobuf.Timestamp
accessed_by_me_utcAccessed 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.google.protobuf.Timestamp
guidObject GUID.string
optionsBit flags that provide additional information on the object (e.g. is the object deleted or a stub).ITEMFLAGS
original_vault_guidThe GUID of the vault in which the object was originally created.string
original_vault_obj_idThe original objid in the vault in which the object was originally created.ObjID
associated_view_idIdentifies the view associated with this object if any.ItemID
external_repository_icon_idIf not null, identifies the icon of the object. Currently applicable only to unmanaged objects.string
primary_view_idIf 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.ItemID
capabilitiesBit flags that provide information on the object capabilities.OBJECTCAPABILITYFLAGS

Example

{
"obj_id": {
"type": 0,
"item_id": {
"internal_id": 0,
"external_repository_id": {
"connection": "<!< The external repository connection identifier.>",
"item": "<item>"
}
}
},
"external_id_status": 5 /* Enum: ExtIDStatus */,
"external_id": "<external_id>",
"checked_out_version": {
"type": 7 /* Enum: ObjVerVersionType */,
"internal_version": 0,
"external_repository_version": "<external_repository_version>",
"external_repository_sort_key": 0
},
"checked_out_to_user_id": 0,
"checked_out_to_user_name": "<checked_out_to_user_name>",
"checked_out_to_host_name": "<checked_out_to_host_name>",
"checked_out_at_utc": {
"seconds": 0,
"nanos": 0
} /* google.protobuf.Timestamp */,
"checked_in_version": {} /* ObjVerVersion */,
"created_at_utc": {
"seconds": 0,
"nanos": 0
} /* google.protobuf.Timestamp */,
"accessed_by_me_utc": {
"seconds": 0,
"nanos": 0
} /* google.protobuf.Timestamp */,
"guid": "<!< Object GUID.>",
"options": {
"all": false,
"is_shortcut": false,
"is_deleted": false,
"is_accessed_by_valid": false,
"has_shared_files": false,
"is_conflict_object": false,
"is_normal": false,
"is_view": false,
"has_external_data": false,
"is_referred_external_object": false
},
"original_vault_guid": "<original_vault_guid>",
"original_vault_obj_id": {} /* ObjID */,
"associated_view_id": {} /* ItemID */,
"external_repository_icon_id": "<external_repository_icon_id>",
"primary_view_id": {} /* ItemID */,
"capabilities": {
"all": false,
"can_have_history": false,
"can_have_relationships": false,
"can_edit_old_versions": false,
"can_delete": false,
"can_destroy": false,
"can_undelete": false,
"can_rename": false,
"can_edit_metadata": false,
"can_edit_assignments": false,
"can_edit_workflows": false,
"can_edit_files": false,
"can_edit_version_comments": false,
"can_convert_single_multi_file": false,
"can_add_and_remove_files": false,
"can_change_file_type": false,
"can_change_permissions": false
}
}