Lock File

Files can be locked to prevent another user from editing a files while it is being worked on. When a file is locked, other actors will be prevented from deleting or creating a new version of a file. Other actions such as modifying metadata or moving the file are allowed on locked files.

Only regular files can be locked. Support Files and Folders cannot be locked.

Request

POST {baseUrl}/spaces/{spaceId}/files/{fileId}/lock?complete=true

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • reason - Reason to lock the file (optional)

Example request body:

{
    "reason": "To work on this file"
}

Response

Example response:

{
    "id": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
    "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
    "name": "FileName.ext",
    "acl": {
        "contentManager": [
        "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1",
        "trn:tid:user:7529d0b3-5856-41ab-88b3-86f7955cddf1"
        ],
        "contentContributor": [
        "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
        "trn:tid:application:e28982f5-ebd8-4a76-97f4-0783fc143f31"
        ],
        "contentViewer": [
        "trn:tid:device:8529d0b3-5856-41ab-88b3-86f7955cddf1"
        ]
    },
    "createdAt": "2023-05-30T10:30:00Z",
    "createdByTrn": "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
    "updatedAt": "2023-05-30T10:30:00Z",
    "updatedByTrn": "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7",
    "deleted": false,
    "parentId": "e492c129-141d-4679-b0a7-829580679b6a",
    "path": "testA/testB/",
    "version": "1.2",
    "fileset": false,
    "restrictedAccess": false,
    "expiresAt": "2024-01-01T12:25:00.000Z",
    "lock": {
        "locked_at": "2023-05-30T10:30:00Z",
        "locked_by": "trn:tid:application:f85bc802-5481-4581-b972-c4652d595ec7"
        "reason": "To work on this file"
    }
    "metadata": {
        "language": "Suomi"
    },
    "download": {
        "url": "https://example.com/download/12345678-90ab-cdef-1234-567890abcdef.1"
    },
    "multipart": false,
    "responseHeaders": {
        "response-content-type": "image/jpeg",
        "response-content-disposition": "inline",
        "response-cache-control": "max-age=3000"
    },
    "malwareScanStatus": "CLEAN",
    "lastMalwareScanDate": "2023-05-30T10:30:00Z",
    "size": 1024
}

To know more about the lock file API refer here.