box.json•16.2 kB
{
"nodeType": "n8n-nodes-base.box",
"displayName": "Box",
"description": "Consume Box API",
"version": 1,
"properties": [
{
"name": "fileId",
"displayName": "File ID",
"type": "string",
"default": "",
"required": true,
"displayOptions": {
"show": {
"operation": [
"copy"
],
"resource": [
"file"
]
}
}
},
{
"name": "parentId",
"displayName": "Parent ID",
"type": "string",
"default": "",
"description": "The ID of folder to copy the file to. If not defined will be copied to the root folder.",
"displayOptions": {
"show": {
"operation": [
"copy"
],
"resource": [
"file"
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.",
"placeholder": "Add Field",
"options": [
{
"name": "fields",
"displayName": "Fields",
"type": "string",
"default": "",
"description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "An optional new name for the copied file"
},
{
"name": "version",
"displayName": "Version",
"type": "string",
"default": "",
"description": "An optional ID of the specific file version to copy"
}
],
"displayOptions": {
"show": {
"operation": [
"copy"
],
"resource": [
"file"
]
}
}
},
{
"name": "binaryPropertyName",
"displayName": "Put Output File in Field",
"type": "string",
"default": "data",
"required": true,
"displayOptions": {
"show": {
"operation": [
"download"
],
"resource": [
"file"
]
}
}
},
{
"name": "query",
"displayName": "Query",
"type": "string",
"default": "",
"description": "The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types.",
"displayOptions": {
"show": {
"operation": [
"search"
],
"resource": [
"file"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"operation": [
"search"
],
"resource": [
"file"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 100,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 500
},
"displayOptions": {
"show": {
"operation": [
"search"
],
"resource": [
"file"
],
"returnAll": [
false
]
}
}
},
{
"name": "accessibleBy",
"displayName": "Accessible By",
"type": "options",
"default": "",
"description": "The type of object the file will be shared with",
"options": [
{
"name": "Group",
"value": "group"
},
{
"name": "User",
"value": "user"
}
],
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
]
}
}
},
{
"name": "useEmail",
"displayName": "Use Email",
"type": "boolean",
"default": true,
"description": "Whether identify the user by email or ID",
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
],
"accessibleBy": [
"user"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "The user's email address to share the file with",
"placeholder": "name@email.com",
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
],
"useEmail": [
true
],
"accessibleBy": [
"user"
]
}
}
},
{
"name": "userId",
"displayName": "User ID",
"type": "string",
"default": "",
"description": "The user's ID to share the file with",
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
],
"useEmail": [
false
],
"accessibleBy": [
"user"
]
}
}
},
{
"name": "groupId",
"displayName": "Group ID",
"type": "string",
"default": "",
"description": "The group's ID to share the file with",
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
],
"accessibleBy": [
"group"
]
}
}
},
{
"name": "role",
"displayName": "Role",
"type": "options",
"default": "editor",
"description": "A Co-owner has all of functional read/write access that an editor does",
"options": [
{
"name": "Co-Owner",
"value": "coOwner",
"description": "A Co-owner has all of functional read/write access that an editor does"
},
{
"name": "Editor",
"value": "editor",
"description": "An editor has full read/write access to a folder or file"
},
{
"name": "Previewer",
"value": "previewer",
"description": "A previewer has limited read access"
},
{
"name": "Previewer Uploader",
"value": "previewerUploader",
"description": "This access level is a combination of Previewer and Uploader"
},
{
"name": "Uploader",
"value": "uploader",
"description": "An uploader has limited write access"
},
{
"name": "Viewer",
"value": "viewer",
"description": "A viewer has read access to a folder or file"
},
{
"name": "Viewer Uploader",
"value": "viewerUploader",
"description": "This access level is a combination of Viewer and Uploader"
}
],
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Whether the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore cannot see content the user is not collaborated on.",
"placeholder": "Add option",
"options": [
{
"name": "can_view_path",
"displayName": "Can View Path",
"type": "boolean",
"default": false,
"description": "Whether the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore cannot see content the user is not collaborated on."
},
{
"name": "expires_at",
"displayName": "Expires At",
"type": "dateTime",
"default": "",
"description": "Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item."
},
{
"name": "fields",
"displayName": "Fields",
"type": "string",
"default": "",
"description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
},
{
"name": "notify",
"displayName": "Notify",
"type": "boolean",
"default": false,
"description": "Whether if users should receive email notification for the action performed"
}
],
"displayOptions": {
"show": {
"operation": [
"share"
],
"resource": [
"file"
]
}
}
},
{
"name": "fileName",
"displayName": "File Name",
"type": "string",
"default": "",
"description": "The name the file should be saved as",
"placeholder": "photo.png",
"displayOptions": {
"show": {
"operation": [
"upload"
],
"resource": [
"file"
]
}
}
},
{
"name": "binaryData",
"displayName": "Binary File",
"type": "boolean",
"default": false,
"description": "Whether the data to upload should be taken from binary field",
"required": true,
"displayOptions": {
"show": {
"operation": [
"upload"
],
"resource": [
"file"
]
}
}
},
{
"name": "fileContent",
"displayName": "File Content",
"type": "string",
"default": "",
"description": "The text content of the file",
"required": true,
"displayOptions": {
"show": {
"binaryData": [
false
],
"operation": [
"upload"
],
"resource": [
"file"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "upload",
"description": "Copy a file",
"options": [
{
"name": "Copy",
"value": "copy",
"description": "Copy a file"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete a file"
},
{
"name": "Download",
"value": "download",
"description": "Download a file"
},
{
"name": "Get",
"value": "get",
"description": "Get a file"
},
{
"name": "Search",
"value": "search",
"description": "Search files"
},
{
"name": "Share",
"value": "share",
"description": "Share a file"
},
{
"name": "Upload",
"value": "upload",
"description": "Upload a file"
}
],
"displayOptions": {
"show": {
"resource": [
"file"
]
}
}
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Folder's name",
"required": true,
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"folder"
]
}
}
},
{
"name": "folderId",
"displayName": "Folder ID",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"operation": [
"get"
],
"resource": [
"folder"
]
}
}
},
{
"name": "recursive",
"displayName": "Recursive",
"type": "boolean",
"default": false,
"description": "Whether to delete a folder that is not empty by recursively deleting the folder and all of its content",
"displayOptions": {
"show": {
"operation": [
"delete"
],
"resource": [
"folder"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "Whether users who are not the owner of the folder can invite new collaborators to the folder",
"placeholder": "Add Field",
"options": [
{
"name": "can_non_owners_invite",
"displayName": "Can Non-Owners Invite",
"type": "boolean",
"default": false,
"description": "Whether users who are not the owner of the folder can invite new collaborators to the folder"
},
{
"name": "can_non_owners_view_collaborators",
"displayName": "Can Non-Owners View Colaborators",
"type": "boolean",
"default": false,
"description": "Whether to restrict collaborators who are not the owner of this folder from viewing other collaborations on this folder"
},
{
"name": "description",
"displayName": "Description",
"type": "string",
"default": "",
"description": "The optional description of this folder"
},
{
"name": "fields",
"displayName": "Fields",
"type": "string",
"default": "",
"description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
},
{
"name": "is_collaboration_restricted_to_enterprise",
"displayName": "Is Collaboration Restricted To Enterprise",
"type": "boolean",
"default": false,
"description": "Whether new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations."
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "The optional new name for this folder"
},
{
"name": "parentId",
"displayName": "Parent ID",
"type": "string",
"default": "",
"description": "The parent folder for this folder. Use this to move the folder or to restore it out of the trash."
}
],
"displayOptions": {
"show": {
"operation": [
"update"
],
"resource": [
"folder"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "file",
"options": [
{
"name": "File",
"value": "file"
},
{
"name": "Folder",
"value": "folder"
}
]
}
],
"credentialsConfig": [
{
"name": "boxOAuth2Api",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}