IRPCWOPIOperationsPublic.WOPIFileCheckOut

Server integration API / specialized internal: not for applications write no session

Checks out the object of a read-only WOPI user session and turns the session into an editing session.

Service	WOPI operations (anonymous) `MFiles.IRPCWOPIOperationsPublic`
gRPC method	`/MFiles.IRPCWOPIOperationsPublic/WOPIFileCheckOut`
HTTP (mf-http-grpc)	`POST /grpc/v1/wopifile-check-out`
Request	`WOPIFileCheckOutRequest`
Response	`WOPIFileCheckOutResponse`
Book and level	Server integration API, specialized
Kind	write
Session	Not needed: the call can be made before logging in.
Idempotent	no
Returns metadata structure version	no
Streaming	none (unary)

Remarks

For M-Files components only. M-Files clients call it when the user switches from viewing to editing in Office for the web. Applications should not call it.

Changes the object: checks it out to the user of the session that created the token, creates a SHARED_LINK_TYPE_WOPIEDIT link to the new version and points the WOPI user session at it.
Works only for a session created with WOPIACTION_TYPE_VIEW; other sessions fail with access denied.

Request: WOPIFileCheckOutRequest

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
`key`	`string`	The WOPI user session token.

Response: WOPIFileCheckOutResponse

No fields.