Lock the document so the document cannot be updated by other users.
HTTP request
POST https://contentwarehouse.googleapis.com/v1/{name}:lock
Path parameters
| Parameters | |
|---|---|
name
|
Required. The name of the document to lock. Format: projects/{projectNumber}/locations/{location}/documents/{document}. It takes the form |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{
"collectionId"
:
string
,
"lockingUser"
:
{
object (
|
| Fields | |
|---|---|
collectionId
|
The collection the document connects to. |
lockingUser
|
The user information who locks the document. |
Response body
If successful, the response body contains an instance of Document
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM
permission on the name
resource:
-
contentwarehouse.documents.update
For more information, see the IAM documentation .

