Edit

lockInfo resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

The lockInfo resource provides read-only lock metadata for a file. It indicates whether a file is locked, the kind of lock that is held, when the lock was created, when it expires, and which users currently hold the lock.

It is available on the lockInfo property of the file facet on a driveItem.

Properties

Property Type Description
createdDateTime DateTimeOffset The date and time when the lock was created, in UTC. Read-only.
expirationDateTime DateTimeOffset The date and time when the lock expires, in UTC. Read-only.
lockType lockType The type of lock currently held on the file. The possible values are: none, exclusive, shared, unknownFutureValue. Read-only.
owners Collection(userIdentity) The collection of users that currently hold the lock on the file. Read-only.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.lockInfo",
  "lockType": "String",
  "createdDateTime": "String (timestamp)",
  "expirationDateTime": "String (timestamp)",
  "owners": [
    { "@odata.type": "microsoft.graph.userIdentity" }
  ]
}

Remarks

For more information about the facets on a driveItem, see driveItem.