PUT api/Document/Lock

Lock or unlock the requested document.

Request Information

URI Parameters

None.

Body Parameters

LockDocumentRequest
Name Description Type Additional information
ArchiveGuid

string

None.
DocId

integer

None.
ShouldLock

boolean

None.
Token

Token

None.

Request Formats

application/json, text/json

Sample: 
{
  "ArchiveGuid": "sample string 1",
  "DocId": 2,
  "ShouldLock": true,
  "Token": {
    "OrgId": 1,
    "OrgGuid": "sample string 2",
    "UserId": 3,
    "UserGuid": "sample string 4",
    "Username": "sample string 5",
    "UserNumber": "sample string 6",
    "EMail": "sample string 7",
    "CreatedAt": "2026-09-15T11:35:18.7008767+02:00",
    "ValidTo": "2026-09-15T11:35:18.7008767+02:00",
    "Realm": "sample string 10",
    "IsDelegated": true,
    "AccessKey": "sample string 12"
  }
}

application/bson

Sample: 
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

application/bson

Sample: 
Binary JSON content. See http://bsonspec.org for details.