box: appmixer.box.core.LockFile – Appmixer connector library

Basic Information

Name

appmixer.box.core.LockFile

Version

1.0.0

Visibility

Public

Description

Lock a file to prevent other users from modifying it. When a file is locked, only the user who locked it can make changes to the file until the lock is released.

Input Ports

in

Field	Type	Description
File ID	text	The unique identifier of the file to lock. This is a required parameter that identifies which file should be locked.
Lock Expires At	date-time	The ISO 8601 formatted date and time when the lock will automatically expire. Optional parameter. If not provided, the lock will remain until manually released.

Output Ports

out

Field	Type	Description
ID		-
Type		-
Name		-
File Version		-
Lock		-
Created At		-
Modified At		-
Modified By		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.box.core.LockFile", "author": "Appmixer <info@appmixer.com>", "description": "Lock a file to prevent other users from modifying it. When a file is locked, only the user who locked it can make changes to the file until the lock is released.", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:box" }, "quota": { "manager": "appmixer:box", "resources": "requests" }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "fileId": { "type": "string" }, "lockExpiresAt": { "type": "string", "format": "date-time" } }, "required": [ "fileId" ] }, "inspector": { "inputs": { "fileId": { "type": "text", "tooltip": "The unique identifier of the file to lock. This is a required parameter that identifies which file should be locked.", "label": "File ID", "index": 0 }, "lockExpiresAt": { "type": "date-time", "tooltip": "The ISO 8601 formatted date and time when the lock will automatically expire. Optional parameter. If not provided, the lock will remain until manually released.", "label": "Lock Expires At", "index": 1 } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "ID", "value": "id", "schema": { "type": "string", "example": "123456789" } }, { "label": "Type", "value": "type", "schema": { "type": "string", "example": "file" } }, { "label": "Name", "value": "name", "schema": { "type": "string", "example": "contract-draft.docx" } }, { "label": "File Version", "value": "file_version", "schema": { "type": "object", "example": { "id": "55667788", "type": "file_version" }, "properties": { "id": { "type": "string", "title": "File Version ID" }, "type": { "type": "string", "title": "File Version Type" } } } }, { "label": "Lock", "value": "lock", "schema": { "type": "object", "example": { "type": "lock", "id": "77889900", "created_by": { "type": "user", "id": "33224455", "name": "John Smith", "login": "john.smith@example.com" }, "created_at": "2024-03-01T09:00:00-08:00", "expires_at": "2024-03-08T09:00:00-08:00" }, "properties": { "type": { "type": "string", "title": "Lock Type" }, "id": { "type": "string", "title": "Lock ID" }, "created_by": { "type": "object", "properties": { "type": { "type": "string", "title": "Lock Created By Type" }, "id": { "type": "string", "title": "Lock Created By ID" }, "name": { "type": "string", "title": "Lock Created By Name" }, "login": { "type": "string", "title": "Lock Created By Login" } }, "title": "Lock Created By" }, "created_at": { "type": "string", "title": "Lock Created At" }, "expires_at": { "type": "string", "title": "Lock Expires At" } } } }, { "label": "Created At", "value": "created_at", "schema": { "type": "string", "example": "2024-01-15T10:30:00-08:00" } }, { "label": "Modified At", "value": "modified_at", "schema": { "type": "string", "example": "2024-03-01T09:00:00-08:00" } }, { "label": "Modified By", "value": "modified_by", "schema": { "type": "object", "example": { "type": "user", "id": "33224455", "name": "John Smith", "login": "john.smith@example.com" }, "properties": { "type": { "type": "string", "title": "Modified By Type" }, "id": { "type": "string", "title": "Modified By ID" }, "name": { "type": "string", "title": "Modified By Name" }, "login": { "type": "string", "title": "Modified By Login" } } } } ] } ], "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNTAwIiBoZWlnaHQ9IjEzNzkiIHZpZXdCb3g9IjAgMCA0NDQuODkzIDI0NS40MTQiPjxnIGZpbGw9IiMwMDc1QzkiPjxwYXRoIGQ9Ik0yMzkuMDM4IDcyLjQzYy0zMy4wODEgMC02MS44MDYgMTguNi03Ni4zMjIgNDUuOTA0LTE0LjUxNi0yNy4zMDUtNDMuMjQtNDUuOTAyLTc2LjMyLTQ1LjkwMi0xOS40NDMgMC0zNy4zODUgNi40MjQtNTEuODIxIDE3LjI2NlYxNi45MjVoLS4wMDhDMzQuMzY1IDcuNTQ3IDI2LjcxMyAwIDE3LjI4NiAwIDcuODU4IDAgLjIwOCA3LjU0Ny4wMDggMTYuOTI1SDB2MTQzLjMzM2guMDM2Yy43NjggNDcuMDUxIDM5LjEyNSA4NC45NjcgODYuMzU5IDg0Ljk2NyAzMy4wOCAwIDYxLjgwNS0xOC42MDMgNzYuMzItNDUuOTA4IDE0LjUxNyAyNy4zMDcgNDMuMjQxIDQ1LjkwNiA3Ni4zMjEgNDUuOTA2IDQ3LjcxNSAwIDg2LjM5Ni0zOC42ODQgODYuMzk2LTg2LjM5Ni4wMDEtNDcuNzE4LTM4LjY4Mi04Ni4zOTctODYuMzk0LTg2LjM5N3pNODYuMzk1IDIxMC42NDhjLTI4LjYyMSAwLTUxLjgyMS0yMy4yMDEtNTEuODIxLTUxLjgyIDAtMjguNjIzIDIzLjIwMS01MS44MjMgNTEuODIxLTUxLjgyMyAyOC42MjEgMCA1MS44MjIgMjMuMiA1MS44MjIgNTEuODIzIDAgMjguNjE5LTIzLjIwMSA1MS44Mi01MS44MjIgNTEuODJ6bTE1Mi42NDMgMGMtMjguNjIyIDAtNTEuODIxLTIzLjIwMS01MS44MjEtNTEuODIyIDAtMjguNjIzIDIzLjItNTEuODIxIDUxLjgyMS01MS44MjEgMjguNjE5IDAgNTEuODIyIDIzLjE5OCA1MS44MjIgNTEuODIxLS4wMDEgMjguNjIxLTIzLjIwMyA1MS44MjItNTEuODIyIDUxLjgyMnoiLz48cGF0aCBkPSJNNDQxLjY1MSAyMTguMDMzbC00NC4yNDYtNTkuMTQzIDQ0LjI0Ni01OS4xNDQtLjAwOC0uMDA3YzUuNDczLTcuNjIgMy44ODctMTguMjQ5LTMuNjUyLTIzLjkxMy03LjUzNy01LjY1OC0xOC4xODctNC4yMjEtMjMuOTggMy4xNTdsLS4wMDQtLjAwMi0zOC4xODggNTEuMDQ3LTM4LjE4OC01MS4wNDctLjAwNi4wMDljLTUuNzkzLTcuMzg1LTE2LjQ0MS04LjgyMi0yMy45ODEtMy4xNi03LjUzOSA1LjY2NC05LjEyNSAxNi4yOTMtMy42NDkgMjMuOTExbC0uMDA4LjAwNSA0NC4yNDUgNTkuMTQ0LTQ0LjI0NSA1OS4xNDMuMDA4LjAwNWMtNS40NzcgNy42Mi0zLjg5IDE4LjI0NyAzLjY0OSAyMy45MDkgNy41NCA1LjY2NCAxOC4xODggNC4yMjUgMjMuOTgxLTMuMTU1bC4wMDYuMDA3IDM4LjE4OC01MS4wNDkgMzguMTg4IDUxLjA0OS4wMDQtLjAwMmM1Ljc5NCA3LjM3NyAxNi40NDMgOC44MTQgMjMuOTggMy4xNTQgNy41MzktNS42NjIgOS4xMjUtMTYuMjkxIDMuNjUyLTIzLjkxbC4wMDgtLjAwOHoiLz48L2c+PC9zdmc+" }