IRPCEventsAdmin.SaveEventLogFilter
Administration API / specialized admin session idempotent
Saves a named event log filter for the calling user.
| Service | Event administration MFiles.IRPCEventsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCEventsAdmin/SaveEventLogFilter |
| HTTP (mf-http-grpc) | POST /grpc/v1/save-event-log-filter |
| Request | SaveEventLogFilterRequest |
| Response | SaveEventLogFilterResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session with a user account in the vault and the vault right
manage_events. - Filters are private to the user who saves them. A name that the user already has fails with "There is already a filtered view with the same name.", so repeating the call is not safe.
- The server assigns the ID and records the caller as creator;
idandcreated_by_user_accountin the request are ignored. Withdefault_filter_viewtrue, the user's previous default filter stops being the default.
Request: SaveEventLogFilterRequest
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 |
|---|---|---|
event_log_filter | EventLogFilter | The filter to save: name, condition and default_filter_view. See EventLogFilter. |
event_log_filter.id | int64 | ID of the Event Log Filter record. |
event_log_filter.name | string | Name of the Event Log Filter record. |
event_log_filter.created_by_user_account | int32 | The account ID of the user who created the record |
event_log_filter.condition | EventLogFilterCondition | Information about the search conditions. |
event_log_filter.condition.object_type | int32 | Object Type in Filter View. |
event_log_filter.condition.object_id | string | Object ID in Filter View. |
event_log_filter.condition.object_name | string | Object Name in Filter View. |
event_log_filter.condition.object_class | int32 | Object Class in Filter View. |
event_log_filter.condition.event_types | EventTypeArray | Event Types in Filter View. |
event_log_filter.condition.event_caused_by_user | string | User name in Filter View. |
event_log_filter.condition.start_time | google.protobuf.Timestamp | Start time in Filter View. |
event_log_filter.condition.end_time | google.protobuf.Timestamp | End time in Filter View. |
event_log_filter.default_filter_view | bool | Tells if the Event Log Filter record was set as Default Filter View. |
Response: SaveEventLogFilterResponse
No fields.