IRPCEventsAdmin.GetEvents
Administration API / specialized admin session
Gets all events of the vault.
| Service | Event administration MFiles.IRPCEventsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCEventsAdmin/GetEvents |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-events |
| Request | GetEventsRequest |
| Response | GetEventsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Prefer GetEventsRange: it pages and filters.
- In M-Files Server 26.11 the call fails with a database error ("Failed to prepare the SQL statement."). Use GetEventsRange.
- Requires a vault session, the vault right
manage_events, andclient_data.versionset at login (see the service overview). Fails with "Your event log request exceeds the maximum data size." when the log is large.
Request: GetEventsRequest
No fields.
Response: GetEventsResponse
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 |
|---|---|---|
values[] | repeated Event | The events, newest first. See Event. |
values[].id | int64 | The ID of the event. |
values[].type | EventType | The type of the event. |
values[].category | EventCategory | The category of the event.Values: EVENT_CATEGORY_UNDEFINED (0), EVENT_CATEGORY_FILE_ACCESS (1), EVENT_CATEGORY_OBJECT_CHANGE (2), EVENT_CATEGORY_NEW_OBJECT (3), EVENT_CATEGORY_OBJECT_OPERATION (4), EVENT_CATEGORY_SYSTEM (5), EVENT_CATEGORY_REQUEST (6), EVENT_CATEGORY_METADATA_STRUCTURE_CHANGE (7), EVENT_CATEGORY_PUBLIC_LINK (8), EVENT_CATEGORY_CUSTOM_EVENT (9). |
values[].timestamp_utc | google.protobuf.Timestamp | The timestamp of this event. |
values[].caused_by_user | string | The account name of the user whose activity lead to this event. If no user (this is a system operation), this is an empty string. |
values[].caused_by_user_full_name | string | The full name of the user whose activity lead to this event. If no user (this is a system operation), this is an empty string. |
values[].caused_by_user_id | int32 | The ID of the user account whose activity lead to this event. If no user (this is a system operation), this is zero. |
values[].data | EventTypeSpecificDataUnion | Additional event type -specific data as a union. |
values[].data.file_accessed | EventTypeSpecificDataUnion.FileAccessedData (oneof data) | |
values[].data.object_changed | EventTypeSpecificDataUnion.ObjectChangedData (oneof data) | |
values[].data.object_created | BasicDocVerInfo (oneof data) | |
values[].data.rolled_back | EventTypeSpecificDataUnion.RolledBackData (oneof data) | |
values[].data.checked_out | BasicDocVerInfo (oneof data) | |
values[].data.checked_in | BasicDocVerInfo (oneof data) | |
values[].data.checkout_undone | BasicDocVerInfo (oneof data) | |
values[].data.object_deleted | BasicDocInfo (oneof data) | |
values[].data.object_version_destroyed | BasicDocVerInfo (oneof data) | |
values[].data.object_destroyed | BasicDocInfo (oneof data) | |
values[].data.logged_in | EventTypeSpecificDataUnion.LoggedInData (oneof data) | |
values[].data.logged_out | EventTypeSpecificDataUnion.LoggedOutData (oneof data) | |
values[].data.backup_started | EventTypeSpecificDataUnion.BackupStartedData (oneof data) | |
values[].data.backup_completed | EventTypeSpecificDataUnion.BackupCompletedData (oneof data) | |
values[].data.check_in_requested | BasicDocInfo (oneof data) | |
values[].data.assigned | EventTypeSpecificDataUnion.AssignedData (oneof data) | |
values[].data.free_request | EventTypeSpecificDataUnion.FreeRequestData (oneof data) | |
values[].data.assigned_to | BasicDocVerInfo (oneof data) | |
values[].data.completed_by | BasicDocVerInfo (oneof data) | |
values[].data.assignment_approved_by | BasicDocVerInfo (oneof data) | |
values[].data.assignment_rejected_by | BasicDocVerInfo (oneof data) | |
values[].data.state_changed | BasicDocVerInfo (oneof data) | |
values[].data.object_notification | EventTypeSpecificDataUnion.ObjectNotificationData (oneof data) | |
values[].data.object_undeleted | BasicDocInfo (oneof data) | Information on the concerned object. |
values[].data.user_added | BasicUserAccountInfo (oneof data) | Information on the concerned user account. |
values[].data.user_changed | BasicUserAccountInfo (oneof data) | Information on the concerned user account. |
values[].data.user_deleted | BasicUserAccountInfo (oneof data) | Information on the concerned user account. |
values[].data.user_group_added | BasicUserGroupInfo (oneof data) | Information on the concerned user group. |
values[].data.user_group_changed | BasicUserGroupInfo (oneof data) | Information on the concerned user group. |
values[].data.user_group_deleted | BasicUserGroupInfo (oneof data) | Information on the concerned user group. |
values[].data.event_log_exported | EventTypeSpecificDataUnion.EventLogExportedData (oneof data) | |
values[].data.event_log_cleared | EventTypeSpecificDataUnion.EventLogClearedData (oneof data) | |
values[].data.vault_restored | VaultBasic (oneof data) | The basic definition of the concerned vault. |
values[].data.vault_created | VaultBasic (oneof data) | The basic definition of the concerned vault. |
values[].data.state_transition_signature_settings_added | StateTransitionSignatureSettingsForEvents (oneof data) | The concerned workflow state transition settings. |
values[].data.state_transition_signature_settings_changed | StateTransitionSignatureSettingsForEvents (oneof data) | The concerned workflow state transition settings. |
values[].data.state_transition_signature_settings_removed | StateTransitionSignatureSettingsForEvents (oneof data) | The concerned workflow state transition settings. |
values[].data.vault_variable_changed | EventTypeSpecificDataUnion.VaultVariableChangedData (oneof data) | |
values[].data.vault_copied | EventTypeSpecificDataUnion.VaultCopiedData (oneof data) | |
values[].data.license_prevented_advanced_event_log | EventTypeSpecificDataUnion.LicensePreventedAdvancedEventLogData (oneof data) | |
values[].data.public_link_created | EventTypeSpecificDataUnion.PublicLinkCreatedData (oneof data) | |
values[].data.public_link_file_downloaded | EventTypeSpecificDataUnion.PublicLinkFileDownloadedData (oneof data) | |
values[].data.public_link_deleted | EventTypeSpecificDataUnion.PublicLinkDeletedData (oneof data) | |
values[].data.public_link_accessed | EventTypeSpecificDataUnion.PublicLinkAccessedData (oneof data) | |
values[].data.conflict_resolved_in_favor_of_incoming_changes | EventTypeSpecificDataUnion.ConflictResolvedInFavorOfIncomingChangesData (oneof data) | |
values[].data.conflict_resolved_in_favor_of_local_changes | EventTypeSpecificDataUnion.ConflictResolvedInFavorOfLocalChangesData (oneof data) | |
values[].data.discarded_conflict_changes_restored_as_new_version | EventTypeSpecificDataUnion.DiscardedConflictChangesRestoredAsNewVersionData (oneof data) | |
values[].data.user_mentioned_in_comment | BasicDocVerInfo (oneof data) | |
values[].data.vault_login_account_added | BasicVaultLoginAccountInfo (oneof data) | Information on the concerned vault login account. |
values[].data.vault_login_account_changed | BasicVaultLoginAccountInfo (oneof data) | Information on the concerned vault login account. |
values[].data.vault_login_account_deleted | BasicVaultLoginAccountInfo (oneof data) | Information on the concerned vault login account. |
values[].data.external_link_access_type_changed | ExternalLinkEventData (oneof data) | Shared-link data for the access-type-changed event. |
values[].data.external_link_anyone_with_link_expiration_updated | ExternalLinkEventData (oneof data) | Shared-link data for the anyone-with-the-link expiration-updated event. |
values[].data.external_link_visitors_added | ExternalLinkEventData (oneof data) | Shared-link data for the visitors-added event. |
values[].data.external_link_visitors_removed | ExternalLinkEventData (oneof data) | Shared-link data for the visitors-removed event. |
values[].data.external_link_visitor_expiration_updated | ExternalLinkEventData (oneof data) | Shared-link data for the visitor expiration-updated event. |
values[].data.external_link_accessed_by_visitor | ExternalLinkEventData (oneof data) | Shared-link data for the accessed-by-visitor event. |
values[].data.external_link_manage_visitors_viewed | ExternalLinkEventData (oneof data) | Shared-link data for the manage-visitors-dialog-viewed event. |
values[].data.external_link_visitors_viewed | ExternalLinkEventData (oneof data) | Shared-link data for the visitors-viewed event. |
values[].notification_created | bool | Tells if the notifications have been created. |
values[].notification_object_info | DocumentInfoForNotifications | Document info. This is valid only until the notifications have been created. |
values[].notification_object_info.object_info | ObjectVersionEx | Document information. |
values[].notification_object_info.properties[] | repeated PropertyValue | Document properties. |
values[].notification_object_info.acl | ACLWithNames | Document access control list. |
values[].notification_object_info.old_properties[] | repeated PropertyValue | Old document properties. Used with some events only. |
values[].notification_object_info.old_acl | ACLWithNames | Document access control list. Used with some events only. |
values[].notification_object_info.property_acls[] | repeated PVACL | ACLs for property values. |
values[].notification_object_info.old_property_acls[] | repeated PVACL | ACLs for old property values. |
values[].notification_object_info.translated_lookup_names[] | repeated ItemNames | Translated names for lookups. |
values[].xml_data | string | The data represented in XML. |
Related methods
- GetEventsRange -- Gets events by ID range and filters, oldest or newest first, with an optional maximum count.