IRPCEvents.CreateEventFreeRequest
Vault API / standard write session returns metadata structure version
Sends a request with a free-text message to users and groups. Used by M-Files clients; applications rarely call it.
| Service | Events and notifications MFiles.IRPCEvents |
|---|---|
| gRPC method | /MFiles.IRPCEvents/CreateEventFreeRequest |
| HTTP (mf-http-grpc) | POST /grpc/v1/create-event-free-request |
| Request | CreateEventFreeRequestRequest |
| Response | CreateEventFreeRequestResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session; anonymous sessions get "Access denied.".
- The request is recorded as an
EVENT_TYPE_FREE_REQUESTevent addressed to the recipients (groups are expanded to their members), only if the vault's event log configuration records that event type. The recipients are notified by e-mail when notifications are enabled.
Request: CreateEventFreeRequestRequest
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 |
|---|---|---|
text | string | The message of the request. |
users[] | repeated int32 | The IDs of the recipient user accounts. |
groups[] | repeated int32 | The IDs of the recipient user groups. |
Response: CreateEventFreeRequestResponse
No fields.