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

Basic Information

Name

appmixer.box.core.UnlockFile

Version

1.0.0

Visibility

Public

Description

Removes a lock from a file, allowing other users to modify the file. This endpoint is used to unlock files that were previously locked.

Input Ports

in

Field	Type	Description
File ID	text	The unique identifier of the file to unlock

Output Ports

out

Field	Type	Description
ID		-
Type		-
Etag		-
Lock		-
Name		-
Description		-
Size		-
File Version		-
Created At		-
Modified At		-
Modified By		-
Owned By		-
Shared Link		-
Parent		-
Path Collection		-
Trashed At		-
Purged At		-
Content Created At		-
Content Modified At		-
Is Externally Owned		-
Has Collaborations		-
Is Package		-
Comment Count		-
Permissions		-
Tags		-
SHA1		-
Version Number		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.box.core.UnlockFile", "author": "Appmixer <info@appmixer.com>", "description": "Removes a lock from a file, allowing other users to modify the file. This endpoint is used to unlock files that were previously locked.", "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" } }, "required": [ "fileId" ] }, "inspector": { "inputs": { "fileId": { "type": "text", "tooltip": "The unique identifier of the file to unlock", "label": "File ID", "index": 0 } } } } ], "outPorts": [ { "name": "out", "options": [ { "label": "ID", "value": "id", "schema": { "type": "string", "example": "123456789" } }, { "label": "Type", "value": "type", "schema": { "type": "string", "example": "file" } }, { "label": "Etag", "value": "etag", "schema": { "type": "string", "example": "5" } }, { "label": "Lock", "value": "lock", "schema": { "type": "null", "example": null } }, { "label": "Name", "value": "name", "schema": { "type": "string", "example": "contract-draft.docx" } }, { "label": "Description", "value": "description", "schema": { "type": "string", "example": "Draft of the Q1 contract for review" } }, { "label": "Size", "value": "size", "schema": { "type": "number", "example": 524288 } }, { "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": "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": { "id": "33224455", "type": "user", "login": "john.smith@example.com", "name": "John Smith" }, "properties": { "id": { "type": "string", "title": "Modified By.Id" }, "type": { "type": "string", "title": "Modified By.Type" }, "login": { "type": "string", "title": "Modified By.Login" }, "name": { "type": "string", "title": "Modified By.Name" } } } }, { "label": "Owned By", "value": "owned_by", "schema": { "type": "object", "example": { "id": "33224455", "type": "user", "login": "john.smith@example.com", "name": "John Smith" }, "properties": { "id": { "type": "string", "title": "Owned By.Id" }, "type": { "type": "string", "title": "Owned By.Type" }, "login": { "type": "string", "title": "Owned By.Login" }, "name": { "type": "string", "title": "Owned By.Name" } } } }, { "label": "Shared Link", "value": "shared_link", "schema": { "type": "null", "example": null } }, { "label": "Parent", "value": "parent", "schema": { "type": "object", "example": { "id": "11446498", "type": "folder" }, "properties": { "id": { "type": "string", "title": "Parent.Id" }, "type": { "type": "string", "title": "Parent.Type" } } } }, { "label": "Path Collection", "value": "path_collection", "schema": { "type": "object", "example": { "total_count": 2, "entries": [ { "id": "0", "type": "folder", "name": "All Files" }, { "id": "11446498", "type": "folder", "name": "Contracts" } ] }, "properties": { "total_count": { "type": "number", "title": "Path Collection.Total Count" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "title": "Path Collection.Entries.Id" }, "type": { "type": "string", "title": "Path Collection.Entries.Type" }, "name": { "type": "string", "title": "Path Collection.Entries.Name" } } }, "title": "Path Collection.Entries" } } } }, { "label": "Trashed At", "value": "trashed_at", "schema": { "type": "null", "example": null } }, { "label": "Purged At", "value": "purged_at", "schema": { "type": "null", "example": null } }, { "label": "Content Created At", "value": "content_created_at", "schema": { "type": "string", "example": "2024-01-15T10:30:00-08:00" } }, { "label": "Content Modified At", "value": "content_modified_at", "schema": { "type": "string", "example": "2024-02-20T14:45:00-08:00" } }, { "label": "Is Externally Owned", "value": "is_externally_owned", "schema": { "type": "boolean", "example": false } }, { "label": "Has Collaborations", "value": "has_collaborations", "schema": { "type": "boolean", "example": false } }, { "label": "Is Package", "value": "is_package", "schema": { "type": "boolean", "example": false } }, { "label": "Comment Count", "value": "comment_count", "schema": { "type": "number", "example": 0 } }, { "label": "Permissions", "value": "permissions", "schema": { "type": "null", "example": null } }, { "label": "Tags", "value": "tags", "schema": { "type": "array", "example": [], "items": {} } }, { "label": "SHA1", "value": "sha1", "schema": { "type": "string", "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709" } }, { "label": "Version Number", "value": "version_number", "schema": { "type": "string", "example": "3" } } ] } ], "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNTAwIiBoZWlnaHQ9IjEzNzkiIHZpZXdCb3g9IjAgMCA0NDQuODkzIDI0NS40MTQiPjxnIGZpbGw9IiMwMDc1QzkiPjxwYXRoIGQ9Ik0yMzkuMDM4IDcyLjQzYy0zMy4wODEgMC02MS44MDYgMTguNi03Ni4zMjIgNDUuOTA0LTE0LjUxNi0yNy4zMDUtNDMuMjQtNDUuOTAyLTc2LjMyLTQ1LjkwMi0xOS40NDMgMC0zNy4zODUgNi40MjQtNTEuODIxIDE3LjI2NlYxNi45MjVoLS4wMDhDMzQuMzY1IDcuNTQ3IDI2LjcxMyAwIDE3LjI4NiAwIDcuODU4IDAgLjIwOCA3LjU0Ny4wMDggMTYuOTI1SDB2MTQzLjMzM2guMDM2Yy43NjggNDcuMDUxIDM5LjEyNSA4NC45NjcgODYuMzU5IDg0Ljk2NyAzMy4wOCAwIDYxLjgwNS0xOC42MDMgNzYuMzItNDUuOTA4IDE0LjUxNyAyNy4zMDcgNDMuMjQxIDQ1LjkwNiA3Ni4zMjEgNDUuOTA2IDQ3LjcxNSAwIDg2LjM5Ni0zOC42ODQgODYuMzk2LTg2LjM5Ni4wMDEtNDcuNzE4LTM4LjY4Mi04Ni4zOTctODYuMzk0LTg2LjM5N3pNODYuMzk1IDIxMC42NDhjLTI4LjYyMSAwLTUxLjgyMS0yMy4yMDEtNTEuODIxLTUxLjgyIDAtMjguNjIzIDIzLjIwMS01MS44MjMgNTEuODIxLTUxLjgyMyAyOC42MjEgMCA1MS44MjIgMjMuMiA1MS44MjIgNTEuODIzIDAgMjguNjE5LTIzLjIwMSA1MS44Mi01MS44MjIgNTEuODJ6bTE1Mi42NDMgMGMtMjguNjIyIDAtNTEuODIxLTIzLjIwMS01MS44MjEtNTEuODIyIDAtMjguNjIzIDIzLjItNTEuODIxIDUxLjgyMS01MS44MjEgMjguNjE5IDAgNTEuODIyIDIzLjE5OCA1MS44MjIgNTEuODIxLS4wMDEgMjguNjIxLTIzLjIwMyA1MS44MjItNTEuODIyIDUxLjgyMnoiLz48cGF0aCBkPSJNNDQxLjY1MSAyMTguMDMzbC00NC4yNDYtNTkuMTQzIDQ0LjI0Ni01OS4xNDQtLjAwOC0uMDA3YzUuNDczLTcuNjIgMy44ODctMTguMjQ5LTMuNjUyLTIzLjkxMy03LjUzNy01LjY1OC0xOC4xODctNC4yMjEtMjMuOTggMy4xNTdsLS4wMDQtLjAwMi0zOC4xODggNTEuMDQ3LTM4LjE4OC01MS4wNDctLjAwNi4wMDljLTUuNzkzLTcuMzg1LTE2LjQ0MS04LjgyMi0yMy45ODEtMy4xNi03LjUzOSA1LjY2NC05LjEyNSAxNi4yOTMtMy42NDkgMjMuOTExbC0uMDA4LjAwNSA0NC4yNDUgNTkuMTQ0LTQ0LjI0NSA1OS4xNDMuMDA4LjAwNWMtNS40NzcgNy42Mi0zLjg5IDE4LjI0NyAzLjY0OSAyMy45MDkgNy41NCA1LjY2NCAxOC4xODggNC4yMjUgMjMuOTgxLTMuMTU1bC4wMDYuMDA3IDM4LjE4OC01MS4wNDkgMzguMTg4IDUxLjA0OS4wMDQtLjAwMmM1Ljc5NCA3LjM3NyAxNi40NDMgOC44MTQgMjMuOTggMy4xNTQgNy41MzktNS42NjIgOS4xMjUtMTYuMjkxIDMuNjUyLTIzLjkxbC4wMDgtLjAwOHoiLz48L2c+PC9zdmc+" }