Egnyte
Egnyte is a service 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, update, get, and delete files in Egnyte.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Egnyte Support |
URL | https://helpdesk.egnyte.com |
support@egnyte.com |
Connector Metadata | |
---|---|
Publisher | Egnyte |
Website | https://egnyte.com/ |
Privacy policy | https://www.egnyte.com/privacy-policy |
Categories | Collaboration;Productivity |
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.
To use the connector, you need to be an Egnyte user.
The connector supports the following actions:
Create group
: Create a group in Egnyte. https://developers.egnyte.com/docs/read/Group_Management#Create-a-GroupGet group details
: Retrieve group info using ID. https://developers.egnyte.com/docs/read/Group_Management#Show-Single-GroupGet list of all groups
: Retrieve the list of the groups. https://developers.egnyte.com/docs/read/Group_Management#List-GroupsGet user details
: Retrieve the information about the user by ID. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Get-Single-UserGet list of all users
: Retrieve the information about the users. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Get-User-ListUpdate user by ID
: Update the single user. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Update-Single-UserCreate folder
: Create a folder in Egnyte. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Create-a-FolderDelete file by path
: Delete a file using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-FolderDelete folder by path
: Delete a folder using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-FolderDelete folder by ID
: Delete a folder using an ID. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-FolderDelete file by ID
: Delete a file using an ID. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-FolderCopy file by path
: Copy a file by using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Copy-File-or-FolderCopy folder by path
: Copy a folder by using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Copy-File-or-FolderFull group update
: Overwrite all of the attributes of a group. https://developers.egnyte.com/docs/read/Group_Management#Full-Update-to-a-GroupPartial group update
: Update specific attributes of a group. https://developers.egnyte.com/docs/read/Group_Management#Partial-Update-to-a-GroupDelete group
: Delete a group by ID. https://developers.egnyte.com/docs/read/Group_Management#Delete-a-GroupCopy file by ID
: Copy a file by using an ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Copy-File-or-FolderCopy folder by ID
: Copy a folder using an ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Copy-File-or-FolderMove file by path
: Move a file in Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-FolderMove folder by path
: Move a folder in Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-FolderMove file by ID
: Move a file in Egnyte using file ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-FolderMove folder by ID
: Move a folder using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-FolderShare file
: Share a file in Egnyte. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-LinkShare folder
: Share a folder in Egnyte. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-LinkFile info by path
: Retrieve file info using path. https://developers.egnyte.com/docs/read/File_System_Management_API_DocumentationFolder info by path
: Retrieve folder info using path. https://developers.egnyte.com/docs/read/File_System_Management_API_DocumentationFile info by ID
: Retrieve file info using file ID. https://developers.egnyte.com/docs/read/File_System_Management_API_DocumentationFolder info by ID
: Retrieve folder info using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_DocumentationLock file by path
: Lock file using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Lock-a-FileUnlock file by path
: Unlock file using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Unlock-a-FileLock file by ID
: Lock file using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Lock-a-FileUnlock file by ID
: Unlock file using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Unlock-a-FileGet file content by path
: Retrieves the file contents from Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Download-FileGet file content by ID
: Retrieves the file content from Egnyte using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Download-FileCreate file
: Uploads a file to Egnyte. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Upload-a-FileSet metadata by file ID
: Write metadata to a file by using file ID. https://developers.egnyte.com/docs/Metadata_API#Set-Values-for-a-NamespaceSet metadata by folder ID
: Write metadata to a folder by using folder ID. https://developers.egnyte.com/docs/Metadata_API#Set-Values-for-a-NamespaceGet all namespaces
: Get a list all custom metadata namespaces in the domain. https://developers.egnyte.com/docs/Metadata_API#Get-All-NamespacesCreate namespace
: Create a namespace in Egnyte. https://developers.egnyte.com/docs/Metadata_API#Create-NamespaceUpdate namespace attributes
: Updates namespace attributes. https://developers.egnyte.com/docs/Metadata_API#Update-Namespace-AttributesUpdate namespace keys
: Update the key of a custom metadata for a domain. https://developers.egnyte.com/docs/Metadata_API#Update-Namespace-KeysGet namespace
: List all custom metadata keys that have been created in a given namespace. https://developers.egnyte.com/docs/Metadata_API#Get-NamespaceDelete namespace
: Delete a specified namespace. https://developers.egnyte.com/docs/Metadata_API#Delete-NamespaceGet all projects
: List all project folders in the domain. https://developers.egnyte.com/docs/read/Project_Folder_API#Get-All-ProjectsMark folder as project
: Mark an existing folder as a project. https://developers.egnyte.com/docs/read/Project_Folder_API#Mark-Folder-as-ProjectCreate project from template
: Create a new project from a project folder template. https://developers.egnyte.com/docs/read/Project_Folder_API#Create-From-TemplateGet project by ID
: Retrieve a project using ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Find-Project-by-IDUpdate project by ID
: Updates specified properties of a project identified by its ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Update-ProjectDelete project by ID
: Remove a project based on its Id. https://developers.egnyte.com/docs/read/Project_Folder_API#Remove-ProjectGet project by root folder ID
: Retrieve a project based on its root folder ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Find-Project-by-Root-FolderClean up project by ID
: This endpoint initiates a cleanup in a project, and optionally delete or disable specified users. https://developers.egnyte.com/docs/read/Project_Folder_API#Cleanup%20ProjectCreate metadata key
: Add a metadata key to an existing namespace. https://developers.egnyte.com/docs/Metadata_API#Create-Metadata-KeyDelete metadata key
: Delete a metadata key from an existing namespace. https://developers.egnyte.com/docs/Metadata_API#Delete-Metadata-KeyGet metadata by file ID
: Get metadata from a file by using file ID. https://developers.egnyte.com/docs/Metadata_API#Get-Values-for-a-NamespaceGet metadata by folder ID
: Get metadata from a folder by using folder ID. https://developers.egnyte.com/docs/Metadata_API#Get-Values-for-a-NamespaceSearch metadata
: Find items with a specific metadata field or value. https://developers.egnyte.com/docs/Metadata_API#Search-MetadataGet effective permissions
: Get effective permissions for a user. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Get-Effective-Permission-for-a-UserSet folder permissions
: Set permissions for a folder. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Set-Folder-PermissionsGet folder permissions
: Get permissions for a folder. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Get-Folder-PermissionsDeep link by ID
: Create a deep link for file or folder by ID. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Deep-Links-to-Files-and-FoldersDeep link by path
: Create a deep link for file or folder by path. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Deep-Links-to-Files-and-FoldersList all links
: Lists all links except for deleted links. Please note, that if the user executing this method is not an admin, then only links created by the user will be listed. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#List-LinksList all links V2
: Lists all links. Please note, that if the user executing this method is not an admin, then only links created by the user will be listed. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#List-Links%20v2Show link details
: View the details of a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Show-Link-DetailsCreate link
: Create a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-LinkDelete link
: Delete a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Delete-a-Link
The connector supports the following triggers:
When a file is locked
: This operation triggers a flow when a file is lockedWhen a file is unlocked
: This operation triggers a flow when a file is unlockedWhen a file is updated
: This operation triggers a flow when a file is updated in specific FolderWhen a file is created (webhook)
: This operation triggers a flow when a file creates in specific FolderWhen a share link is created
: This operation triggers a flow when a share link is createdWhen a share link is deleted
: This operation triggers a flow when a share link is deletedWhen the file or folder permission changes
: This operation triggers a flow when a file or a folder permissions changesWhen the file or folder metadata changes
: This operation triggers a flow when a file or a folder metadata changesWhen a project folder is created
: This operation triggers a flow when a project folder is created or when an existing folder is marked as a project folderWhen a folder is unmarked as a project
: This operation triggers a flow when a folder is unmarked as a projectWhen a project is updated
: This operation triggers a flow when a project is updatedWhen a workflow is created
: This operation triggers a flow when a workflow is createdWhen a workflow is completed
: This operation triggers a flow when a workflow is completedWhen an approval type workflow is approved
: This operation triggers a flow when an approval type workflow is approvedWhen an approval type workflow is rejected
: This operation triggers a flow when an approval type workflow is rejectedWhen a group is created
: This operation triggers a flow when a group is createdWhen a group is updated
: This operation triggers a flow when a group is updatedWhen a group is deleted
: This operation triggers a flow when a group is deletedWhen a file is created (polling)
: This operation triggers a flow when a new file is created in a folder.When a folder is created
: This operation triggers a flow when a sub-folder is created in a folder.When a file is deleted
: This operation triggers a flow when a file is deleted in a folder.When a folder is deleted
: This operation triggers a flow when a sub-folder is deleted in a folder.When a file is renamed
: This operation triggers a flow when a file is renamed in a folder.When a folder is renamed
: This operation triggers a flow when a sub-folder is renamed in a folder.When a file is moved
: This operation triggers a flow when a file is moved in a folder.When a folder is moved
: This operation triggers a flow when a sub-folder is moved in a folder.When a file is copied
: This operation triggers a flow when a file is copied in a folder.When a folder is copied
: This operation triggers a flow when a sub-folder is copied in a folder.
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
This endpoint initiates a cleanup in a project, and optionally delete or disable specified users. https://developers.egnyte.com/docs/read/Project_Folder_API#Cleanup%20Project
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Project ID
|
projectId | True | string |
Project ID |
deleteLinks
|
deleteLinks | True | boolean |
If set to true, all existing active links in the project will be deleted. |
usersToDelete
|
usersToDelete | array of integer |
List of User IDs to be deleted. |
|
usersToDisable
|
usersToDisable | array of integer |
List of User IDs to be disabled. |
Returns
Name | Path | Type | Description |
---|---|---|---|
message
|
message | string |
Copy a file by using an ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Copy-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file to copy in Egnyte. |
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Path
|
path | string |
Full path of the copied file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Copy a file by using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Copy-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source File
|
path | True | string |
The source file path in Egnyte, including target filename. |
Destination File
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Path
|
path | string |
Full path of the copied file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Copy a folder using an ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Copy-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder to copy in Egnyte. |
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder Path
|
path | string |
Full path of the copied folder. |
Folder ID
|
folder_id | string |
The unique ID of the copied folder. |
Copy a folder by using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Copy-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source Folder Path
|
path | True | string |
The source folder path in Egnyte. |
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder Path
|
path | string |
Full path of the copied folder. |
Folder ID
|
folder_id | string |
The unique ID of the copied folder. |
Uploads a file to Egnyte. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Upload-a-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File name
|
Name | True | string |
The name of the file to create in Egnyte. |
Folder path
|
Path | True | string |
The folder path to upload the file to Egnyte. |
File content
|
body | True | binary |
The content of the file to upload to Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version ID
|
id | string |
The id of the current version of the file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
File Path
|
path | string |
Full path of the uploaded file. |
Create a folder in Egnyte. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Create-a-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The full path of the new folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder Path
|
path | string |
Full path of the created folder |
Folder ID
|
folder_id | string |
The unique ID of the created folder |
Create a group in Egnyte. https://developers.egnyte.com/docs/read/Group_Management#Create-a-Group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Display name
|
displayName | True | string |
The display name of the group. |
User ID
|
value | string |
The globally unique id of a group member. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Group ID
|
id | string |
The ID of created group. |
displayName
|
displayName | string |
The display name of a group. |
members
|
members | array of object |
Group members |
Username
|
members.username | string |
The username of a member. |
User ID
|
members.value | number |
The user ID of a member. |
User display name
|
members.display | string |
The display name of a member. |
Create a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Path
|
path | True | string |
The absolute path of the target file or folder. |
Type
|
type | True | string |
This determines what type of link will be created. |
Accessibility (set "none" for upload links or links when "useDefaultSettings" is true)
|
accessibility | True | string |
Determines who a link is accessible by. |
Use Default Settings
|
useDefaultSettings | boolean |
Determines whether to use the default parameters for link creation. |
|
Send email
|
sendEmail | boolean |
If true is set, link will be sent via email by Egnyte. |
|
Recipients
|
recipients | array of string |
List email addresses of recipients of the link. Only required if "Send email" is true. |
|
Message (Only applies if "Send email" is true.)
|
message | string |
Personal message to be sent in link email. |
|
Copy me (Only applies if "Send email" is true)
|
copyMe | boolean |
If true is set, a copy of the link message will be sent to the link creator. |
|
Notify
|
notify | boolean |
If true is set, link creator will be notified via email when link is accessed. |
|
Link to current (Only applicable for file links.)
|
linkToCurrent | boolean |
If true is set, the link will always refer to current version of file. |
|
Expiry date (e.g. 2023-12-31)
|
expiryDate | string |
Expiry date for the link. If specified, "Expiry clicks" cannot be set. |
|
Expiry clicks
|
expiryClicks | number |
Number of clicks the link is valid for. If specified, "Expiry date" cannot be set |
|
Add a file name (Only applies to file links, not folder links)
|
addFileName | boolean |
If true then the filename will be appended to the end of the link. |
|
Password (when "accessibility" parameter is set to "password")
|
password | string |
When not specified, the system will generate a password automatically. |
|
Protection
|
protection | string |
If set to "PREVIEW", it will create a preview-only link. |
|
Folder per recipient (Only applies to upload links.)
|
folderPerRecipient | boolean |
If true then each recipient's uploaded data will be put into a separate folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Links
|
links | array of object |
An array containing the full json information for all links for your domain that this user can see within any specified ranges |
Id
|
links.id | string |
The id of the link |
Url
|
links.url | string |
The full url of the link |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Path
|
path | string |
The absolute path of the target resource, either file or folder. |
Type
|
type | string |
The type of link, either file, folder, or upload |
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Notify
|
notify | boolean |
Boolean as to whether the link creator will be notified via email when link is accessed. |
Link to current
|
link_to_current | boolean |
Boolean as to whether the link will always refer to the current version of file. Only applicable for file links. |
Expiry date
|
expiry_date | string |
Date and time of the expiration of the link. This field is only shown if the link is to expire by date |
Creation date
|
creation_date | string |
Date and time of creation of the link |
Created by
|
created_by | string |
Username of the user that created the link |
Add a metadata key to an existing namespace. https://developers.egnyte.com/docs/Metadata_API#Create-Metadata-Key
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
Key name
|
key | True | string |
The name of the key you are creating. |
Type (For "enum": Data parameter is required)
|
type | True | string |
Specifies the data type for a key. |
Display name
|
displayName | string |
The name to identify the field in the UI. |
|
Priority
|
priority | number |
Specifies priority for the key (keys with the higher priority will be displayed first). |
|
Help text
|
helpText | string |
A tooltip description for the metadata field. |
|
Data
|
data | array of string |
For a key of enum type, specifies the enumerated values. |
Returns
Create a namespace in Egnyte. https://developers.egnyte.com/docs/Metadata_API#Create-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
name | True | string |
The name of the namespace |
Display name
|
displayName | string |
The name to identify the namespace in the UI |
|
Scope
|
scope | True | string |
Who can see and modify the namespace |
Key Name
|
name | True | string |
The name of the key |
Type
|
type | True | string |
Specifies the data type for a key |
Display Name
|
displayName | string |
The name to identify the field in the UI |
|
Help Text
|
helpText | string |
A tooltip description for the metadata field |
|
Priority
|
priority | number |
Specifies priority for the key (keys with the higher priority will be displayed first |
|
Data
|
data | array of string |
For a key of enum type, specifies the enumerated values |
Returns
Create a new project from a project folder template. https://developers.egnyte.com/docs/read/Project_Folder_API#Create-From-Template
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Parent Folder Id
|
parentFolderId | True | string |
Folder ID of the parent folder where the project folder will be created |
Template Folder Id
|
templateFolderId | True | string |
Folder ID of the project folder template |
Folder Name
|
folderName | True | string |
Name of the new folder that will be created |
Name
|
name | True | string |
The name of the project |
Description
|
description | string |
Folder description |
|
Project Id
|
projectId | string |
ID of the project |
|
Customer Name
|
customerName | string |
The customer associated with the project |
|
Status
|
status | True | string |
Status of the project |
Start Date (e.g. 2023-12-31T23:59:59)
|
startDate | date-time |
The start date of the project. |
|
Completion Date (e.g. 2023-12-31T23:59:59)
|
completionDate | date-time |
The completion date for the project. |
|
Street Address 1
|
streetAddress1 | string |
First line of the street address |
|
Street Address 2
|
streetAddress2 | string |
Second line of the street address |
|
City
|
city | string |
City |
|
State or Province
|
state | string |
State or Province |
|
Country
|
country | string |
Country |
|
Zip code or postal code
|
postalCode | string |
Zip code or postal code |
Returns
Name | Path | Type | Description |
---|---|---|---|
groupsCreated
|
groupsCreated | array of object | |
Project Id
|
groupsCreated.id | string |
Project ID |
Project name
|
groupsCreated.name | string |
Project name |
Create a deep link for file or folder by ID. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Deep-Links-to-Files-and-Folders
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id
|
id | True | string |
Id of the file or folder |
Type
|
type | True | string |
Type of the link |
Returns
Name | Path | Type | Description |
---|---|---|---|
Url
|
url | string |
Deep link |
Create a deep link for file or folder by path. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Deep-Links-to-Files-and-Folders
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Path
|
path | True | string |
Path of the file or folder |
Returns
Name | Path | Type | Description |
---|---|---|---|
Url
|
url | string |
Deep link |
Delete a file using an ID. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file to delete from Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted file. |
Delete a file using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted file |
Delete a folder using an ID. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder to delete from Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted folder. |
Delete a folder using a path. https://developers.egnyte.com/docs/File_System_Management_API_Documentation#Delete-a-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The folder path in Egnyte, including target folder name to be deleted. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted folder. |
Delete a group by ID. https://developers.egnyte.com/docs/read/Group_Management#Delete-a-Group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group Id
|
id | True | string |
The group ID. |
Delete a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Delete-a-Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Link Id
|
linkId | True | string |
LinkId |
Returns
Delete a metadata key from an existing namespace. https://developers.egnyte.com/docs/Metadata_API#Delete-Metadata-Key
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
Name
|
key | True | string |
The name of the key you are deleting. |
Force to delete
|
force | boolean |
Delete even if the metadata key is used. |
Returns
Delete a specified namespace. https://developers.egnyte.com/docs/Metadata_API#Delete-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
Force to delete
|
force | boolean |
Delete even if the namespace is used |
Returns
Remove a project based on its Id. https://developers.egnyte.com/docs/read/Project_Folder_API#Remove-Project
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Project ID
|
projectId | True | string |
ID of the project being deleted |
Retrieve file info using file ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Returns
- Body
- FileInfoResponse
Retrieve file info using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The unique path to the file in Egnyte. |
Returns
- Body
- FileInfoResponse
Retrieve folder info using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder in Egnyte. |
Returns
- Body
- FolderInfoResponse
Retrieve folder info using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The unique path to the folder in Egnyte. |
Returns
- Body
- FolderInfoResponse
Overwrite all of the attributes of a group. https://developers.egnyte.com/docs/read/Group_Management#Full-Update-to-a-Group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
id | True | string |
The ID of created group. |
Display name
|
displayName | True | string |
The display name of the group. |
User ID
|
value | string |
The globally unique ID of a group member. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Group ID
|
id | string |
The ID of created group. |
displayName
|
displayName | string |
The display name of a group. |
members
|
members | array of object |
Group members |
Username
|
members.username | string |
The username of a member. |
User ID
|
members.value | number |
The user ID of a member. |
User display name
|
members.display | string |
The display name of a member. |
Get a list all custom metadata namespaces in the domain. https://developers.egnyte.com/docs/Metadata_API#Get-All-Namespaces
Returns
- response
- array of NamespaceItem
List all project folders in the domain. https://developers.egnyte.com/docs/read/Project_Folder_API#Get-All-Projects
Returns
- response
- array of ProjectItem
Get effective permissions for a user. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Get-Effective-Permission-for-a-User
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
Full path of the folder. |
Username
|
username | True | string |
Username |
Returns
Name | Path | Type | Description |
---|---|---|---|
Permission
|
permission | string |
Permission value |
Retrieves the file content from Egnyte using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Download-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
fileId | True | string |
The unique identifier of the file in Egnyte. |
Returns
Retrieves the file contents from Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Download-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
filePath | True | string |
The unique path to the file in Egnyte. |
Returns
Get permissions for a folder. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Get-Folder-Permissions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
Full path of the folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
User Permissions
|
userPerms | object |
Map of user to permission value. |
Group Permissions
|
groupPerms | object |
Map of group name to permission value |
Inherits Permissions
|
inheritsPermissions | boolean |
Whether permissions should be inherited from the parent folder. |
Keep Parent Permissions
|
keepParentPermissions | boolean |
When disabling permissions inheritance with inheritsPermissions, this options determines whether previously inherited permissions from parent folders should be copied to this folder. |
Retrieve group info using ID. https://developers.egnyte.com/docs/read/Group_Management#Show-Single-Group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
id | True | string |
The ID of the group. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Group ID
|
id | string |
The globally unique group ID. |
Group Name
|
displayName | string |
The name of the group. |
members
|
members | array of object |
Group members |
Group ID
|
members.username | string |
The username of a group member |
User ID
|
members.value | number |
The globally unique id of a group member. |
User display name
|
members.display | string |
The display name of a group member. |
Retrieve the list of the groups. https://developers.egnyte.com/docs/read/Group_Management#List-Groups
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Index
|
startIndex | integer |
The 1-based index of the initial record being requested (Integer ≥ 1). |
|
Count
|
count | integer |
The number of entries per page (min 1, max 100) |
|
Filter
|
filter | string |
Allows you to request a subset of groups. These terms are not case sensitive |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total results
|
totalResults | integer |
The total number of results matching the query. |
Items per page
|
itemsPerPage | integer |
The number of results returned. |
Start index
|
startIndex | integer |
The 1-based index of the first result in the current set of results. |
resources
|
resources | array of object | |
Group ID
|
resources.id | string |
The globally unique group ID. |
Group name
|
resources.displayName | string |
The name of the group. |
Retrieve the information about the users. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Get-User-List
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Index
|
startIndex | integer |
The 1-based index of the first search result. |
|
Count
|
count | integer |
Specifies the desired maximum number of search results per page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Start index
|
startIndex | integer | |
Total results
|
totalResults | integer | |
Items per page
|
itemsPerPage | integer | |
resources
|
resources | array of UserInfoResponse |
Get metadata from a file by using file ID. https://developers.egnyte.com/docs/Metadata_API#Get-Values-for-a-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File ID
|
fileId | True | string |
The unique identifier of the file in Egnyte. |
Namespace Name
|
namespace | True | string |
The name of the namespace. |
Returns
Get metadata from a folder by using folder ID. https://developers.egnyte.com/docs/Metadata_API#Get-Values-for-a-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder ID
|
folderId | True | string |
The unique identifier of the folder in Egnyte. |
Namespace Name
|
namespace | True | string |
The name of the namespace. |
Returns
List all custom metadata keys that have been created in a given namespace. https://developers.egnyte.com/docs/Metadata_API#Get-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
Returns
- Body
- NamespaceItem
Retrieve a project using ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Find-Project-by-ID
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Project Id
|
projectId | True | string |
Project Id |
Returns
- Body
- ProjectItem
Retrieve a project based on its root folder ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Find-Project-by-Root-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The ID of the root folder
|
rootFolderId | True | string |
The ID of the root folder |
Returns
- Body
- ProjectItem
Retrieve the information about the user by ID. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Get-Single-User
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
id | True | integer |
The ID of the user |
Returns
User info
- Body
- UserInfoResponse
Lists all links except for deleted links. Please note, that if the user executing this method is not an admin, then only links created by the user will be listed. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#List-Links
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Path
|
path | string |
List links to a file or folder specified by its full path. |
|
Username
|
username | string |
List links created by this user. |
|
Created before
|
createdBefore | string |
List links created before a given date (ISO-8601 or YYYY-MM-DD). |
|
Created after
|
createdAfter | string |
List links created after a given date (ISO-8601 or YYYY-MM-DD). |
|
Type
|
type | string |
Filter to "file" or "folder" items only. |
|
Accessibility
|
accessibility | string |
Select accessibility type |
|
Offset
|
offset | string |
The 0-based index of the initial record being requested. |
|
Count (By default 500 entries is returned)
|
count | string |
Limit number of entries per page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Ids
|
ids | array of string |
An array containing the IDs of all links for your domain that this user can see. |
Offset
|
offset | number |
The 0-based index of the initial record being requested. |
Count
|
count | number |
The count of items returned. If this field is not specified, the count value will be 0. |
Total count
|
total_count | number |
The number of links visible to the user in the domain. |
Lists all links. Please note, that if the user executing this method is not an admin, then only links created by the user will be listed. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#List-Links%20v2
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Path
|
path | string |
List links to a file or folder specified by its full path. |
|
Username
|
username | string |
List links created by this user. |
|
Created before
|
createdBefore | string |
List links created before a given date (ISO-8601 or YYYY-MM-DD). |
|
Created after
|
createdAfter | string |
List links created after a given date (ISO-8601 or YYYY-MM-DD). |
|
Type
|
type | string |
Filter to "file" or "folder" items only. |
|
Accessibility
|
accessibility | string |
Select accessibility type |
|
Offset
|
offset | string |
The 0-based index of the initial record being requested. |
|
Count (By default 500 entries is returned)
|
count | string |
Limit number of entries per page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Links
|
links | array of object |
An array containing the full json information for all links for your domain that this user can see within any specified ranges |
Path
|
links.path | string |
The absolute path of the target resource, either file or folder. |
Type
|
links.type | string |
The type of link, either file, folder, or upload |
Accessibility
|
links.accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Protection
|
links.protection | string |
If "PREVIEW" for a file (or folder) link, it is a preview-only link to the file (folder), otherwise it is "NONE" |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Notify
|
links.notify | boolean |
Boolean as to whether the link creator will be notified via email when link is accessed. |
Url
|
links.url | string |
The full url of the link |
Id
|
links.id | string |
The id of the link |
Link to current
|
links.link_to_current | boolean |
Boolean as to whether the link will always refer to the current version of file. Only applicable for file links. |
Creation date
|
links.creation_date | string |
Date and time of creation of the link |
Created by
|
links.created_by | string |
Username of the user that created the link |
Resource id
|
links.resource_id | string |
Id of the associated resource, either group id if it is a file link, or the folder id if it is a folder or upload link |
Expiry clicks
|
links.expiry_clicks | number |
Number of clicks left on the link before expiration. This field is only shown if the link is to expire via clicks |
Last accessed
|
links.last_accessed | string |
Date and time of the last access of the link. This field is only shown if the link has been accessed at least once |
Expiry date
|
links.expiry_date | string |
Date and time of the expiration of the link. This field is only shown if the link is to expire by date |
Count
|
count | number |
The number of links visible to the user in the domain that are returned |
Lock file using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Lock-a-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Timeout
|
timeout | integer |
The time in seconds that the file should be locked for. |
Lock Token
|
lock_token | string |
The token that must be used to unlock the file. |
Lock file using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Lock-a-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Target File Path
|
path | True | string |
The target file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Timeout
|
timeout | integer |
The time in seconds that the file should be locked for. |
Lock Token
|
lock_token | string |
The token that must be used to unlock the file. |
Mark an existing folder as a project. https://developers.egnyte.com/docs/read/Project_Folder_API#Mark-Folder-as-Project
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Root Folder Id
|
rootFolderId | True | string |
FolderId of the root project folder |
Name
|
name | True | string |
The name of the project |
Description
|
description | string |
Folder description |
|
Status
|
status | True | string |
Status of the project |
Start Date (e.g. 2023-12-31T23:59:59)
|
startDate | date-time |
The start date of the project. |
|
Completion Date (e.g. 2023-12-31T23:59:59)
|
completionDate | date-time |
The completion date for the project. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Id
|
id | string |
Item Id |
Move a file in Egnyte using file ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte. Including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Path
|
path | string |
Full path of the moved file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Move a file in Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source Path
|
path | True | string |
The path to source file. |
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Path
|
path | string |
Full path of the moved file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Move a folder using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder in Egnyte. |
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder Path
|
path | string |
Full path of the moved folder. |
Folder ID
|
folder_id | string |
The unique ID of the moved folder. |
Move a folder in Egnyte using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Move-File-or-Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source Path
|
path | True | string |
The path to source folder. |
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder Path
|
path | string |
Full path of the moved folder. |
Folder ID
|
folder_id | string |
The unique ID of the moved folder. |
Update specific attributes of a group. https://developers.egnyte.com/docs/read/Group_Management#Partial-Update-to-a-Group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
id | True | string |
The ID of created group. |
Display name
|
displayName | string |
The display name of the group. |
|
User ID
|
value | string |
The globally unique id of a group member. |
|
operation
|
operation | string |
The action you wish to perform on a group. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Group ID
|
id | string |
The ID of created group. |
displayName
|
displayName | string |
The display name of a group. |
members
|
members | array of object |
Group members |
Username
|
members.username | string |
The username of a member. |
User ID
|
members.value | number |
The user ID of a member. |
User display name
|
members.display | string |
The display name of a member. |
Find items with a specific metadata field or value. https://developers.egnyte.com/docs/Metadata_API#Search-Metadata
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Search Type
|
type | string |
Which item types should be searched. |
|
Namespace Name
|
namespace | True | string |
The name of the namespace. |
Metadata Key
|
keyName | True | string |
The name of the metadata key. |
Namespace Name
|
namespace | True | string |
The name of the namespace. |
Metadata Key
|
keyName | True | string |
The name of the metadata key. |
Metadata Value
|
value | True | string |
The value of the metadata key. |
Returns
Set permissions for a folder. https://developers.egnyte.com/docs/read/Egnyte_Permissions_API#Set-Folder-Permissions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
Full path of the folder. |
User Permissions
|
userPerms | object |
Map of user to permission value. |
|
Group Permissions
|
groupPerms | object |
Map of group name to permission value |
|
Inherits Permissions
|
inheritsPermissions | boolean |
Whether permissions should be inherited from the parent folder. |
|
Keep Parent Permissions (only if inheritsPermissions is false)
|
keepParentPermissions | boolean |
Whether permissions from parent folders should apply to this folder. |
Returns
Write metadata to a file by using file ID. https://developers.egnyte.com/docs/Metadata_API#Set-Values-for-a-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
fileId | True | string |
The unique identifier of the file in Egnyte. |
Namespace Name
|
namespaceName | True | string |
The name of the namespace. |
Metadata Key Name
|
metadataName | True | string |
The name of the key you want to assign value to. |
Metadata Value
|
metadataValue | string |
Metadata value to be set. |
Returns
Write metadata to a folder by using folder ID. https://developers.egnyte.com/docs/Metadata_API#Set-Values-for-a-Namespace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
folderId | True | string |
The unique identifier of the folder in Egnyte. |
Namespace Name
|
namespaceName | True | string |
The name of the namespace. |
Metadata Key Name
|
metadataName | True | string |
The name of the key you want to assign value to. |
Metadata Value
|
metadataValue | True | string |
Metadata value to be set. |
Returns
Share a file in Egnyte. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The file path in Egnyte, including target filename to share. |
Returns
Name | Path | Type | Description |
---|---|---|---|
links
|
links | array of object |
Links |
Link ID
|
links.id | string |
The id of the link. |
Link Url
|
links.url | string |
The full url of the link. |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
File Path
|
path | string |
Full path of the shared file. |
Type
|
type | string |
The type of link, either file, folder, or upload. |
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Notify creator when accessed
|
notify | boolean |
Whether the link creator will be notified via email when link is accessed. |
Is referring to version
|
link_to_current | boolean |
Is this current version? T or F |
Expiry Date
|
expiry_date | string |
Date and time of the expiration of the link. |
Creation Date
|
creation_date | string |
Date and time of creation of the link. |
Created By
|
created_by | string |
Username of the user that created the link. |
Share a folder in Egnyte. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Create-a-Link
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The folder path in Egnyte, to share. |
Returns
Name | Path | Type | Description |
---|---|---|---|
links
|
links | array of object |
Links |
Link ID
|
links.id | string |
The id of the link. |
Link Url
|
links.url | string |
The full url of the link. |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Folder Path
|
path | string |
Full path of the shared folder. |
Type
|
type | string |
The type of link, either file, folder, or upload. |
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Notify creator when accessed
|
notify | boolean |
Whether the link creator will be notified via email when link is accessed. |
Is referring to version
|
link_to_current | boolean |
Is this current version? T or F |
Expiry Date
|
expiry_date | string |
Date and time of the expiration of the link. |
Creation Date
|
creation_date | string |
Date and time of creation of the link. |
Created by
|
created_by | string |
Username of the user that created the link. |
View the details of a link. https://developers.egnyte.com/docs/read/Egnyte_Link_API_Documentation#Show-Link-Details
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Link Id
|
linkId | True | string |
LinkId |
Returns
Name | Path | Type | Description |
---|---|---|---|
Links
|
links | array of object |
An array containing the full json information for all links for your domain that this user can see within any specified ranges |
Id
|
links.id | string |
The id of the link |
Url
|
links.url | string |
The full url of the link |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Path
|
path | string |
The absolute path of the target resource, either file or folder. |
Type
|
type | string |
The type of link, either file, folder, or upload |
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Notify
|
notify | boolean |
Boolean as to whether the link creator will be notified via email when link is accessed. |
Link to current
|
link_to_current | boolean |
Boolean as to whether the link will always refer to the current version of file. Only applicable for file links. |
Expiry date
|
expiry_date | string |
Date and time of the expiration of the link. This field is only shown if the link is to expire by date |
Creation date
|
creation_date | string |
Date and time of creation of the link |
Created by
|
created_by | string |
Username of the user that created the link |
Last accessed
|
last_accessed | string |
Date and time of the last access of the link. This field is only shown if the link has been accessed at least once |
Unlock file using ID. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Unlock-a-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Lock Token
|
lock_token | True | string |
The current lock token for the file. |
Returns
Unlock file using path. https://developers.egnyte.com/docs/read/File_System_Management_API_Documentation#Unlock-a-File
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The unique path to the file in Egnyte. |
Lock Token
|
lock_token | True | string |
The current lock token for the file. |
Returns
Updates namespace attributes. https://developers.egnyte.com/docs/Metadata_API#Update-Namespace-Attributes
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
displayName
|
displayName | string |
The name to identify the namespace in the UI |
|
priorities
|
priorities | object |
Specifies the priority (order) for the keys. The keys will be displayed in accordance with their priorities in descending order (keys with higher priority will be displayed first) |
Returns
- Body
- NamespaceItem
Update the key of a custom metadata for a domain. https://developers.egnyte.com/docs/Metadata_API#Update-Namespace-Keys
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Namespace name
|
namespace | True | string |
The unique identifier of the namespace in Egnyte. |
Key
|
key | True | string |
The unique key in the namespace |
displayName
|
displayName | string |
Specifies the name displayed for the key |
|
type
|
type | string |
Specifies the data type for a key |
|
priority
|
priority | number |
Specifies the priority (order) for the keys. The keys will be displayed in accordance with their priorities in descending order (keys with higher priority will be displayed first) |
|
data
|
data | string |
For a key of enum type, specifies the enumerated values |
|
helpText
|
helpText | string |
Instructional text that is displayed when a user is adding/editing a property to give context as to the property's purpose |
Returns
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string |
Namespace name |
key
|
key | string |
Key name |
displayName
|
displayName | string |
The name to identify the field in the UI |
helpText
|
helpText | string |
A tooltip description for the metadata field |
priority
|
priority | number |
Specifies priority for the key (keys with the higher priority will be displayed first |
Updates specified properties of a project identified by its ID. https://developers.egnyte.com/docs/read/Project_Folder_API#Update-Project
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
name
|
name | True | string |
The new name of the folder. |
description
|
description | string |
A new description for the folder. |
|
projectId
|
projectId | True | string |
ID of the project. |
customerName
|
customerName | string |
The customer associated with the project. |
|
streetAddress1
|
streetAddress1 | string |
First line of the street address. |
|
streetAddress2
|
streetAddress2 | string |
Second line of the street address. |
|
city
|
city | string |
City. |
|
state
|
state | string |
State or province. |
|
postalCode
|
postalCode | string |
Zip code or postal code. |
|
country
|
country | string |
using a 3 character country code from the ISO 3166 GENC profile, for example: USA, GBR, POL. |
|
status
|
status | True | string |
Current status of the project. |
startDate
|
startDate | string |
The start date of the project in ISO 8601 format. |
|
completionDate
|
completionDate | string |
The anticipated completion date of the project in ISO 8601 format. |
|
customMetadata
|
customMetadata | object |
Custom metadata fields to add or update for the folder. |
Update the single user. Learn more: https://developers.egnyte.com/docs/read/User_Management_API_Documentation#Update-Single-User
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
User ID
|
id | True | integer |
Unique identifier for the user |
User email
|
string |
The email address of the user. |
||
Given name
|
givenName | string |
The first name of the user. |
|
Family name
|
familyName | string |
The last name of the user. |
|
Active
|
active | boolean |
Whether the user is active or inactive. |
|
Send invite
|
sendInvite | boolean |
If set to true, an invitation email will be sent. The parameter cannot be the only one modified by this action. |
|
Language
|
language | string |
The "language" parameter is accepted only when Language Pack has been enabled for the domain. |
|
Auth type
|
authType | string |
The authentication type for the user. |
|
User type
|
userType | string |
The type of the user. |
|
Role
|
role | string |
The role assigned to the user. Only applicable for Power Users. |
|
IDP user ID
|
idpUserId | string |
Only required if the user is SSO authenticated and not using default user mapping |
|
User principal name
|
userPrincipalName | string |
Do not specify if user is not AD authenticated. |
Returns
Name | Path | Type | Description |
---|---|---|---|
User ID
|
id | integer |
Unique identifier for the user |
User email
|
string |
The email address of the user. |
|
Family name
|
familyName | string |
The last name of the user. |
Given name
|
givenName | string |
The first name of the user. |
Active
|
active | boolean |
Whether the user is active or inactive. |
Send invite
|
sendInvite | boolean |
If set to true, an invitation email will be sent. |
Language
|
language | string |
It is accepted only when Language Pack has been enabled. |
Auth type
|
authType | string |
The authentication type for the user. |
User type
|
userType | string |
The type of the user. |
Role
|
role | string |
The role assigned to the user. Only applicable for Power Users. |
IDP user ID
|
idpUserId | string |
Only required if the user is SSO authenticated |
User principal name
|
userPrincipalName | string |
Do not specify if user is not AD authenticated. |
When a file is copied (properties) |
This operation triggers a flow when a file is copied in a folder. |
When a file is created (properties) |
This operation triggers a flow when a new file is created in a folder. |
When a file is created v2 |
This operation triggers a flow when a file creates in specific Folder |
When a file is deleted (properties) |
This operation triggers a flow when a file is deleted in a folder. |
When a file is locked |
This operation triggers a flow when a file is locked |
When a file is moved (properties) |
This operation triggers a flow when a file is moved in a folder. |
When a file is renamed (properties) |
This operation triggers a flow when a file is renamed in a folder. |
When a file is unlocked |
This operation triggers a flow when a file is unlocked |
When a file is updated |
This operation triggers a flow when a file is updated in specific Folder |
When a folder is copied (properties) |
This operation triggers a flow when a sub-folder is copied in a folder. |
When a folder is created (properties) |
This operation triggers a flow when a sub-folder is created in a folder. |
When a folder is deleted (properties) |
This operation triggers a flow when a sub-folder is deleted in a folder. |
When a folder is moved (properties) |
This operation triggers a flow when a sub-folder is moved in a folder. |
When a folder is renamed (properties) |
This operation triggers a flow when a sub-folder is renamed in a folder. |
When a folder is unmarked as a project |
This operation triggers a flow when a folder is unmarked as a project |
When a group is created |
This operation triggers a flow when a group is created |
When a group is deleted |
This operation triggers a flow when a group is deleted |
When a group is updated |
This operation triggers a flow when a group is updated |
When a project folder is created |
This operation triggers a flow when a project folder is created or when an existing folder is marked as a project folder |
When a project is updated |
This operation triggers a flow when a project is updated |
When a share link is created |
This operation triggers a flow when a share link is created |
When a share link is deleted |
This operation triggers a flow when a share link is deleted |
When a workflow is completed |
This operation triggers a flow when a workflow is completed |
When a workflow is created |
This operation triggers a flow when a workflow is created |
When an approval type workflow is approved |
This operation triggers a flow when an approval type workflow is approved |
When an approval type workflow is rejected |
This operation triggers a flow when an approval type workflow is rejected |
When the file or folder metadata changes |
This operation triggers a flow when a file or a folder metadata changes |
When the file or folder permission changes |
This operation triggers a flow when a file or a folder permissions changes |
This operation triggers a flow when a file is copied in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
File Path
|
data.target_path | string |
Full path to the file. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Source File Path
|
data.source_path | string |
Full original path to the file. |
Source File Version ID
|
data.source_id | string |
Source file specific version ID. |
Source File ID
|
data.source_group_id | string |
The source file ID to reference the file as a whole. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail. |
This operation triggers a flow when a new file is created in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
File Path
|
data.target_path | string |
Full path to the file. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder (True or False). |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail. |
This operation triggers a flow when a file creates in specific Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target file or folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Entry ID
|
targetEntryId | string | |
File ID
|
targetGroupId | string | |
File Path
|
targetPath | string |
This operation triggers a flow when a file is deleted in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Version Path
|
data.target_path | string |
Full path to the specific file version. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
This operation triggers a flow when a file is locked
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target file or folder. |
Returns
This operation triggers a flow when a file is moved in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
File Path
|
data.target_path | string |
Full path to the file. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Source File Path
|
data.source_path | string |
Full original path to the file. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail. |
This operation triggers a flow when a file is renamed in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
File Path
|
data.target_path | string |
Full path to the renamed file |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Source File Path
|
data.source_path | string |
Full original path to the file. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail |
This operation triggers a flow when a file is unlocked
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target file or folder. |
Returns
This operation triggers a flow when a file is updated in specific Folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target file or folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File Entry ID
|
targetEntryId | string | |
File ID
|
targetGroupId | string | |
File Path
|
targetPath | string |
This operation triggers a flow when a sub-folder is copied in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Folder Path
|
data.target_path | string |
Full destination path to the folder |
Source Folder Path
|
data.source_path | string |
Full original path to the folder |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail |
This operation triggers a flow when a sub-folder is created in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Folder Path
|
data.target_path | string |
The full path to the folder. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail. |
This operation triggers a flow when a sub-folder is deleted in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Folder Path
|
data.target_path | string |
Full path to the deleted folder. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
This operation triggers a flow when a sub-folder is moved in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Folder Path
|
data.target_path | string |
Full destination path to the folder. |
Source Folder Path
|
data.source_path | string |
Full original path to the folder. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail |
This operation triggers a flow when a sub-folder is renamed in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Event ID
|
id | integer |
The ID of an individual event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Action
|
action | string |
The action associated with this event. |
Folder Path
|
data.target_path | string |
Full destination path to the folder. |
Source Folder Path
|
data.source_path | string |
Full original path to the folder. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
Object Detail
|
object_detail | string |
Object Detail |
This operation triggers a flow when a folder is unmarked as a project
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- FolderProjectCommon
This operation triggers a flow when a group is created
Returns
Name | Path | Type | Description |
---|---|---|---|
User ID
|
user.id | integer |
The unique identifier of the user. |
Full Name
|
user.fullName | string |
The full name of the user. |
Username
|
user.userName | string |
The username of the user. |
User email
|
user.email | string |
The email address of the user. |
User ID
|
owner.id | integer |
The unique identifier of the user. |
Full Name
|
owner.fullName | string |
The full name of the user. |
Username
|
owner.userName | string |
The username of the user. |
User email
|
owner.email | string |
The email address of the user. |
Group Name
|
groupName | string |
The name of the group. |
Group ID
|
groupId | string |
The unique identifier of the group. |
Members
|
members | array of GroupUser |
The members of the group. |
This operation triggers a flow when a group is deleted
Returns
Name | Path | Type | Description |
---|---|---|---|
User ID
|
user.id | integer |
The unique identifier of the user. |
Full Name
|
user.fullName | string |
The full name of the user. |
Username
|
user.userName | string |
The username of the user. |
User email
|
user.email | string |
The email address of the user. |
Group Name
|
groupName | string |
The name of the group. |
Group ID
|
groupId | string |
The unique identifier of the group. |
This operation triggers a flow when a group is updated
Returns
Name | Path | Type | Description |
---|---|---|---|
User ID
|
user.id | integer |
The unique identifier of the user. |
Full Name
|
user.fullName | string |
The full name of the user. |
Username
|
user.userName | string |
The username of the user. |
User email
|
user.email | string |
The email address of the user. |
User ID
|
owner.id | integer |
The unique identifier of the user. |
Full Name
|
owner.fullName | string |
The full name of the user. |
Username
|
owner.userName | string |
The username of the user. |
User email
|
owner.email | string |
The email address of the user. |
Group Name
|
groupName | string |
The name of the group. |
Group ID
|
groupId | string |
The unique identifier of the group. |
Action
|
action | string |
The specific action that triggered the group update. |
Members
|
members | array of GroupUser |
The members of the group. |
This operation triggers a flow when a project folder is created or when an existing folder is marked as a project folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- FolderProjectCommon
This operation triggers a flow when a project is updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
projectId
|
projectId | string | |
projectRootFolderId
|
projectRootFolderId | string | |
Project Name
|
name | string | |
Project Location
|
location | string | |
Project Status
|
status | string |
Project status (PENDING, IN PROGRESS, ON-HOLD, DONE, CANCELLED) |
This operation triggers a flow when a share link is created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- LinkWebhookResponse
This operation triggers a flow when a share link is deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- LinkWebhookResponse
This operation triggers a flow when a workflow is completed
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Workflow ID
|
workflow.id | string | |
Workflow Name
|
workflow.name | string | |
Workflow Display ID
|
workflow.displayId | number | |
Workflow Type
|
workflow.type | string | |
Workflow Template ID
|
workflow.templateId | string | |
Workflow Action Status
|
workflow.actionStatus | string | |
First Entity Type
|
firstEntity.type | string | |
First Entity Path
|
firstEntity.filePath | string | |
First Entity Entry ID
|
firstEntity.entryID | string | |
First Entity Group ID
|
firstEntity.groupID | string | |
Completion Status Code
|
completionStatusCode | string | |
Total Number of Steps
|
totalNumberOfSteps | number | |
Completion Date
|
completionDate | number |
This operation triggers a flow when a workflow is created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Workflow ID
|
workflow.id | string | |
Workflow Name
|
workflow.name | string | |
Workflow Display ID
|
workflow.displayId | number | |
Workflow Type
|
workflow.type | string | |
Workflow Template ID
|
workflow.templateId | string | |
Workflow Action Status
|
workflow.actionStatus | string | |
First Entity Type
|
firstEntity.type | string | |
First Entity Path
|
firstEntity.filePath | string | |
First Entity Entry ID
|
firstEntity.entryID | string | |
First Entity Group ID
|
firstEntity.groupID | string | |
JSON Definition
|
definitionJson | string |
This operation triggers a flow when an approval type workflow is approved
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- WorkflowStepResponse
This operation triggers a flow when an approval type workflow is rejected
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
- Body
- WorkflowStepResponse
This operation triggers a flow when a file or a folder metadata changes
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Target Path
|
targetPath | string | |
Target Group ID
|
targetGroupId | string | |
Namespace
|
namespace | string | |
Key
|
key | string | |
Action
|
action | string |
This operation triggers a flow when a file or a folder permissions changes
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Assigner
|
assignee | string | |
Assignee ID
|
assigneeId | number | |
Assigner
|
assigner | string | |
Assigner ID
|
assignerId | number | |
Folder Path
|
folderPath | string | |
New Privilege
|
newPrivilege | string | |
Old Privilege
|
oldPrivilege | string | |
Group Name
|
groupName | string |
Name | Path | Type | Description |
---|---|---|---|
User ID
|
id | integer |
The unique identifier of the user. |
Full Name
|
fullName | string |
The full name of the user. |
Username
|
userName | string |
The username of the user. |
User email
|
string |
The email address of the user. |
Name | Path | Type | Description |
---|---|---|---|
Source Path
|
sourcePath | string | |
Link ID
|
linkId | string | |
Link Type
|
linkType | string |
Folder or file |
Link URL
|
linkURL | string |
Name | Path | Type | Description |
---|---|---|---|
Checksum
|
checksum | string |
Checksum value of the current version of the file used to determine file changes. |
Size
|
size | integer |
Size of the file in bytes. |
File Path
|
path | string |
Full path of the file. |
Name
|
name | string |
Name of the file. |
Is locked
|
locked | boolean |
Status of the lock on the file. |
Is folder
|
is_folder | boolean |
Whether the resource is a folder. True or False |
Version ID
|
entry_id | string |
The ID of the current version of the file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Parent Folder ID
|
parent_id | string |
The ID of the parent folder requested. |
Last Modified
|
last_modified | string |
Last modified time of the current version of a file. |
Uploaded by
|
uploaded_by | string |
Username of the user that uploaded the version. |
Uploaded timestamp
|
uploaded | integer |
Uploaded time of the current version of the file. |
Number of versions
|
num_versions | integer |
The total number of versions associated with the specific file path. |
versions
|
versions | array of object |
Versions |
Is folder (version)
|
versions.is_folder | boolean |
Whether the resource is a folder. True or False |
Version ID
|
versions.entry_id | string |
The ID of the specific version of the file. |
Checksum (version)
|
versions.checksum | string |
Checksum value of the version of the file used to determine file changes. |
Last Modified (version)
|
versions.last_modified | string |
Last modified time of the specific version of a file. |
Uploaded by (version)
|
versions.uploaded_by | string |
Username of the user that uploaded the version. |
Uploaded timestamp (version)
|
versions.uploaded | integer |
Uploaded time of the specific version of the file. |
Size (version)
|
versions.size | integer |
Size of the file in bytes. |
User info
Name | Path | Type | Description |
---|---|---|---|
User ID
|
id | integer |
The user ID |
Username
|
userName | string |
The user's username |
External ID
|
externalId | string |
External ID |
Email
|
string |
User email |
|
Family name
|
name.familyName | string |
User family name (Last name) |
Given name
|
name.givenName | string |
User given name (First name) |
Active
|
active | boolean |
Is the user account active |
Created date
|
createdDate | string |
The date user was created |
Last modification date
|
lastModificationDate | string |
The last date user was modified |
Last active date
|
lastActiveDate | string |
The last date user was active |
Locked
|
locked | boolean |
User is locked |
Language
|
language | string |
The "language" parameter is accepted only when Language Pack has been enabled for the domain. |
Auth type
|
authType | string |
The authentication type for the user. |
User type
|
userType | string |
The type of the user. |
Role
|
role | string |
The role assigned to the user. Only applicable for Power Users. |
IDP user ID
|
idpUserId | string |
Identity provider user ID |
Is service account
|
isServiceAccount | boolean |
Is the account used as service account |
Delete on expiry
|
deleteOnExpiry | string |
Will the account be deleted after it expires |
Email change pending
|
emailChangePending | boolean |
Is the user email change pending |
Expiry date
|
expiryDate | string |
The expiration of the account |
User principal name
|
userPrincipalName | string | |
groups
|
groups | array of object | |
Display name
|
groups.displayName | string |
The name of the group |
Group ID
|
groups.value | string |
The ID of the group |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
Name of the folder. |
Last Modified
|
lastModified | integer |
The latest time that any file in the folder (but not within subfolders) has been modified. |
Uploaded Timestamp
|
uploaded | integer |
Time when the folder has been uploaded or created. |
Folder Path
|
path | string |
Full path of the folder. |
Folder ID
|
folder_id | string |
The unique ID of the folder. |
Parent Folder ID
|
parent_id | string |
The id of the parent folder. |
Subitems Count
|
total_count | integer |
The total number of items actually available to return. |
Is folder
|
is_folder | boolean |
Whether the resource is a folder. True or False |
Possible Public Links
|
public_links | string |
The folder option setting as to how "Allow public inks from this folder for" was set. |
Is shareable
|
allow_links | boolean |
Is shareable? T or F |
Can be deleted or moved
|
restrict_move_delete | boolean |
Can be deleted or moved? T or F |
folders
|
folders | array of object |
Folders |
Name (subfolder)
|
folders.name | string |
Name of the folder. |
Last Modified (subfolder)
|
folders.lastModified | integer |
The latest time that any file in the folder (but not within subfolders) has been modified. |
Uploaded Timestamp (subfolder)
|
folders.uploaded | integer |
Time when the folder has been uploaded or created. |
Path (subfolder)
|
folders.path | string |
The full path of the folder as requested. |
ID (subfolder)
|
folders.folder_id | string |
The ID of the folder requested. |
Is folder (subfolder)
|
folders.is_folder | boolean |
Whether the resource is a folder. True or False |
Parent Folder ID (subfolder)
|
folders.parent_id | string |
The id of the parent folder. |
files
|
files | array of object |
Files |
Checksum (file)
|
files.checksum | string |
Checksum value of the current version of the file used to determine file changes. |
Size (file)
|
files.size | integer |
Size of the file in bytes. |
Path (file)
|
files.path | string |
Full path of the file. |
Name (file)
|
files.name | string |
Name of the file. |
Is locked (file)
|
files.locked | boolean |
Status of the lock on the file. |
Is folder (file)
|
files.is_folder | boolean |
Whether the resource is a folder. True or False |
Version ID (file)
|
files.entry_id | string |
The ID of the specific version of the file. |
ID (file)
|
files.group_id | string |
The ID to reference the file as a whole. |
Parent Folder ID (file)
|
files.parent_id | string |
The ID of the parent folder. |
Last Modified (file)
|
files.last_modified | string |
Last modified time of the current version of a file. |
Uploaded by (file)
|
files.uploaded_by | string |
Username of the user that uploaded the version. |
Uploaded Timestamp (file)
|
files.uploaded | integer |
Uploaded time of the current version of the file. |
Versions Count (file)
|
files.num_versions | integer |
The total number of versions associated with the specific file path. |
Name | Path | Type | Description |
---|---|---|---|
Namespace name
|
name | string | |
Namespace scope
|
scope | string | |
keys
|
keys | object | |
displayName
|
displayName | string |
The name to identify the namespace in the UI |
priority
|
priority | number |
Specifies the priority (order) for the keys. The keys will be displayed in accordance with their priorities in descending order (keys with higher priority will be displayed first) |
inheritable
|
inheritable | boolean | |
schemaSystemGenerated
|
schemaSystemGenerated | boolean | |
metadataScopeType
|
metadataScopeType | string | |
editable
|
editable | boolean |
Name | Path | Type | Description |
---|---|---|---|
Id
|
id | string |
Item Id |
Root Folder Id
|
rootFolderId | string |
Root Folder Id |
Name
|
name | string |
The name of the project |
Project Id
|
projectId | string |
ID of the project |
Customer Name
|
customerName | string |
The customer associated with the project |
Description
|
description | string |
Folder description |
location
|
location | ProjectLocationItem | |
Status
|
status | string |
Status of the project |
Created By
|
createdBy | number |
Created By |
Last Updated By
|
lastUpdatedBy | number |
Last Updated By |
Creation Time
|
creationTime | string |
Creation Time |
Last Modified Time
|
lastModifiedTime | string |
Last Modified Time |
Start Date
|
startDate | string |
The start date of the project. |
Completion Date
|
completionDate | string |
The completion date for the project. |
Name | Path | Type | Description |
---|---|---|---|
Street Address 1
|
streetAddress1 | string |
First line of the street address |
Street Address 2
|
streetAddress2 | string |
Second line of the street address |
City
|
city | string |
City |
State or Province
|
state | string |
State or Province |
Country
|
country | string |
Country |
Zip code or postal code
|
postalCode | string |
Zip code or postal code |
Name | Path | Type | Description |
---|---|---|---|
File ID
|
targetGroupId | string | |
File Checksum
|
targetFileChecksum | string | |
File Path
|
targetPath | string |
Name | Path | Type | Description |
---|---|---|---|
projectId
|
projectId | string | |
projectRootFolderId
|
projectRootFolderId | string |
Name | Path | Type | Description |
---|---|---|---|
Workflow ID
|
workflow.id | string | |
Workflow Name
|
workflow.name | string | |
Workflow Display ID
|
workflow.displayId | number | |
Workflow Type
|
workflow.type | string | |
Workflow Template ID
|
workflow.templateId | string | |
Workflow Action Status
|
workflow.actionStatus | string | |
First Entity Type
|
firstEntity.type | string | |
First Entity Path
|
firstEntity.filePath | string | |
First Entity Entry ID
|
firstEntity.entryID | string | |
First Entity Group ID
|
firstEntity.groupID | string | |
Step ID
|
step.id | string | |
Step Name
|
step.name | string | |
Step Type
|
step.type | string | |
Assignee ID
|
assignee.id | number | |
Assignee Display Name
|
assignee.displayName | string | |
Assignee Username
|
assignee.username | string | |
Assignee Email
|
assignee.email | string | |
Total Number of Steps
|
totalNumberOfSteps | number | |
Completion Date
|
completionDate | number | |
Creation Date
|
creationDate | number |