Connectors Reference

Egnyte

Egnyte is a content collaboration platform that keeps your files safe, synced, and easy to share. Connect to Egnyte to manage your files. You can perform various actions such as upload, move, download, and delete files in Egnyte.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

copyFileById ([Optional]copyFileByIdParameterBody body)

Copy File By Id

copyFileByPath ([Optional]copyFileByPathParameterBody body)

Copy File By Path

copyFolderById ([Optional]copyFolderByIdParameterBody body)

Copy Folder By Id

copyFolderByPath ([Optional]copyFolderByPathParameterBody body)

Copy Folder By Path

createFolder ([Optional]createFolderParameterBody body)

Create Folder

deleteFileById ([Optional]deleteFileByIdParameterBody body)

Delete File By Id

deleteFileByPath ([Optional]deleteFileByPathParameterBody body)

Delete File By Path

deleteFolderById ([Optional]deleteFolderByIdParameterBody body)

Delete Folder By Id

deleteFolderByPath ([Optional]deleteFolderByPathParameterBody body)

Delete Folder By Path

getFileContentById ([Optional]getFileContentByIdParameterBody body)

Get file content by id

getFileContentByPath ([Optional]getFileContentByPathParameterBody body)

Get file content by path

fileInfoById ([Optional]fileInfoByIdParameterBody body)

File Info By Id

fileInfoByPath ([Optional]fileInfoByPathParameterBody body)

File Info By Path

folderInfoById ([Optional]folderInfoByIdParameterBody body)

Folder Info By Id

folderInfoByPath ([Optional]folderInfoByPathParameterBody body)

Folder Info By Path

lockFileById ([Optional]lockFileByIdParameterBody body)

Lock File By Id

lockFileByPath ([Optional]lockFileByPathParameterBody body)

Lock File By Path

moveFileById ([Optional]moveFileByIdParameterBody body)

Move File By Id

moveFileByPath ([Optional]moveFileByPathParameterBody body)

Move File By Path

moveFolderById ([Optional]moveFolderByIdParameterBody body)

Move Folder By Id

moveFolderByPath ([Optional]moveFolderByPathParameterBody body)

Move Folder By Path

setMetadataByFileId ([Optional]setMetadataByFileIdParameterBody body)

Set Metadata By File Id

shareFile ([Optional]shareFileParameterBody body)

Share File

shareFolder ([Optional]shareFolderParameterBody body)

Share Folder

unlockFileById ([Optional]unlockFileByIdParameterBody body)

Unlock File By Id

unlockFileByPath ([Optional]unlockFileByPathParameterBody body)

Unlock File By Path

createFile (string Name, string Path, [internal]string Content-Type, string body)

Create file

listRootFolder ()

 

listFolder (string path)

 

 

Triggers:

Name

Summary

pollCopiedFiles (string FolderPath)

When a file is copied (properties)

pollCopiedFolders (string FolderPath)

When a folder is copied (properties)

pollCreatedFiles (string FolderPath)

When a file is created (properties)

pollCreatedFolders (string FolderPath)

When a folder is created (properties)

pollDeletedFiles (string FolderPath)

When a file is deleted (properties)

pollDeletedFolders (string FolderPath)

When a folder is deleted (properties)

pollMovedFiles (string FolderPath)

When a file is moved (properties)

pollMovedFolders (string FolderPath)

When a folder is moved (properties)

pollRenamedFiles (string FolderPath)

When a file is renamed (properties)

pollRenamedFolders (string FolderPath)

When a folder is renamed (properties)

 

Objects:

Name

Summary

copyFileByIdParameterBody

 

copyFileByIdResponse

 

copyFileByPathParameterBody

 

copyFileByPathResponse

 

copyFolderByIdParameterBody

 

copyFolderByIdResponse

 

copyFolderByPathParameterBody

 

copyFolderByPathResponse

 

createFileResponse

 

createFolderParameterBody

 

createFolderResponse

 

deleteFileByIdParameterBody

 

deleteFileByIdResponse

 

deleteFileByPathParameterBody

 

deleteFileByPathResponse

 

deleteFolderByIdParameterBody

 

deleteFolderByIdResponse

 

deleteFolderByPathParameterBody

 

deleteFolderByPathResponse

 

fileInfoByIdParameterBody

 

fileInfoByPathParameterBody

 

FileInfoResponse

 

FileSystemItem

 

folderInfoByIdParameterBody

 

folderInfoByPathParameterBody

 

FolderInfoResponse

 

getFileContentByIdParameterBody

 

getFileContentByIdResponse

 

getFileContentByPathParameterBody

 

getFileContentByPathResponse

 

lockFileByIdParameterBody

 

lockFileByIdResponse

 

lockFileByPathParameterBody

 

lockFileByPathResponse

 

moveFileByIdParameterBody

 

moveFileByIdResponse

 

moveFileByPathParameterBody

 

moveFileByPathResponse

 

moveFolderByIdParameterBody

 

moveFolderByIdResponse

 

moveFolderByPathParameterBody

 

moveFolderByPathResponse

 

pollCopiedFilesResponseItem

 

pollCopiedFoldersResponseItem

 

pollCreatedFilesResponseItem

 

pollCreatedFoldersResponseItem

 

pollDeletedFilesResponseItem

 

pollDeletedFoldersResponseItem

 

pollMovedFilesResponseItem

 

pollMovedFoldersResponseItem

 

pollRenamedFilesResponseItem

 

pollRenamedFoldersResponseItem

 

setMetadataByFileIdParameterBody

 

setMetadataByFileIdResponse

 

shareFileParameterBody

 

shareFileResponse

 

shareFolderParameterBody

 

shareFolderResponse

 

unlockFileByIdParameterBody

 

unlockFileByIdResponse

 

unlockFileByPathParameterBody

 

unlockFileByPathResponse

 

 

Actions:

copyFileById

Summary: Copy File By Id

Description: Copy a file by using an id.

 

Syntax:

Egnyte.copyFileById ([Optional]copyFileByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

copyFileByIdParameterBody

 

 

False

 

Returns:

          Type:copyFileByIdResponse

 

copyFileByPath

Summary: Copy File By Path

Description: Copy a file by using a path.

 

Syntax:

Egnyte.copyFileByPath ([Optional]copyFileByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

copyFileByPathParameterBody

 

 

False

 

Returns:

          Type:copyFileByPathResponse

 

copyFolderById

Summary: Copy Folder By Id

Description: Copy a folder using an id.

 

Syntax:

Egnyte.copyFolderById ([Optional]copyFolderByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

copyFolderByIdParameterBody

 

 

False

 

Returns:

          Type:copyFolderByIdResponse

 

copyFolderByPath

Summary: Copy Folder By Path

Description: Copy a folder by using a path.

 

Syntax:

Egnyte.copyFolderByPath ([Optional]copyFolderByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

copyFolderByPathParameterBody

 

 

False

 

Returns:

          Type:copyFolderByPathResponse

 

createFolder

Summary: Create Folder

Description: Create a folder in Egnyte.

 

Syntax:

Egnyte.createFolder ([Optional]createFolderParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

createFolderParameterBody

 

 

False

 

Returns:

          Type:createFolderResponse

 

deleteFileById

Summary: Delete File By Id

Description: Delete a file using an id.

 

Syntax:

Egnyte.deleteFileById ([Optional]deleteFileByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

deleteFileByIdParameterBody

 

 

False

 

Returns:

          Type:deleteFileByIdResponse

 

deleteFileByPath

Summary: Delete File By Path

Description: Delete a file using a path.

 

Syntax:

Egnyte.deleteFileByPath ([Optional]deleteFileByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

deleteFileByPathParameterBody

 

 

False

 

Returns:

          Type:deleteFileByPathResponse

 

deleteFolderById

Summary: Delete Folder By Id

Description: Delete a folder using an id.

 

Syntax:

Egnyte.deleteFolderById ([Optional]deleteFolderByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

deleteFolderByIdParameterBody

 

 

False

 

Returns:

          Type:deleteFolderByIdResponse

 

deleteFolderByPath

Summary: Delete Folder By Path

Description: Delete a folder using a path.

 

Syntax:

Egnyte.deleteFolderByPath ([Optional]deleteFolderByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

deleteFolderByPathParameterBody

 

 

False

 

Returns:

          Type:deleteFolderByPathResponse

 

getFileContentById

Summary: Get file content by id

Description: Retrieves the file content from Egnyte using id.

 

Syntax:

Egnyte.getFileContentById ([Optional]getFileContentByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

getFileContentByIdParameterBody

 

 

False

 

Returns:

          Type:getFileContentByIdResponse

 

getFileContentByPath

Summary: Get file content by path

Description: Retrieves the file contents from Egnyte using path.

 

Syntax:

Egnyte.getFileContentByPath ([Optional]getFileContentByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

getFileContentByPathParameterBody

 

 

False

 

Returns:

          Type:getFileContentByPathResponse

 

fileInfoById

Summary: File Info By Id

Description: Retrieve file info using file id.

 

Syntax:

Egnyte.fileInfoById ([Optional]fileInfoByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

fileInfoByIdParameterBody

 

 

False

 

Returns:

          Type:FileInfoResponse

 

fileInfoByPath

Summary: File Info By Path

Description: Retrieve file info using path.

 

Syntax:

Egnyte.fileInfoByPath ([Optional]fileInfoByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

fileInfoByPathParameterBody

 

 

False

 

Returns:

          Type:FileInfoResponse

 

folderInfoById

Summary: Folder Info By Id

Description: Retrieve folder info using id.

 

Syntax:

Egnyte.folderInfoById ([Optional]folderInfoByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

folderInfoByIdParameterBody

 

 

False

 

Returns:

          Type:FolderInfoResponse

 

folderInfoByPath

Summary: Folder Info By Path

Description: Retrieve folder info using path.

 

Syntax:

Egnyte.folderInfoByPath ([Optional]folderInfoByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

folderInfoByPathParameterBody

 

 

False

 

Returns:

          Type:FolderInfoResponse

 

lockFileById

Summary: Lock File By Id

Description: Lock file using id.

 

Syntax:

Egnyte.lockFileById ([Optional]lockFileByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

lockFileByIdParameterBody

 

 

False

 

Returns:

          Type:lockFileByIdResponse

 

lockFileByPath

Summary: Lock File By Path

Description: Lock file using path.

 

Syntax:

Egnyte.lockFileByPath ([Optional]lockFileByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

lockFileByPathParameterBody

 

 

False

 

Returns:

          Type:lockFileByPathResponse

 

moveFileById

Summary: Move File By Id

Description: Move a file in Egnyte using file id.

 

Syntax:

Egnyte.moveFileById ([Optional]moveFileByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

moveFileByIdParameterBody

 

 

False

 

Returns:

          Type:moveFileByIdResponse

 

moveFileByPath

Summary: Move File By Path

Description: Move a file in Egnyte using path.

 

Syntax:

Egnyte.moveFileByPath ([Optional]moveFileByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

moveFileByPathParameterBody

 

 

False

 

Returns:

          Type:moveFileByPathResponse

 

moveFolderById

Summary: Move Folder By Id

Description: Move a folder using id.

 

Syntax:

Egnyte.moveFolderById ([Optional]moveFolderByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

moveFolderByIdParameterBody

 

 

False

 

Returns:

          Type:moveFolderByIdResponse

 

moveFolderByPath

Summary: Move Folder By Path

Description: Move a folder in Egnyte using path.

 

Syntax:

Egnyte.moveFolderByPath ([Optional]moveFolderByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

moveFolderByPathParameterBody

 

 

False

 

Returns:

          Type:moveFolderByPathResponse

 

setMetadataByFileId

Summary: Set Metadata By File Id

Description: Write metadata to a file by using file id.

 

Syntax:

Egnyte.setMetadataByFileId ([Optional]setMetadataByFileIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

setMetadataByFileIdParameterBody

 

 

False

 

Returns:

          Type:setMetadataByFileIdResponse

 

shareFile

Summary: Share File

Description: Share a file in Egnyte.

 

Syntax:

Egnyte.shareFile ([Optional]shareFileParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

shareFileParameterBody

 

 

False

 

Returns:

          Type:shareFileResponse

 

shareFolder

Summary: Share Folder

Description: Share a folder in Egnyte.

 

Syntax:

Egnyte.shareFolder ([Optional]shareFolderParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

shareFolderParameterBody

 

 

False

 

Returns:

          Type:shareFolderResponse

 

unlockFileById

Summary: Unlock File By Id

Description: Unlock file using id.

 

Syntax:

Egnyte.unlockFileById ([Optional]unlockFileByIdParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

unlockFileByIdParameterBody

 

 

False

 

Returns:

          Type:unlockFileByIdResponse

 

unlockFileByPath

Summary: Unlock File By Path

Description: Unlock file using path.

 

Syntax:

Egnyte.unlockFileByPath ([Optional]unlockFileByPathParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

unlockFileByPathParameterBody

 

 

False

 

Returns:

          Type:unlockFileByPathResponse

 

createFile

Summary: Create file

Description: Uploads a file to Egnyte.

 

Syntax:

Egnyte.createFile (string Name, string Path, [internal]string Content-Type, string body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Name

string

(File name)

The name of the file to create in Egnyte.

True

Path

string

(Folder path)

The folder path to upload the file to Egnyte.

True

Content-Type

string

 

 

True

body

string(binary)

 

The content of the file to upload to Egnyte.

True

 

Returns:

          Type:createFileResponse

 

listRootFolder

Summary:

Description:

 

Syntax:

Egnyte.listRootFolder ()

 

Returns:

          Type:array of (FileSystemItem)

 

listFolder

Summary:

Description:

 

Syntax:

Egnyte.listFolder (string path)

 

Parameters:

Name

Type

Summary

Required

Related Action

path

string

 

 

True

 

Returns:

          Type:array of (array of (FileSystemItem))

 

Triggers:

Trigger pollCopiedFiles

Summary: When a file is copied (properties)

Description: This operation triggers a flow when a file is copied in a folder.

 

Syntax:

Egnyte.pollCopiedFiles (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollCopiedFilesResponseItem)

 

Trigger pollCopiedFolders

Summary: When a folder is copied (properties)

Description: This operation triggers a flow when a sub-folder is copied in a folder.

 

Syntax:

Egnyte.pollCopiedFolders (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollCopiedFoldersResponseItem)

 

Trigger pollCreatedFiles

Summary: When a file is created (properties)

Description: This operation triggers a flow when a new file is created in a folder.

 

Syntax:

Egnyte.pollCreatedFiles (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollCreatedFilesResponseItem)

 

Trigger pollCreatedFolders

Summary: When a folder is created (properties)

Description: This operation triggers a flow when a sub-folder is created in a folder.

 

Syntax:

Egnyte.pollCreatedFolders (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollCreatedFoldersResponseItem)

 

Trigger pollDeletedFiles

Summary: When a file is deleted (properties)

Description: This operation triggers a flow when a file is deleted in a folder.

 

Syntax:

Egnyte.pollDeletedFiles (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollDeletedFilesResponseItem)

 

Trigger pollDeletedFolders

Summary: When a folder is deleted (properties)

Description: This operation triggers a flow when a sub-folder is deleted in a folder.

 

Syntax:

Egnyte.pollDeletedFolders (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollDeletedFoldersResponseItem)

 

Trigger pollMovedFiles

Summary: When a file is moved (properties)

Description: This operation triggers a flow when a file is moved in a folder.

 

Syntax:

Egnyte.pollMovedFiles (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollMovedFilesResponseItem)

 

Trigger pollMovedFolders

Summary: When a folder is moved (properties)

Description: This operation triggers a flow when a sub-folder is moved in a folder.

 

Syntax:

Egnyte.pollMovedFolders (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollMovedFoldersResponseItem)

 

Trigger pollRenamedFiles

Summary: When a file is renamed (properties)

Description: This operation triggers a flow when a file is renamed in a folder.

 

Syntax:

Egnyte.pollRenamedFiles (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollRenamedFilesResponseItem)

 

Trigger pollRenamedFolders

Summary: When a folder is renamed (properties)

Description: This operation triggers a flow when a sub-folder is renamed in a folder.

 

Syntax:

Egnyte.pollRenamedFolders (string FolderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

FolderPath

string

(Folder Path)

The path to the target folder.

True

 

Returns:

          Type:array of (pollRenamedFoldersResponseItem)

 


 

copyFileByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination file path in Egnyte.

id

string

 

The unique identifier of the file to copy in Egnyte.


 

copyFileByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group_id

string

 

The ID to reference the file as a whole.

path

string

 

Full path of the copied file.


 

copyFileByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination file path in Egnyte, including target filename.

path

string

 

The source file path in Egnyte, including target filename.


 

copyFileByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group_id

string

 

The ID to reference the file as a whole.

path

string

 

Full path of the copied file.


 

copyFolderByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination folder path in Egnyte.

id

string

 

The unique identifier of the folder to copy in Egnyte.


 

copyFolderByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The unique ID of the copied folder.

path

string

 

Full path of the copied folder.


 

copyFolderByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination folder path in Egnyte.

path

string

 

The source folder path in Egnyte.


 

copyFolderByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The unique ID of the copied folder.

path

string

 

Full path of the copied folder.


 

createFileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group_id

string

 

The ID to reference the file as a whole.

id

string

 

The id of the current version of the file.

path

string

 

Full path of the uploaded file.


 

createFolderParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The full path of the new folder.


 

createFolderResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The unique ID of the created folder

path

string

 

Full path of the created folder


 

deleteFileByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the file to delete from Egnyte.


 

deleteFileByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

parent_folder_path

string

 

Path to the parent folder for the deleted file.


 

deleteFileByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The file path in Egnyte, including target filename.


 

deleteFileByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

parent_folder_path

string

 

Path to the parent folder for the deleted file


 

deleteFolderByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the folder to delete from Egnyte.


 

deleteFolderByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

parent_folder_path

string

 

Path to the parent folder for the deleted folder.


 

deleteFolderByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The folder path in Egnyte, including target folder name to be deleted.


 

deleteFolderByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

parent_folder_path

string

 

Path to the parent folder for the deleted folder.


 

fileInfoByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the file in Egnyte.


 

fileInfoByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The unique path to the file in Egnyte.


 

FileInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

checksum

string

 

Checksum value of the current version of the file used to determine file changes.

entry_id

string

 

The ID of the current version of the file.

group_id

string

 

The ID to reference the file as a whole.

is_folder

boolean

 

Whether the resource is a folder. True or False  Values: [, ]

last_modified

string

 

Last modified time of the current version of a file.

locked

boolean

 

Status of the lock on the file.  Values: [, ]

name

string

 

Name of the file.

num_versions

integer(int32)

 

The total number of versions associated with the specific file path.

parent_id

string

 

The ID of the parent folder requested.

path

string

 

Full path of the file.

size

integer(int32)

 

Size of the file in bytes.

uploaded

integer(int32)

 

Uploaded time of the current version of the file.

uploaded_by

string

 

Username of the user that uploaded the version.

versions

array of (VersionsItem)

 

Versions

 

VersionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

checksum

string

 

Checksum value of the version of the file used to determine file changes.

entry_id

string

 

The ID of the specific version of the file.

is_folder

boolean

 

Whether the resource is a folder. True or False  Values: [, ]

last_modified

string

 

Last modified time of the specific version of a file.

size

integer(int32)

 

Size of the file in bytes.

uploaded

integer(int32)

 

Uploaded time of the specific version of the file.

uploaded_by

string

 

Username of the user that uploaded the version.

 


 

FileSystemItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

is_folder

boolean

 

 

name

string

 

 

path

string

 

 


 

folderInfoByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the folder in Egnyte.


 

folderInfoByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The unique path to the folder in Egnyte.


 

FolderInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

allow_links

boolean

 

Is shareable? T or F  Values: [, ]

files

array of (FilesItem)

 

Files

folder_id

string

 

The unique ID of the folder.

folders

array of (FoldersItem)

 

Folders

is_folder

boolean

 

Whether the resource is a folder. True or False  Values: [, ]

lastModified

integer(int32)

 

The latest time that any file in the folder (but not within subfolders) has been modified.

name

string

 

Name of the folder.

parent_id

string

 

The id of the parent folder.

path

string

 

Full path of the folder.

public_links

string

 

The folder option setting as to how "Allow public inks from this folder for" was set.

restrict_move_delete

boolean

 

Can be deleted or moved? T or F  Values: [, ]

total_count

integer(int32)

 

The total number of items actually available to return.

uploaded

integer(int32)

 

Time when the folder has been uploaded or created.

 

FilesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

checksum

string

 

Checksum value of the current version of the file used to determine file changes.

entry_id

string

 

The ID of the specific version of the file.

group_id

string

 

The ID to reference the file as a whole.

is_folder

boolean

 

Whether the resource is a folder. True or False  Values: [, ]

last_modified

string

 

Last modified time of the current version of a file.

locked

boolean

 

Status of the lock on the file.  Values: [, ]

name

string

 

Name of the file.

num_versions

integer(int32)

 

The total number of versions associated with the specific file path.

parent_id

string

 

The ID of the parent folder.

path

string

 

Full path of the file.

size

integer(int32)

 

Size of the file in bytes.

uploaded

integer(int32)

 

Uploaded time of the current version of the file.

uploaded_by

string

 

Username of the user that uploaded the version.

 

FoldersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The ID of the folder requested.

is_folder

boolean

 

Whether the resource is a folder. True or False  Values: [, ]

lastModified

integer(int32)

 

The latest time that any file in the folder (but not within subfolders) has been modified.

name

string

 

Name of the folder.

parent_id

string

 

The id of the parent folder.

path

string

 

The full path of the folder as requested.

uploaded

integer(int32)

 

Time when the folder has been uploaded or created.

 


 

getFileContentByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileId

string

 

The unique identifier of the file in Egnyte.


 

getFileContentByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

getFileContentByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

filePath

string

 

The unique path to the file in Egnyte.


 

getFileContentByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

lockFileByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the file in Egnyte.


 

lockFileByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

lock_token

string

 

The token that must be used to unlock the file.

timeout

integer(int32)

 

The time in seconds that the file should be locked for.


 

lockFileByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The target file path in Egnyte, including target filename.


 

lockFileByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

lock_token

string

 

The token that must be used to unlock the file.

timeout

integer(int32)

 

The time in seconds that the file should be locked for.


 

moveFileByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination file path in Egnyte, including target filename.

id

string

 

The unique identifier of the file in Egnyte.


 

moveFileByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group_id

string

 

The ID to reference the file as a whole.

path

string

 

Full path of the moved file.


 

moveFileByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination file path in Egnyte, including target filename.

path

string

 

The path to source file.


 

moveFileByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group_id

string

 

The ID to reference the file as a whole.

path

string

 

Full path of the moved file.


 

moveFolderByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination folder path in Egnyte.

id

string

 

The unique identifier of the folder in Egnyte.


 

moveFolderByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The unique ID of the moved folder.

path

string

 

Full path of the moved folder.


 

moveFolderByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

destination_path

string

 

The destination folder path in Egnyte.

path

string

 

The path to source folder.


 

moveFolderByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folder_id

string

 

The unique ID of the moved folder.

path

string

 

Full path of the moved folder.


 

pollCopiedFilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

source_group_id

string

 

The source file ID to reference the file as a whole.

source_id

string

 

Source file specific version ID.

source_path

string

 

Full original path to the file.

target_group_id

string

 

The ID to reference the file as a whole.

target_id

string

 

The ID of the specific version of the file.

target_path

string

 

Full path to the file.

 


 

pollCopiedFoldersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder (True or False)

source_path

string

 

Full original path to the folder

target_path

string

 

Full destination path to the folder

 


 

pollCreatedFilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an event.

object_detail

string

 

Object Detail.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder (True or False).  Values: [, ]

target_group_id

string

 

The ID to reference the file as a whole.

target_id

string

 

The ID of the specific version of the file.

target_path

string

 

Full path to the file.

 


 

pollCreatedFoldersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an event.

object_detail

string

 

Object Detail.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

target_path

string

 

The full path to the folder.

 


 

pollDeletedFilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an event.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

target_group_id

string

 

The ID to reference the file as a whole.

target_path

string

 

Full path to the specific file version.

 


 

pollDeletedFoldersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an event.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

target_path

string

 

Full path to the deleted folder.

 


 

pollMovedFilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail.

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

source_path

string

 

Full original path to the file.

target_group_id

string

 

The ID to reference the file as a whole.

target_id

string

 

The ID of the specific version of the file.

target_path

string

 

Full path to the file.

 


 

pollMovedFoldersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

source_path

string

 

Full original path to the folder.

target_path

string

 

Full destination path to the folder.

 


 

pollRenamedFilesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

source_path

string

 

Full original path to the file.

target_group_id

string

 

The ID to reference the file as a whole.

target_id

string

 

The ID of the specific version of the file.

target_path

string

 

Full path to the renamed file

 


 

pollRenamedFoldersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action associated with this event.

action_source

string

 

The source of the event. For example WebUI, Mobile, etc.

actor

integer(int32)

 

The numeric ID of the user who performed the action.

data

Data

 

data

id

integer(int32)

 

The ID of an individual event.

object_detail

string

 

Object Detail

timestamp

string

 

The ISO-8601 formatted timestamp for when this event was recorded.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

is_folder

boolean

 

Whether the resource is a folder. (True or False)

source_path

string

 

Full original path to the folder.

target_path

string

 

Full destination path to the folder.

 


 

setMetadataByFileIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileId

string

 

The unique identifier of the file in Egnyte.

metadataName

string

 

The name of the key you want to assign value to.

metadataValue

string

 

Metadata value to be set.

namespaceName

string

 

The name of the namespace.


 

setMetadataByFileIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

shareFileParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The file path in Egnyte, including target filename to share.


 

shareFileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

accessibility

string

 

Who a link is accessible by, one of anyone, password, domain, or recipients.

created_by

string

 

Username of the user that created the link.

creation_date

string

 

Date and time of creation of the link.

expiry_date

string

 

Date and time of the expiration of the link.

link_to_current

boolean

 

Is this current version? T or F  Values: [, ]

links

array of (LinksItem)

 

Links

notify

boolean

 

Whether the link creator will be notified via email when link is accessed.  Values: [, ]

path

string

 

Full path of the shared file.

type

string

 

The type of link, either file, folder, or upload.

 

LinksItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the link.

recipients

array of (string)

 

An array of valid email addresses to which the link was sent.

url

string

 

The full url of the link.

 


 

shareFolderParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

path

string

 

The folder path in Egnyte, to share.


 

shareFolderResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

accessibility

string

 

Who a link is accessible by, one of anyone, password, domain, or recipients.

created_by

string

 

Username of the user that created the link.

creation_date

string

 

Date and time of creation of the link.

expiry_date

string

 

Date and time of the expiration of the link.

link_to_current

boolean

 

Is this current version? T or F  Values: [, ]

links

array of (LinksItem)

 

Links

notify

boolean

 

Whether the link creator will be notified via email when link is accessed.  Values: [, ]

path

string

 

Full path of the shared folder.

type

string

 

The type of link, either file, folder, or upload.

 

LinksItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the link.

recipients

array of (string)

 

An array of valid email addresses to which the link was sent.

url

string

 

The full url of the link.

 


 

unlockFileByIdParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The unique identifier of the file in Egnyte.

lock_token

string

 

The current lock token for the file.


 

unlockFileByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

unlockFileByPathParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

lock_token

string

 

The current lock token for the file.

path

string

 

The unique path to the file in Egnyte.


 

unlockFileByPathResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary