IRPCEvents.CreateEventCheckInRequest
Vault API / standard write session returns metadata structure version
Asks the user who has an object checked out to check it in. Used by M-Files clients; applications rarely call it.
| Service | Events and notifications MFiles.IRPCEvents |
|---|---|
| gRPC method | /MFiles.IRPCEvents/CreateEventCheckInRequest |
| HTTP (mf-http-grpc) | POST /grpc/v1/create-event-check-in-request |
| Request | CreateEventCheckInRequestRequest |
| Response | CreateEventCheckInRequestResponse |
| 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. No special vault rights are needed.
- The request goes to the user who has the latest version checked out. If the object is not checked out, or event logging is disabled in the vault, the call succeeds and does nothing.
- The recipient is notified by e-mail when notifications are enabled.
Request: CreateEventCheckInRequestRequest
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 |
|---|---|---|
objid | ObjID | The object that should be checked in. |
objid.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). |
objid.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
objid.item_id.internal_id | int32 | The ID of the object or value list item. |
objid.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
Response: CreateEventCheckInRequestResponse
No fields.