次の方法で共有

Egnyte

Egnyte は、ファイルを安全に同期し、簡単に共有できるようにするサービスです。 Egnyte に接続してファイルを管理します。 Egnyte では、ファイルのアップロード、更新、取得、削除など、さまざまなアクションを実行できます。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate（パワーオートメート） Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Egnyte のサポート
URL https://helpdesk.egnyte.com
Email support@egnyte.com
コネクタ メタデータ
Publisher Egnyte
Website https://egnyte.com/
プライバシー ポリシー https://www.egnyte.com/privacy-policy
カテゴリ コラボレーション;生産性

Egnyte

Egnyte は、ファイルを安全に同期し、簡単に共有できるようにするコンテンツ コラボレーション プラットフォームです。 Egnyte に接続してファイルを管理します。 Egnyte では、ファイルのアップロード、移動、ダウンロード、削除など、さまざまなアクションを実行できます。

前提条件

コネクタを使用するには、Egnyte ユーザーである必要があります。

サポートされているアクション

コネクタでは、次のアクションがサポートされています。

サポートされているトリガー

コネクタでは、次のトリガーがサポートされています。

  • When a file is locked: この操作は、ファイルがロックされているときにフローをトリガーします。
  • When a file is unlocked: この操作は、ファイルのロックが解除されたときにフローをトリガーします。
  • When a file is updated: この操作は、特定のフォルダーでファイルが更新されたときにフローをトリガーします。
  • When a file is created (webhook): この操作は、ファイルが特定のフォルダーに作成されたときにフローをトリガーします。
  • When a share link is created: この操作は、共有リンクが作成されたときにフローをトリガーします。
  • When a share link is deleted: この操作は、共有リンクが削除されたときにフローをトリガーします。
  • When the file or folder permission changes: この操作は、ファイルまたはフォルダーのアクセス許可が変更されたときにフローをトリガーします
  • When the file or folder metadata changes: この操作は、ファイルまたはフォルダーのメタデータが変更されたときにフローをトリガーします。
  • When a project folder is created: この操作は、プロジェクト フォルダーが作成されたとき、または既存のフォルダーがプロジェクト フォルダーとしてマークされたときにフローをトリガーします。
  • When a folder is unmarked as a project: この操作は、フォルダーがプロジェクトとしてマークされていないときにフローをトリガーします。
  • When a project is updated: この操作は、プロジェクトが更新されたときにフローをトリガーします。
  • When a workflow is created: この操作は、ワークフローの作成時にフローをトリガーします。
  • When a workflow is completed: この操作は、ワークフローが完了したときにフローをトリガーします。
  • When an approval type workflow is approved: 承認の種類のワークフローが承認されると、この操作によってフローがトリガーされます。
  • When an approval type workflow is rejected: この操作は、承認の種類のワークフローが拒否されたときにフローをトリガーします。
  • When a group is created: この操作は、グループの作成時にフローをトリガーします。
  • When a group is updated: この操作は、グループが更新されたときにフローをトリガーします。
  • When a group is deleted: この操作は、グループが削除されたときにフローをトリガーします。
  • When a file is created (polling): この操作は、フォルダーに新しいファイルが作成されたときにフローをトリガーします。
  • When a folder is created: この操作は、サブフォルダーがフォルダーに作成されたときにフローをトリガーします。
  • When a file is deleted: この操作は、フォルダー内のファイルが削除されたときにフローをトリガーします。
  • When a folder is deleted: この操作は、フォルダー内のサブフォルダーが削除されたときにフローをトリガーします。
  • When a file is renamed: この操作は、フォルダー内のファイルの名前が変更されたときにフローをトリガーします。
  • When a folder is renamed: この操作は、フォルダー内のサブフォルダーの名前が変更されたときにフローをトリガーします。
  • When a file is moved: この操作は、ファイルがフォルダー内に移動されたときにフローをトリガーします。
  • When a folder is moved: この操作は、サブフォルダーがフォルダー内に移動されたときにフローをトリガーします。
  • When a file is copied: この操作は、ファイルがフォルダーにコピーされたときにフローをトリガーします。
  • When a folder is copied: この操作は、サブフォルダーがフォルダーにコピーされたときにフローをトリガーします。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

[AI]Egnyte Copilot に質問する

プラットフォームの副操縦士に質問し、Egnyte ドメイン内のグローバル コンテンツに基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[AI]ドキュメントについて質問する

特定のドキュメントに関連する質問をして、ドキュメントの内容に基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
[AI]ドキュメントの概要を生成する

特定のドキュメントの概要を生成し、ドキュメントの内容に基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
ID でファイルのロックを解除する

ID を使用してファイルのロックを解除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
ID でファイルの内容を取得する

ID を使用して Egnyte からファイルの内容を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
ID でファイルをコピーする

ID を使用してファイルをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
ID でファイルをロックする

ID を使用してファイルをロックします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
ID でファイルを削除する

ID を使用してファイルを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
ID でファイルを移動する

ファイル ID を使用して Egnyte 内のファイルを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
ID でファイル情報を取得する

ファイル ID を使用してファイル情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
ID でフォルダーをコピーする

ID を使用してフォルダーをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
ID でフォルダーを削除する

ID を使用してフォルダーを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
ID でフォルダーを移動する

ID を使用してフォルダーを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
ID でフォルダー情報を取得する

ID を使用してフォルダー情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
ID でプロジェクトをクリーンアップする

このエンドポイントは、プロジェクトでクリーンアップを開始し、必要に応じて、指定したユーザーを削除または無効にします。 https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
ID でプロジェクトを削除する

ID に基づいてプロジェクトを削除します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
ID でプロジェクトを取得する

ID を使用してプロジェクトを取得します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
ID でプロジェクトを更新する

ID で識別されるプロジェクトの指定されたプロパティを更新します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
ID でユーザーを更新する

1 人のユーザーを更新します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
ID によるディープ リンク

ID でファイルまたはフォルダーのディープ リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
ID によるユーザーの削除

Egnyte からユーザーを削除します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
V1 の検索

ファイル名、メタデータ、およびテキスト コンテンツに基づいて Egnyte に格納されているコンテンツを検索します。 https://developers.egnyte.com/api-docs/read/search-api#Search-v1
V2 を検索する

高度な検索機能を使用してコンテンツを検索します。 https://developers.egnyte.com/api-docs/read/search-api#Search-v2
すべてのグループの一覧を取得する

グループの一覧を取得します。 https://developers.egnyte.com/api-docs/read/group-management#List-Groups
すべてのプロジェクトを取得する

ドメイン内のすべてのプロジェクト フォルダーを一覧表示します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
すべてのユーザーの一覧を取得する

ユーザーに関する情報を取得します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
すべてのリンクを一覧表示する

削除されたリンクを除くすべてのリンクを一覧表示します。 このメソッドを実行しているユーザーが管理者でない場合は、ユーザーによって作成されたリンクのみが一覧表示されることに注意してください。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
すべてのリンクを一覧表示する V2

すべてのリンクを一覧表示します。 このメソッドを実行しているユーザーが管理者でない場合は、ユーザーによって作成されたリンクのみが一覧表示されることに注意してください。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
すべての名前空間を取得する

ドメイン内のすべてのカスタム メタデータ名前空間の一覧を取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
グループの作成

Egnyte でグループを作成します。 https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
グループの削除

ID でグループを削除します。 https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
グループの完全な更新

グループのすべての属性を上書きします。 https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
グループの詳細を取得する

ID を使用してグループ情報を取得します。 https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
グループの部分的な更新

グループの特定の属性を更新します。 https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group
テンプレートからプロジェクトを作成する

プロジェクト フォルダー テンプレートから新しいプロジェクトを作成します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
パスでファイルのロックを解除する

パスを使用してファイルのロックを解除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
パスでファイルの内容を取得する

パスを使用して Egnyte からファイルの内容を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
パスでファイルをコピーする

パスを使用してファイルをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
パスでファイルをロックする

パスを使用してファイルをロックします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
パスでファイルを削除する

パスを使用してファイルを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
パスでファイルを移動する

パスを使用して Egnyte 内のファイルを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
パスでファイル情報を取得する

パスを使用してファイル情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
パスでフォルダーをコピーする

パスを使用してフォルダーをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
パスでフォルダーを削除する

パスを使用してフォルダーを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
パスでフォルダーを移動する

パスを使用して Egnyte 内のフォルダーを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
パスでフォルダー情報を取得する

パスを使用してフォルダー情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
パスによるディープ リンク

パスでファイルまたはフォルダーのディープ リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
ファイル ID でメタデータを取得する

ファイル ID を使用してファイルからメタデータを取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
ファイル ID でメタデータを設定する

ファイル ID を使用してファイルにメタデータを書き込みます。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
ファイルを作成する

Egnyte にファイルをアップロードします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
ファイルを共有する

Egnyte でファイルを共有します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
フォルダー ID でメタデータを取得する

フォルダー ID を使用してフォルダーからメタデータを取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
フォルダー ID でメタデータを設定する

フォルダー ID を使用して、フォルダーにメタデータを書き込みます。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
フォルダー オプションを変更する

説明、リンク共有設定、パブリック リンクのアクセス許可、移動/削除の制限、電子メール通知の基本設定などのフォルダー オプションを変更します。 https://developers.egnyte.com/api-docs/read/folder-options-api
フォルダーのアクセス許可を取得する

フォルダーのアクセス許可を取得します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
フォルダーのアクセス許可を設定する

フォルダーのアクセス許可を設定します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
フォルダーをプロジェクトとしてマークする

既存のフォルダーをプロジェクトとしてマークします。 https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
フォルダーを作成する

Egnyte にフォルダーを作成します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
メタデータ キーを作成する

既存の名前空間にメタデータ キーを追加します。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
メタデータ キーを削除する

既存の名前空間からメタデータ キーを削除します。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
ユーザーの作成

Egnyte で新しいユーザーを作成します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
ユーザーの詳細を取得する

ID でユーザーに関する情報を取得します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
リンクの作成

リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
リンクの削除

リンクを削除します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
リンクの詳細を表示する

リンクの詳細を表示します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
ルート フォルダー ID でプロジェクトを取得する

ルート フォルダー ID に基づいてプロジェクトを取得します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
共有フォルダー

Egnyte でフォルダーを共有します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
名前空間を作成する

Egnyte で名前空間を作成します。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
名前空間を削除する

指定した名前空間を削除します。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
名前空間を取得する

特定の名前空間に作成されたすべてのカスタム メタデータ キーを一覧表示します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
名前空間キーを更新する

ドメインのカスタム メタデータのキーを更新します。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
名前空間属性を更新する

名前空間属性を更新します。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
有効なアクセス許可を取得する

ユーザーの有効なアクセス許可を取得します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
検索メタデータ

特定のメタデータ フィールドまたは値を持つアイテムを検索します。 https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

[AI]Egnyte Copilot に質問する

操作 ID:
copilotAsk

プラットフォームの副操縦士に質問し、Egnyte ドメイン内のグローバル コンテンツに基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Copilot

パラメーター

名前 キー 必須 型 説明
Question
 question True string

質問する特定の質問
フォルダー ID
 id string

選択したフォルダーの ID
ファイル エントリ ID
 entryId string

選択したファイルのエントリ ID
引用文献を含める
 includeCitations boolean

応答に引用文献を含める必要があるかどうか (既定値は false)
Role
 role string
メッセージの内容
 content string

戻り値

Body
AICopilotResponse

[AI]ドキュメントについて質問する

操作 ID:
askDocumentQuestion

特定のドキュメントに関連する質問をして、ドキュメントの内容に基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

パラメーター

名前 キー 必須 型 説明
ファイル エントリ ID
 entryId True string

特定のバージョンのファイルの ID
Question
 question True string

質問する特定の質問
引用文献を含める
 includeCitations boolean

応答に引用文献を含める必要があるかどうか (既定値は false)
Role
 role string
メッセージの内容
 content string

戻り値

Body
AIQuestionResponse

[AI]ドキュメントの概要を生成する

操作 ID:
summarizeDocument

特定のドキュメントの概要を生成し、ドキュメントの内容に基づいて AI 主導の応答を提供します。 https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

パラメーター

名前 キー 必須 型 説明
ファイル エントリ ID
 entryId True string

特定のバージョンのファイルの ID
Role
 role string
メッセージの内容
 content string

戻り値

Body
AISummaryResponse

ID でファイルのロックを解除する

操作 ID:
unlockFileById

ID を使用してファイルのロックを解除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte 内のファイルの一意識別子。
ロック トークン
 lock_token True string

ファイルの現在のロック トークン。

ID でファイルの内容を取得する

操作 ID:
getFileContentById

ID を使用して Egnyte からファイルの内容を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

パラメーター

名前 キー 必須 型 説明
ファイル ID
 fileId True string

Egnyte 内のファイルの一意識別子。

ID でファイルをコピーする

操作 ID:
copyFileById

ID を使用してファイルをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte でコピーするファイルの一意識別子。
変換先のファイル パス
 destination_path True string

ターゲット ファイル名を含む Egnyte の宛先ファイル パス。

戻り値

名前 パス 型 説明
ファイル パス
 path string

コピーしたファイルの完全なパス。
ファイル ID
 group_id string

ファイル全体を参照する ID。

ID でファイルをロックする

操作 ID:
lockFileById

ID を使用してファイルをロックします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte 内のファイルの一意識別子。

戻り値

名前 パス 型 説明
Timeout
 timeout integer

ファイルをロックする必要がある時間 (秒)。
ロック トークン
 lock_token string

ファイルのロック解除に使用する必要があるトークン。

ID でファイルを削除する

操作 ID:
deleteFileById

ID を使用してファイルを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte から削除するファイルの一意識別子。

戻り値

名前 パス 型 説明
親フォルダー パス
 parent_folder_path string

削除されたファイルの親フォルダーへのパス。

ID でファイルを移動する

操作 ID:
moveFileById

ファイル ID を使用して Egnyte 内のファイルを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte 内のファイルの一意識別子。
変換先のファイル パス
 destination_path True string

Egnyte の宛先ファイル パス。 ターゲット ファイル名を含む。

戻り値

名前 パス 型 説明
ファイル パス
 path string

移動されたファイルの完全なパス。
ファイル ID
 group_id string

ファイル全体を参照する ID。

ID でファイル情報を取得する

操作 ID:
fileInfoById

ファイル ID を使用してファイル情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

パラメーター

名前 キー 必須 型 説明
ファイル ID
 id True string

Egnyte 内のファイルの一意識別子。

戻り値

Body
FileInfoResponse

ID でフォルダーをコピーする

操作 ID:
copyFolderById

ID を使用してフォルダーをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 id True string

Egnyte でコピーするフォルダーの一意識別子。
コピー先フォルダーのパス
 destination_path True string

Egnyte の宛先フォルダー のパス。

戻り値

名前 パス 型 説明
フォルダー パス
 path string

コピーしたフォルダーの完全なパス。
フォルダー ID
 folder_id string

コピーしたフォルダーの一意の ID。

ID でフォルダーを削除する

操作 ID:
deleteFolderById

ID を使用してフォルダーを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 id True string

Egnyte から削除するフォルダーの一意識別子。

戻り値

名前 パス 型 説明
親フォルダー パス
 parent_folder_path string

削除されたフォルダーの親フォルダーへのパス。

ID でフォルダーを移動する

操作 ID:
moveFolderById

ID を使用してフォルダーを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 id True string

Egnyte 内のフォルダーの一意識別子。
コピー先フォルダーのパス
 destination_path True string

Egnyte の宛先フォルダー のパス。

戻り値

名前 パス 型 説明
フォルダー パス
 path string

移動したフォルダーの完全なパス。
フォルダー ID
 folder_id string

移動されたフォルダーの一意の ID。

ID でフォルダー情報を取得する

操作 ID:
folderInfoById

ID を使用してフォルダー情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 id True string

Egnyte 内のフォルダーの一意識別子。

戻り値

Body
FolderInfoResponse

ID でプロジェクトをクリーンアップする

操作 ID:
cleanupProject

このエンドポイントは、プロジェクトでクリーンアップを開始し、必要に応じて、指定したユーザーを削除または無効にします。 https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

パラメーター

名前 キー 必須 型 説明
プロジェクト ID
 projectId True string

プロジェクト ID
deleteLinks
 deleteLinks True boolean

true に設定すると、プロジェクト内の既存のアクティブなリンクがすべて削除されます。
usersToDelete
 usersToDelete array of integer

削除するユーザー ID の一覧。
usersToDisable
 usersToDisable array of integer

無効にするユーザー ID の一覧。

戻り値

名前 パス 型 説明
メッセージ
 message string

ID でプロジェクトを削除する

操作 ID:
deleteProjectById

ID に基づいてプロジェクトを削除します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

パラメーター

名前 キー 必須 型 説明
プロジェクト ID
 projectId True string

削除されるプロジェクトの ID

ID でプロジェクトを取得する

操作 ID:
getProjectById

ID を使用してプロジェクトを取得します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

パラメーター

名前 キー 必須 型 説明
プロジェクト ID
 projectId True string

プロジェクト ID

戻り値

Body
ProjectItem

ID でプロジェクトを更新する

操作 ID:
updateProjectById

ID で識別されるプロジェクトの指定されたプロパティを更新します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

パラメーター

名前 キー 必須 型 説明
名前
 name True string

フォルダーの新しい名前。
説明
 description string

フォルダーの新しい説明。
projectId
 projectId True string

プロジェクトの ID。
customProjectId
 customProjectId string

プロジェクトのカスタム ID。
顧客名
 customerName string

プロジェクトに関連付けられている顧客。
通り住所1
 streetAddress1 string

番地の最初の行。
通りの住所2
 streetAddress2 string

番地の 2 行目。
city
 city string

City :
状態
 state string

州または都道府県。
postalCode
 postalCode string

郵便番号。
country
 country string

ISO 3166 GENC プロファイルの 3 文字の国コードを使用します (例: 米国、GBR、POL)。
状態
 status True string

プロジェクトの現在の状態。
startDate
 startDate string

ISO 8601 形式のプロジェクトの開始日。
完了日
 completionDate string

プロジェクトの完了予定日を ISO 8601 形式で指定します。

ID でユーザーを更新する

操作 ID:
updateUser

1 人のユーザーを更新します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

パラメーター

名前 キー 必須 型 説明
ユーザーID
 id True integer

ユーザーの一意識別子
ユーザーの電子メール
 email string

ユーザーの電子メール アドレス。
指定された名前
 givenName string

ユーザーの名。
姓
 familyName string

ユーザーの姓。
Active
 active boolean

ユーザーがアクティブか非アクティブか。
招待を送信する
 sendInvite boolean

true に設定すると、招待メールが送信されます。 パラメーターは、このアクションによって変更された唯一のパラメーターにすることはできません。
Language
 language string

"language" パラメーターは、言語パックがドメインに対して有効になっている場合にのみ受け入れられます。
認証の種類
 authType string

ユーザーの認証の種類。
ユーザー タイプ
 userType string

ユーザーの種類。
Role
 role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
IDP ユーザー ID
 idpUserId string

ユーザーが SSO 認証され、既定のユーザー マッピングを使用していない場合にのみ必要です
ユーザー プリンシパル名
 userPrincipalName string

ユーザーが AD 認証されていないかどうかを指定しないでください。

戻り値

名前 パス 型 説明
ユーザーID
 id integer

ユーザーの一意識別子
ユーザーの電子メール
 email string

ユーザーの電子メール アドレス。
姓
 familyName string

ユーザーの姓。
指定された名前
 givenName string

ユーザーの名。
Active
 active boolean

ユーザーがアクティブか非アクティブか。
招待を送信する
 sendInvite boolean

true に設定すると、招待メールが送信されます。
Language
 language string

言語パックが有効になっている場合にのみ受け入れられます。
認証の種類
 authType string

ユーザーの認証の種類。
ユーザー タイプ
 userType string

ユーザーの種類。
Role
 role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
IDP ユーザー ID
 idpUserId string

ユーザーが SSO 認証されている場合にのみ必要です
ユーザー プリンシパル名
 userPrincipalName string

ユーザーが AD 認証されていないかどうかを指定しないでください。

ID によるディープ リンク

操作 ID:
deepLinksById

ID でファイルまたはフォルダーのディープ リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

パラメーター

名前 キー 必須 型 説明
ID (アイディー)
 id True string

ファイルまたはフォルダーの ID
タイプ
 type True string

リンクの種類

戻り値

名前 パス 型 説明
ウェブアドレス
 url string

ディープ リンク

ID によるユーザーの削除

操作 ID:
deleteUser

Egnyte からユーザーを削除します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

パラメーター

名前 キー 必須 型 説明
ユーザーID
 id True integer

削除するユーザーの ID

V1 の検索

操作 ID:
searchV1

ファイル名、メタデータ、およびテキスト コンテンツに基づいて Egnyte に格納されているコンテンツを検索します。 https://developers.egnyte.com/api-docs/read/search-api#Search-v1

パラメーター

名前 キー 必須 型 説明
検索クエリ
 query True string

検索する検索文字列。
オフセット
 offset integer

要求される最初のレコードの 0 から始まるインデックス。
数える
 count integer

1 ページあたりのエントリ数。
フォルダー
 folder string

指定したフォルダーと子孫のアイテムに結果を制限します。
変更前
 modifiedBefore string

この ISO-8601 タイムスタンプより前に変更されたアイテムに結果を制限します。
変更後
 modifiedAfter string

この ISO-8601 タイムスタンプの後に変更された項目に結果を制限します。
アップロード前
 uploadedBefore string

この ISO-8601 タイムスタンプの前にアップロードされたアイテムに結果を制限します。
アップロード後
 uploadedAfter string

この ISO-8601 タイムスタンプの後にアップロードされたアイテムに結果を制限します。
タイプ
 type string

検索する項目の種類。
要求されたスニペット
 snippetRequested boolean

検索結果にスニペットを含める必要があるかどうか。
並べ替え順
 sortBy string

並べ替えに使用するフィールド。
並べ替えの方向
 sortDirection string

並べ替えの方向。
ファイル クエリ フィールド
 fileQueryFields string

特定のフィールドを使用してファイルを検索します。
フォルダー クエリ フィールド
 folderQueryFields string

特定のフィールドを使用してフォルダーを検索します。
クエリ演算子
 queryOperator string

すべての単語または任意の単語を検索します。

戻り値

名前 パス 型 説明
results
 results array of object
ファイル名
 results.name string
ファイル パス
 results.path string
MIME の種類
 results.type string
ファイル サイズ
 results.size integer
抜粋
 results.snippet string
HTML スニペット
 results.snippet_html string
エントリ ID
 results.entry_id string
グループ識別子
 results.group_id string
最終更新日時
 results.last_modified string
アップロード者
 results.uploaded_by string
ユーザー名でアップロード
 results.uploaded_by_username string
バージョンの数
 results.num_versions integer
Is Folder
 results.is_folder boolean
総計
 total_count integer
オフセット
 offset integer
数える
 count integer

V2 を検索する

操作 ID:
searchV2

高度な検索機能を使用してコンテンツを検索します。 https://developers.egnyte.com/api-docs/read/search-api#Search-v2

パラメーター

名前 キー 必須 型 説明
検索クエリ
 query True string

検索する検索文字列。
オフセット
 offset integer

要求される最初のレコードの 0 から始まるインデックス。
数える
 count integer

1 ページあたりのエントリ数。
フォルダー
 folder string

指定したフォルダーと子孫のアイテムに結果を制限します。
変更前
 modifiedBefore integer

この Unix タイムスタンプの前に変更された項目に結果をミリ秒単位で制限します。
変更後
 modifiedAfter integer

この Unix タイムスタンプの後に変更された項目に結果をミリ秒単位で制限します。
アップロード前
 uploadedBefore integer

この Unix タイムスタンプの前にアップロードされたアイテムに結果をミリ秒単位で制限します。
アップロード後
 uploadedAfter integer

この Unix タイムスタンプの後にアップロードされたアイテムに結果をミリ秒単位で制限します。
タイプ
 type string

検索する項目の種類。
要求されたスニペット
 snippetRequested boolean

検索結果にスニペットを含める必要があるかどうか。
並べ替え順
 sortBy string

並べ替えに使用するフィールド。
並べ替えの方向
 sortDirection string

並べ替えの方向。
ファイル クエリ フィールド
 fileQueryFields array of string

特定のフィールドを使用してファイルを検索します。
フォルダー クエリ フィールド
 folderQueryFields array of string

特定のフィールドを使用してフォルダーを検索します。
クエリ演算子
 queryOperator string

すべての単語または任意の単語を検索します。
この例の詳細 (ドキュメント ID)
 mlt array of string

類似のドキュメント検索の参照として使用するドキュメント ID の配列。
もっといいね! (テキスト)
 mltt array of string

類似のドキュメント検索の参照として使用するテキスト コンテンツの配列。

戻り値

名前 パス 型 説明
results
 results array of object
ファイル名
 results.name string
ファイル パス
 results.path string
MIME の種類
 results.type string
ファイル サイズ
 results.size integer
抜粋
 results.snippet string
HTML スニペット
 results.snippet_html string
エントリ ID
 results.entry_id string
グループ識別子
 results.group_id string
最終更新日時
 results.last_modified string
アップロード者
 results.uploaded_by string
ユーザー名でアップロード
 results.uploaded_by_username string
バージョンの数
 results.num_versions integer
Is Folder
 results.is_folder boolean
カスタム プロパティ
 results.custom_properties array of object
Scope
 results.custom_properties.scope string
Namespace
 results.custom_properties.namespace string
Key
 results.custom_properties.key string
価値
 results.custom_properties.value string
関連性スコア
 results.score number
総計
 total_count integer
数える
 count integer
結果が多い
 hasMore boolean

すべてのグループの一覧を取得する

操作 ID:
listGroups

グループの一覧を取得します。 https://developers.egnyte.com/api-docs/read/group-management#List-Groups

パラメーター

名前 キー 必須 型 説明
開始インデックス
 startIndex integer

要求される初期レコードの 1 から始まるインデックス (整数≥ 1)。
数える
 count integer

ページあたりのエントリ数 (最小 1、最大 100)
Filter
 filter string

グループのサブセットを要求できます。 これらの用語では大文字と小文字は区別されません

戻り値

名前 パス 型 説明
合計結果
 totalResults integer

クエリに一致する結果の合計数。
ページあたりのアイテム数
 itemsPerPage integer

返された結果の数。
インデックスの開始
 startIndex integer

現在の結果セットの最初の結果の 1 から始まるインデックス。
resources
 resources array of object
グループ識別子
 resources.id string

グローバルに一意のグループ ID。
グループ名
 resources.displayName string

グループの名前を指定します。

すべてのプロジェクトを取得する

操作 ID:
getAllProjects

ドメイン内のすべてのプロジェクト フォルダーを一覧表示します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

戻り値

response
array of ProjectItem

すべてのユーザーの一覧を取得する

操作 ID:
getUserList

ユーザーに関する情報を取得します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

パラメーター

名前 キー 必須 型 説明
開始インデックス
 startIndex integer

最初の検索結果の 1 から始まるインデックス。
数える
 count integer

1 ページあたりの検索結果の最大数を指定します。
Filter
 filter string

ユーザーのサブセットを要求できます。 「バージョン情報」セクションのドキュメントを参照してください。

戻り値

ユーザー リストの応答を取得する

Body
UserListResponse

すべてのリンクを一覧表示する

操作 ID:
listLinks

削除されたリンクを除くすべてのリンクを一覧表示します。 このメソッドを実行しているユーザーが管理者でない場合は、ユーザーによって作成されたリンクのみが一覧表示されることに注意してください。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

パラメーター

名前 キー 必須 型 説明
経路
 path string

完全なパスで指定されたファイルまたはフォルダーへのリンクを一覧表示します。
ユーザー名
 username string

このユーザーによって作成されたリンクを一覧表示します。
前に作成済み
 createdBefore string

特定の日付より前に作成されたリンクを一覧表示します (ISO-8601 または YYYY-MM-DD)。
作成後
 createdAfter string

特定の日付より後に作成されたリンクを一覧表示します (ISO-8601 または YYYY-MM-DD)。
タイプ
 type string

"ファイル" または "フォルダー" アイテムのみにフィルター処理します。
Accessibility
 accessibility string

アクセシビリティの種類を選択する
オフセット
 offset string

要求される最初のレコードの 0 から始まるインデックス。
Count (既定では 500 エントリが返されます)
 count string

1 ページあたりのエントリ数を制限します。

戻り値

名前 パス 型 説明
Ids
 ids array of string

このユーザーが表示できるドメインのすべてのリンクの ID を含む配列。
オフセット
 offset number

要求される最初のレコードの 0 から始まるインデックス。
数える
 count number

返された項目の数。 このフィールドが指定されていない場合、カウント値は 0 になります。
総件数
 total_count number

ドメイン内のユーザーに表示されるリンクの数。

すべてのリンクを一覧表示する V2

操作 ID:
listLinksV2

すべてのリンクを一覧表示します。 このメソッドを実行しているユーザーが管理者でない場合は、ユーザーによって作成されたリンクのみが一覧表示されることに注意してください。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

パラメーター

名前 キー 必須 型 説明
経路
 path string

完全なパスで指定されたファイルまたはフォルダーへのリンクを一覧表示します。
ユーザー名
 username string

このユーザーによって作成されたリンクを一覧表示します。
前に作成済み
 createdBefore string

特定の日付より前に作成されたリンクを一覧表示します (ISO-8601 または YYYY-MM-DD)。
作成後
 createdAfter string

特定の日付より後に作成されたリンクを一覧表示します (ISO-8601 または YYYY-MM-DD)。
タイプ
 type string

"ファイル" または "フォルダー" アイテムのみにフィルター処理します。
Accessibility
 accessibility string

アクセシビリティの種類を選択する
オフセット
 offset string

要求される最初のレコードの 0 から始まるインデックス。
Count (既定では 500 エントリが返されます)
 count string

1 ページあたりのエントリ数を制限します。

戻り値

名前 パス 型 説明
Links
 links array of object

このユーザーが指定した範囲内で表示できるドメインのすべてのリンクの完全な json 情報を含む配列
経路
 links.path string

ターゲット リソースの絶対パス (ファイルまたはフォルダー)。
タイプ
 links.type string

リンクの種類 (ファイル、フォルダー、またはアップロード)
Accessibility
 links.accessibility string

リンクにアクセスできるユーザー(だれか、パスワード、ドメイン、受信者のいずれか)。
保護
 links.protection string

ファイル (またはフォルダー) リンクの "PREVIEW" の場合、ファイル (フォルダー) へのプレビュー専用のリンクです。それ以外の場合は "NONE" です
受取人
 links.recipients array of string

リンクが送信された有効な電子メール アドレスの配列。
Notify
 links.notify boolean

リンクにアクセスしたときに、リンク作成者に電子メールで通知を受け取るかどうかに関するブール値。
ウェブアドレス
 links.url string

リンクの完全な URL
ID (アイディー)
 links.id string

リンクの ID
現在のリンク
 links.link_to_current boolean

リンクが常に現在のバージョンのファイルを参照するかどうかに関するブール値。 ファイル リンクにのみ適用されます。
作成日
 links.creation_date string

リンクの作成日時
作成者
 links.created_by string

リンクを作成したユーザーのユーザー名
リソース ID
 links.resource_id string

関連付けられているリソースの ID。ファイル リンクの場合はグループ ID、フォルダーまたはアップロード リンクの場合はフォルダー ID
[Expiry clicks]\(有効期限\) のクリック数
 links.expiry_clicks number

有効期限が切れる前にリンクをクリックした回数。 このフィールドは、クリックによってリンクの有効期限が切れる場合にのみ表示されます
最後にアクセスされた
 links.last_accessed string

リンクの最後のアクセスの日付と時刻。 このフィールドは、リンクが少なくとも 1 回アクセスされている場合にのみ表示されます
有効期限日
 links.expiry_date string

リンクの有効期限の日付と時刻。 このフィールドは、リンクの有効期限が日付までに切れる場合にのみ表示されます
数える
 count number

返されるドメイン内のユーザーに表示されるリンクの数

すべての名前空間を取得する

操作 ID:
getAllNamespaces

ドメイン内のすべてのカスタム メタデータ名前空間の一覧を取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

戻り値

response
array of NamespaceItem

グループの作成

操作 ID:
createGroup

Egnyte でグループを作成します。 https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

パラメーター

名前 キー 必須 型 説明
[表示名]
 displayName True string

グループの表示名。
ユーザーID
 value string

グループ メンバーのグローバルに一意の ID。

戻り値

名前 パス 型 説明
グループ識別子
 id string

作成されたグループの ID。
ディスプレイ名
 displayName string

グループの表示名。
members
 members array of object

グループ メンバー
ユーザー名
 members.username string

メンバーのユーザー名。
ユーザーID
 members.value number

メンバーのユーザー ID。
ユーザー表示名
 members.display string

メンバーの表示名。

グループの削除

操作 ID:
deleteGroup

ID でグループを削除します。 https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

パラメーター

名前 キー 必須 型 説明
グループ ID
 id True string

グループ ID。

グループの完全な更新

操作 ID:
fullGroupUpdate

グループのすべての属性を上書きします。 https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

パラメーター

名前 キー 必須 型 説明
グループ識別子
 id True string

作成されたグループの ID。
[表示名]
 displayName True string

グループの表示名。
ユーザーID
 value integer

グループ メンバーのグローバルに一意の ID。

戻り値

名前 パス 型 説明
グループ識別子
 id string

作成されたグループの ID。
ディスプレイ名
 displayName string

グループの表示名。
members
 members array of object

グループ メンバー
ユーザー名
 members.username string

メンバーのユーザー名。
ユーザーID
 members.value number

メンバーのユーザー ID。
ユーザー表示名
 members.display string

メンバーの表示名。

グループの詳細を取得する

操作 ID:
groupInfoById

ID を使用してグループ情報を取得します。 https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

パラメーター

名前 キー 必須 型 説明
グループ識別子
 id True string

グループの ID。

戻り値

名前 パス 型 説明
グループ識別子
 id string

グローバルに一意のグループ ID。
グループ名
 displayName string

グループの名前を指定します。
members
 members array of object

グループ メンバー
グループ識別子
 members.username string

グループ メンバーのユーザー名
ユーザーID
 members.value number

グループ メンバーのグローバルに一意の ID。
ユーザー表示名
 members.display string

グループ メンバーの表示名。

グループの部分的な更新

操作 ID:
partialGroupUpdate

グループの特定の属性を更新します。 https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

パラメーター

名前 キー 必須 型 説明
グループ識別子
 id True string

作成されたグループの ID。
[表示名]
 displayName string

グループの表示名。
ユーザーID
 value integer

グループ メンバーのグローバルに一意の ID。
操作
 operation string

グループに対して実行するアクション。

戻り値

名前 パス 型 説明
グループ識別子
 id string

作成されたグループの ID。
ディスプレイ名
 displayName string

グループの表示名。
members
 members array of object

グループ メンバー
ユーザー名
 members.username string

メンバーのユーザー名。
ユーザーID
 members.value number

メンバーのユーザー ID。
ユーザー表示名
 members.display string

メンバーの表示名。

テンプレートからプロジェクトを作成する

操作 ID:
createProjectFromTemplate

プロジェクト フォルダー テンプレートから新しいプロジェクトを作成します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

パラメーター

名前 キー 必須 型 説明
親フォルダー ID
 parentFolderId True string

プロジェクト フォルダーが作成される親フォルダーのフォルダー ID
テンプレート フォルダー ID
 templateFolderId True string

プロジェクト フォルダー テンプレートのフォルダー ID
フォルダー名
 folderName True string

作成される新しいフォルダーの名前
名前
 name True string

プロジェクトの名前
Description
 description string

フォルダーの説明
プロジェクト ID
 projectId string

プロジェクトのカスタム ID
顧客名
 customerName string

プロジェクトに関連付けられている顧客
ステータス
 status True string

プロジェクトの状態
開始日 (例: 2023-12-31T23:59:59)
 startDate date-time

プロジェクトの開始日。
終了日 (例: 2023-12-31T23:59:59)
 completionDate date-time

プロジェクトの完了日。
番地 1
 streetAddress1 string

住所の 1 行目
番地 2
 streetAddress2 string

番地の 2 行目
市区町村
 city string

市区町村
都道府県
 state string

都道府県
Country
 country string

Country
郵便番号または郵便番号
 postalCode string

郵便番号または郵便番号

戻り値

名前 パス 型 説明
groupsCreated
 groupsCreated array of object
プロジェクト ID
 groupsCreated.id string

プロジェクト ID
プロジェクト名
 groupsCreated.name string

プロジェクト名

パスでファイルのロックを解除する

操作 ID:
unlockFileByPath

パスを使用してファイルのロックを解除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

パラメーター

名前 キー 必須 型 説明
ファイル パス
 path True string

Egnyte 内のファイルへの一意のパス。
ロック トークン
 lock_token True string

ファイルの現在のロック トークン。

パスでファイルの内容を取得する

操作 ID:
getFileContentByPath

パスを使用して Egnyte からファイルの内容を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

パラメーター

名前 キー 必須 型 説明
ファイル パス
 filePath True string

Egnyte 内のファイルへの一意のパス。

パスでファイルをコピーする

操作 ID:
copyFileByPath

パスを使用してファイルをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ソース ファイル
 path True string

ターゲット ファイル名を含む Egnyte のソース ファイル パス。
変換先ファイル
 destination_path True string

ターゲット ファイル名を含む Egnyte の宛先ファイル パス。

戻り値

名前 パス 型 説明
ファイル パス
 path string

コピーしたファイルの完全なパス。
ファイル ID
 group_id string

ファイル全体を参照する ID。

パスでファイルをロックする

操作 ID:
lockFileByPath

パスを使用してファイルをロックします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

パラメーター

名前 キー 必須 型 説明
ターゲット ファイル パス
 path True string

Egnyte のターゲット ファイル パス (ターゲット ファイル名を含む)。

戻り値

名前 パス 型 説明
Timeout
 timeout integer

ファイルをロックする必要がある時間 (秒)。
ロック トークン
 lock_token string

ファイルのロック解除に使用する必要があるトークン。

パスでファイルを削除する

操作 ID:
deleteFileByPath

パスを使用してファイルを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ファイル パス
 path True string

ターゲット ファイル名を含む Egnyte のファイル パス。

戻り値

名前 パス 型 説明
親フォルダー パス
 parent_folder_path string

削除されたファイルの親フォルダーへのパス

パスでファイルを移動する

操作 ID:
moveFileByPath

パスを使用して Egnyte 内のファイルを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ソース パス
 path True string

ソース ファイルへのパス。
変換先のファイル パス
 destination_path True string

ターゲット ファイル名を含む Egnyte の宛先ファイル パス。

戻り値

名前 パス 型 説明
ファイル パス
 path string

移動されたファイルの完全なパス。
ファイル ID
 group_id string

ファイル全体を参照する ID。

パスでファイル情報を取得する

操作 ID:
fileInfoByPath

パスを使用してファイル情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

パラメーター

名前 キー 必須 型 説明
ファイル パス
 path True string

Egnyte 内のファイルへの一意のパス。

戻り値

Body
FileInfoResponse

パスでフォルダーをコピーする

操作 ID:
copyFolderByPath

パスを使用してフォルダーをコピーします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ソース フォルダー パス
 path True string

Egnyte のソース フォルダー パス。
コピー先フォルダーのパス
 destination_path True string

Egnyte の宛先フォルダー のパス。

戻り値

名前 パス 型 説明
フォルダー パス
 path string

コピーしたフォルダーの完全なパス。
フォルダー ID
 folder_id string

コピーしたフォルダーの一意の ID。

パスでフォルダーを削除する

操作 ID:
deleteFolderByPath

パスを使用してフォルダーを削除します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

削除するターゲット フォルダー名を含む Egnyte のフォルダー パス。

戻り値

名前 パス 型 説明
親フォルダー パス
 parent_folder_path string

削除されたフォルダーの親フォルダーへのパス。

パスでフォルダーを移動する

操作 ID:
moveFolderByPath

パスを使用して Egnyte 内のフォルダーを移動します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

パラメーター

名前 キー 必須 型 説明
ソース パス
 path True string

ソース フォルダーへのパス。
コピー先フォルダーのパス
 destination_path True string

Egnyte の宛先フォルダー のパス。

戻り値

名前 パス 型 説明
フォルダー パス
 path string

移動したフォルダーの完全なパス。
フォルダー ID
 folder_id string

移動されたフォルダーの一意の ID。

パスでフォルダー情報を取得する

操作 ID:
folderInfoByPath

パスを使用してフォルダー情報を取得します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

Egnyte 内のフォルダーへの一意のパス。

戻り値

Body
FolderInfoResponse

パスによるディープ リンク

操作 ID:
deepLinksByPath

パスでファイルまたはフォルダーのディープ リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

パラメーター

名前 キー 必須 型 説明
経路
 path True string

ファイルまたはフォルダーのパス

戻り値

名前 パス 型 説明
ウェブアドレス
 url string

ディープ リンク

ファイル ID でメタデータを取得する

操作 ID:
getMetadataByFileId

ファイル ID を使用してファイルからメタデータを取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

パラメーター

名前 キー 必須 型 説明
ファイル ID
 fileId True string

Egnyte 内のファイルの一意識別子。
名前空間名
 namespace True string

名前空間の名前。

ファイル ID でメタデータを設定する

操作 ID:
setMetadataByFileId

ファイル ID を使用してファイルにメタデータを書き込みます。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

パラメーター

名前 キー 必須 型 説明
ファイル ID
 fileId True string

Egnyte 内のファイルの一意識別子。
名前空間名
 namespaceName True string

名前空間の名前。
メタデータ キー名
 metadataName True string

値を割り当てるキーの名前。
メタデータ値
 metadataValue string

設定するメタデータ値。

ファイルを作成する

操作 ID:
createFile

Egnyte にファイルをアップロードします。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

パラメーター

名前 キー 必須 型 説明
ファイル名
 Name True string

Egnyte で作成するファイルの名前。
フォルダー パス
 Path True string

Egnyte にファイルをアップロードするフォルダー パス。
ファイル コンテンツ
 body True binary

Egnyte にアップロードするファイルの内容。

戻り値

名前 パス 型 説明
バージョン ID
 id string

ファイルの現在のバージョンの ID。
ファイル ID
 group_id string

ファイル全体を参照する ID。
ファイル パス
 path string

アップロードされたファイルの完全なパス。

ファイルを共有する

操作 ID:
shareFile

Egnyte でファイルを共有します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

パラメーター

名前 キー 必須 型 説明
ファイル パス
 path True string

共有するターゲット ファイル名を含む Egnyte のファイル パス。

戻り値

名前 パス 型 説明
links
 links array of object

Links
リンク ID
 links.id string

リンクの ID。
リンク URL
 links.url string

リンクの完全な URL。
受取人
 links.recipients array of string

リンクが送信された有効な電子メール アドレスの配列。
ファイル パス
 path string

共有ファイルの完全なパス。
タイプ
 type string

ファイル、フォルダー、またはアップロードのいずれかのリンクの種類。
Accessibility
 accessibility string

リンクにアクセスできるユーザー(だれか、パスワード、ドメイン、受信者のいずれか)。
アクセス時に作成者に通知する
 notify boolean

リンクにアクセスしたときに、リンク作成者に電子メールで通知を受け取るかどうか。
バージョンを参照しています
 link_to_current boolean

このバージョンは現在のバージョンですか? T または F
有効期限
 expiry_date string

リンクの有効期限の日付と時刻。
[作成日付]
 creation_date string

リンクの作成日時。
作成者
 created_by string

リンクを作成したユーザーのユーザー名。

フォルダー ID でメタデータを取得する

操作 ID:
getMetadataByFolderId

フォルダー ID を使用してフォルダーからメタデータを取得します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 folderId True string

Egnyte 内のフォルダーの一意識別子。
名前空間名
 namespace True string

名前空間の名前。

フォルダー ID でメタデータを設定する

操作 ID:
setMetadataByFolderId

フォルダー ID を使用して、フォルダーにメタデータを書き込みます。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

パラメーター

名前 キー 必須 型 説明
フォルダー ID
 folderId True string

Egnyte 内のフォルダーの一意識別子。
名前空間名
 namespaceName True string

名前空間の名前。
メタデータ キー名
 metadataName True string

値を割り当てるキーの名前。
メタデータ値
 metadataValue True string

設定するメタデータ値。

フォルダー オプションを変更する

操作 ID:
modifyFolderOptions

説明、リンク共有設定、パブリック リンクのアクセス許可、移動/削除の制限、電子メール通知の基本設定などのフォルダー オプションを変更します。 https://developers.egnyte.com/api-docs/read/folder-options-api

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

Egnyte 内のフォルダーへの一意のパス。
フォルダーの説明
 folder_description string

フォルダの説明。
リンクを許可する
 allow_links boolean

リンクをこのフォルダー内のファイルまたはサブフォルダーに共有できるかどうかを選択します。
パブリック リンク
 public_links string

許可するパブリック リンクの種類を指定します。 使用可能な値: files_folders、ファイル、無効。
移動/削除を制限する
 restrict_move_delete boolean

移動操作と削除操作をフォルダー所有者と管理者のみに制限します。
コンテンツ更新通知
 content_updates boolean

コンテンツの更新に関する電子メール通知を有効にします。
コンテンツ アクセス通知
 content_accessed boolean

アクセスされたコンテンツの電子メール通知を有効にします。

戻り値

名前 パス 型 説明
名前
 name string

フォルダーの名前。
最終更新日時
 lastModified integer

フォルダー内のファイル (サブフォルダー内ではない) が変更された最新時刻。
フォルダー パス
 path string

フォルダーの完全なパス。
フォルダー ID
 folder_id string

フォルダーの一意の ID。
フォルダーの説明
 folder_description string

フォルダーの説明。
フォルダー
 is_folder boolean

リソースがフォルダーかどうか。 True または False
使用可能なパブリック リンク
 public_links string

[このフォルダーからのパブリック リンクを許可する] を設定する方法に関するフォルダー オプションの設定。
削除または移動可能
 restrict_move_delete boolean

削除または移動できますか? T または F

フォルダーのアクセス許可を取得する

操作 ID:
getFolderPermissions

フォルダーのアクセス許可を取得します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

フォルダーの完全なパス。

戻り値

名前 パス 型 説明
ユーザーのアクセス許可
 userPerms object

ユーザーをアクセス許可の値にマップします。
グループのアクセス許可
 groupPerms object

グループ名をアクセス許可の値にマップする
アクセス許可を継承します
 inheritsPermissions boolean

親フォルダーからアクセス許可を継承する必要があるかどうか。
親のアクセス許可を保持する
 keepParentPermissions boolean

inheritsPermissions を使用してアクセス許可の継承を無効にすると、このオプションによって、親フォルダーから以前に継承されたアクセス許可をこのフォルダーにコピーするかどうかを決定します。

フォルダーのアクセス許可を設定する

操作 ID:
setFolderPermissions

フォルダーのアクセス許可を設定します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

フォルダーの完全なパス。
ユーザーのアクセス許可
 userPerms object

ユーザーをアクセス許可の値にマップします。
グループのアクセス許可
 groupPerms object

グループ名をアクセス許可の値にマップする
アクセス許可を継承します
 inheritsPermissions boolean

親フォルダーからアクセス許可を継承する必要があるかどうか。
親のアクセス許可を保持する (inheritsPermissions が false の場合のみ)
 keepParentPermissions boolean

親フォルダーからのアクセス許可をこのフォルダーに適用するかどうかを指定します。

フォルダーをプロジェクトとしてマークする

操作 ID:
markFolderAsProject

既存のフォルダーをプロジェクトとしてマークします。 https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

パラメーター

名前 キー 必須 型 説明
ルート フォルダー ID
 rootFolderId True string

ルート プロジェクト フォルダーの FolderId
名前
 name True string

プロジェクトの名前
Description
 description string

フォルダーの説明
ステータス
 status True string

プロジェクトの状態
開始日 (例: 2023-12-31T23:59:59)
 startDate date-time

プロジェクトの開始日。
終了日 (例: 2023-12-31T23:59:59)
 completionDate date-time

プロジェクトの完了日。

戻り値

名前 パス 型 説明
ID (アイディー)
 id string

アイテム ID

フォルダーを作成する

操作 ID:
createFolder

Egnyte にフォルダーを作成します。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

新しいフォルダーの完全なパス。

戻り値

名前 パス 型 説明
フォルダー パス
 path string

作成されたフォルダーの完全なパス
フォルダー ID
 folder_id string

作成されたフォルダーの一意の ID

メタデータ キーを作成する

操作 ID:
createMetadataKey

既存の名前空間にメタデータ キーを追加します。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。
キー名
 key True string

作成するキーの名前。
型 ("enum" の場合: データ パラメーターが必要)
 type True string

キーのデータ型を指定します。
[表示名]
 displayName string

UI 内のフィールドを識別する名前。
Priority
 priority number

キーの優先順位を指定します (優先順位の高いキーが最初に表示されます)。
ヘルプ テキスト
 helpText string

メタデータ フィールドのヒントの説明。
データ
 data array of string

列挙型のキーの場合は、列挙値を指定します。

メタデータ キーを削除する

操作 ID:
deleteMetadataKey

既存の名前空間からメタデータ キーを削除します。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。
名前
 key True string

削除するキーの名前。
強制的に削除する
 force boolean

メタデータ キーが使用されている場合でも削除します。

ユーザーの作成

操作 ID:
createUser

Egnyte で新しいユーザーを作成します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

パラメーター

名前 キー 必須 型 説明
ユーザー名
 userName True string

ユーザーの Egnyte ユーザー名。 文字または数字で始まる必要があります。
Email
 email True string

ユーザーのメール アドレス (例: admin@acme.com)。
指定された名前
 givenName True string

ユーザーの名。
姓
 familyName True string

ユーザーの姓。
Active
 active True boolean

ユーザーがアクティブか非アクティブか。
ユーザー タイプ
 userType True string

ユーザーの種類。
認証の種類
 authType True string

ユーザーの認証の種類。
外部 ID
 externalId string

API コンシューマーによって提供される不変の一意識別子。
招待を送信する
 sendInvite boolean

ユーザーの作成時に true に設定すると、招待メールが送信されます (ユーザーがアクティブな状態で作成されている場合)。
サービス アカウント
 isServiceAccount boolean

ユーザーの作成時に true に設定すると、ユーザーはサービス アカウントとして作成されます。
Language
 language string

"language" パラメーターは、言語パックがドメインに対して有効になっている場合にのみ受け入れられます。
Role
 role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
IDP ユーザー ID
 idpUserId string

ユーザーが SSO 認証され、既定のユーザー マッピングを使用していない場合にのみ必要です。 ユーザーが SSO 認証されていないかどうかを指定しないでください。
ユーザー プリンシパル名
 userPrincipalName string

ユーザーが AD 認証されていないかどうかを指定しないでください。 マルチドメイン セットアップで Active Directory 認証を使用する場合に、子認証ポリシーをユーザーにバインドするために使用されます。

戻り値

名前 パス 型 説明
ユーザーID
 id integer

新しく作成されたユーザーの一意識別子
ユーザー名
 userName string

ユーザーの Egnyte ユーザー名。
外部 ID
 externalId string

API コンシューマーによって提供される不変の一意識別子。
Email
 email string

ユーザーの電子メール アドレス。
電子メールの変更が保留中
 emailChangePending boolean

メールの変更が保留中かどうか。
指定された名前
 name.givenName string

ユーザーの名。
姓
 name.familyName string

ユーザーの姓。
書式設定された名前
 name.formatted string

ユーザーの書式設定されたフル ネーム。
Active
 active boolean

ユーザーがアクティブかどうか。
ロックされています
 locked boolean

ユーザー アカウントがロックされているかどうか。
認証の種類
 authType string

ユーザーの認証の種類。
ユーザー タイプ
 userType string

ユーザーの種類。
IDP ユーザー ID
 idpUserId string

SSO ID プロバイダーからの SAML 応答内でユーザーを識別する方法。
ユーザー プリンシパル名
 userPrincipalName string

Active Directory 認証を使用するときに子認証ポリシーをユーザーにバインドするために使用されます。
Role
 role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
Language
 language string

ユーザーの言語設定。
作成日
 createdDate date-time

ユーザーが作成された日時。
最終変更日
 lastModificationDate date-time

最後の変更の日付と時刻。
最後のアクティブな日付
 lastActiveDate date-time

最後のアクティビティの日付と時刻。
有効期限日
 expiryDate date-time

ユーザー アカウントの有効期限が切れる日付。

ユーザーの詳細を取得する

操作 ID:
getUser

ID でユーザーに関する情報を取得します。 詳細情報: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

パラメーター

名前 キー 必須 型 説明
ユーザーID
 id True integer

ユーザーの ID

戻り値

ユーザー情報

Body
UserInfoResponse

リンクの作成

操作 ID:
createLink

リンクを作成します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

パラメーター

名前 キー 必須 型 説明
経路
 path True string

ターゲット ファイルまたはフォルダーの絶対パス。
タイプ
 type True string

これにより、作成されるリンクの種類が決まります。
Accessibility
 accessibility string

リンクにアクセスできるユーザーを決定します。 アップロード リンクを除き、または "useDefaultSettings" が true の場合を除き、必須です。
既定の設定を使用する
 useDefaultSettings True boolean

リンクの作成にドメインの既定のパラメーターを使用するかどうかを決定します
電子メールを送信する
 send_email boolean

true が設定されている場合、リンクは Egnyte によって電子メールで送信されます。
受取人
 recipients array of string

リンクの受信者のメール アドレスを一覧表示します。 "電子メールの送信" が true の場合にのみ必要です。
メッセージ ("電子メールの送信" が true の場合にのみ適用されます)。
 message string

リンク メールで送信される個人用メッセージ。
自分をコピーします ([電子メールの送信] が true の場合にのみ適用されます)
 copy_me boolean

true を設定すると、リンク メッセージのコピーがリンク作成者に送信されます。
Notify
 notify boolean

true が設定されている場合、リンクにアクセスすると、リンク作成者に電子メールで通知されます。
現在のリンク (ファイル リンクにのみ適用されます)。
 link_to_current boolean

true が設定されている場合、リンクは常に現在のバージョンのファイルを参照します。
有効期限 (例: 2023-12-31)
 expiry_date string

リンクの有効期限。 指定した場合、"Expiry clicks" を設定できません。
[Expiry clicks]\(有効期限\) のクリック数
 expiry_clicks number

リンクが有効なクリック数。 指定した場合、"有効期限" を設定できません
ファイル名を追加する (フォルダー リンクではなく、ファイル リンクにのみ適用されます)
 add_file_name boolean

true の場合、ファイル名はリンクの末尾に追加されます。
パスワード ("accessibility" パラメーターが "password" に設定されている場合)
 password string

指定しない場合、システムはパスワードを自動的に生成します。
保護
 protection string

[プレビュー] に設定すると、プレビュー専用のリンクが作成されます。
受信者ごとのフォルダー (リンクのアップロードにのみ適用されます)。
 folder_per_recipient boolean

true の場合、各受信者のアップロードされたデータは別のフォルダーに格納されます。

戻り値

名前 パス 型 説明
Links
 links array of object

このユーザーが指定した範囲内で表示できるドメインのすべてのリンクの完全な json 情報を含む配列
ID (アイディー)
 links.id string

リンクの ID
ウェブアドレス
 links.url string

リンクの完全な URL
受取人
 links.recipients array of string

リンクが送信された有効な電子メール アドレスの配列。
経路
 path string

ターゲット リソースの絶対パス (ファイルまたはフォルダー)。
タイプ
 type string

リンクの種類 (ファイル、フォルダー、またはアップロード)
Accessibility
 accessibility string

リンクにアクセスできるユーザー(だれか、パスワード、ドメイン、受信者のいずれか)。
Notify
 notify boolean

リンクにアクセスしたときに、リンク作成者に電子メールで通知を受け取るかどうかに関するブール値。
現在のリンク
 link_to_current boolean

リンクが常に現在のバージョンのファイルを参照するかどうかに関するブール値。 ファイル リンクにのみ適用されます。
有効期限日
 expiry_date string

リンクの有効期限の日付と時刻。 このフィールドは、リンクの有効期限が日付までに切れる場合にのみ表示されます
作成日
 creation_date string

リンクの作成日時
作成者
 created_by string

リンクを作成したユーザーのユーザー名

リンクの削除

操作 ID:
deleteLink

リンクを削除します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

パラメーター

名前 キー 必須 型 説明
リンク ID
 linkId True string

LinkId

リンクの詳細を表示する

操作 ID:
showLinkDetails

リンクの詳細を表示します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

パラメーター

名前 キー 必須 型 説明
リンク ID
 linkId True string

LinkId

戻り値

名前 パス 型 説明
Links
 links array of object

このユーザーが指定した範囲内で表示できるドメインのすべてのリンクの完全な json 情報を含む配列
ID (アイディー)
 links.id string

リンクの ID
ウェブアドレス
 links.url string

リンクの完全な URL
受取人
 links.recipients array of string

リンクが送信された有効な電子メール アドレスの配列。
経路
 path string

ターゲット リソースの絶対パス (ファイルまたはフォルダー)。
タイプ
 type string

リンクの種類 (ファイル、フォルダー、またはアップロード)
Accessibility
 accessibility string

リンクにアクセスできるユーザー(だれか、パスワード、ドメイン、受信者のいずれか)。
Notify
 notify boolean

リンクにアクセスしたときに、リンク作成者に電子メールで通知を受け取るかどうかに関するブール値。
現在のリンク
 link_to_current boolean

リンクが常に現在のバージョンのファイルを参照するかどうかに関するブール値。 ファイル リンクにのみ適用されます。
有効期限日
 expiry_date string

リンクの有効期限の日付と時刻。 このフィールドは、リンクの有効期限が日付までに切れる場合にのみ表示されます
作成日
 creation_date string

リンクの作成日時
作成者
 created_by string

リンクを作成したユーザーのユーザー名
最後にアクセスされた
 last_accessed string

リンクの最後のアクセスの日付と時刻。 このフィールドは、リンクが少なくとも 1 回アクセスされている場合にのみ表示されます

ルート フォルダー ID でプロジェクトを取得する

操作 ID:
getProjectByRootFolderId

ルート フォルダー ID に基づいてプロジェクトを取得します。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

パラメーター

名前 キー 必須 型 説明
ルート フォルダーの ID
 rootFolderId True string

ルート フォルダーの ID

戻り値

Body
ProjectItem

共有フォルダー

操作 ID:
shareFolder

Egnyte でフォルダーを共有します。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

共有する Egnyte のフォルダー パス。

戻り値

名前 パス 型 説明
links
 links array of object

Links
リンク ID
 links.id string

リンクの ID。
リンク URL
 links.url string

リンクの完全な URL。
受取人
 links.recipients array of string

リンクが送信された有効な電子メール アドレスの配列。
フォルダー パス
 path string

共有フォルダーの完全なパス。
タイプ
 type string

ファイル、フォルダー、またはアップロードのいずれかのリンクの種類。
Accessibility
 accessibility string

リンクにアクセスできるユーザー(だれか、パスワード、ドメイン、受信者のいずれか)。
アクセス時に作成者に通知する
 notify boolean

リンクにアクセスしたときに、リンク作成者に電子メールで通知を受け取るかどうか。
バージョンを参照しています
 link_to_current boolean

このバージョンは現在のバージョンですか? T または F
有効期限
 expiry_date string

リンクの有効期限の日付と時刻。
[作成日付]
 creation_date string

リンクの作成日時。
作成者
 created_by string

リンクを作成したユーザーのユーザー名。

名前空間を作成する

操作 ID:
createNamespace

Egnyte で名前空間を作成します。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

パラメーター

名前 キー 必須 型 説明
名前空間名
 name True string

名前空間の名前
[表示名]
 displayName string

UI で名前空間を識別する名前
Scope
 scope True string

名前空間を表示および変更できるユーザー
キーの名称
 name True string

キーの名前
タイプ
 type True string

キーのデータ型を指定します
表示される名前
 displayName string

UI 内のフィールドを識別する名前
ヘルプ テキスト
 helpText string

メタデータ フィールドのヒントの説明
Priority
 priority number

キーの優先度を指定します (優先度の高いキーが最初に表示されます)
データ (列挙型の場合)
 data array of string

列挙型のキーの場合は、列挙値を指定します

名前空間を削除する

操作 ID:
deleteNamespace

指定した名前空間を削除します。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。
強制的に削除する
 force boolean

名前空間が使用されている場合でも削除する

名前空間を取得する

操作 ID:
getNamespace

特定の名前空間に作成されたすべてのカスタム メタデータ キーを一覧表示します。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。

戻り値

Body
NamespaceItem

名前空間キーを更新する

操作 ID:
updateNamespaceKeys

ドメインのカスタム メタデータのキーを更新します。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。
Key
 key True string

名前空間内の一意のキー
ディスプレイ名
 displayName string

キーに表示される名前を指定します。
型
 type string

キーのデータ型を指定します
priority
 priority number

キーの優先順位 (順序) を指定します。 キーは優先順位に従って降順に表示されます (優先順位の高いキーが最初に表示されます)
データ
 data string

列挙型のキーの場合は、列挙値を指定します
helpText
 helpText string

ユーザーがプロパティを追加/編集してプロパティの目的に関するコンテキストを提供するときに表示される説明テキスト

戻り値

名前 パス 型 説明
名前
 name string

名前空間名
キー
 key string

キー名
ディスプレイ名
 displayName string

UI 内のフィールドを識別する名前
helpText
 helpText string

メタデータ フィールドのヒントの説明
priority
 priority number

キーの優先度を指定します (優先度の高いキーが最初に表示されます)

名前空間属性を更新する

操作 ID:
updateNamespaceAttributes

名前空間属性を更新します。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

パラメーター

名前 キー 必須 型 説明
名前空間名
 namespace True string

Egnyte の名前空間の一意識別子。
ディスプレイ名
 displayName string

UI で名前空間を識別する名前
優先 順位
 priorities object

キーの優先順位 (順序) を指定します。 キーは優先順位に従って降順に表示されます (優先順位の高いキーが最初に表示されます)

戻り値

Body
NamespaceItem

有効なアクセス許可を取得する

操作 ID:
getEffectivePermissions

ユーザーの有効なアクセス許可を取得します。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 path True string

フォルダーの完全なパス。
ユーザー名
 username True string

ユーザー名

戻り値

名前 パス 型 説明
権限
 permission string

アクセス許可の値

検索メタデータ

操作 ID:
searchMetadata

特定のメタデータ フィールドまたは値を持つアイテムを検索します。 https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

パラメーター

名前 キー 必須 型 説明
検索の種類
 type string

検索する項目の種類。
名前空間名
 namespace True string

名前空間の名前。
メタデータ キー
 keyName True string

メタデータ キーの名前。
名前空間名
 namespace True string

名前空間の名前。
メタデータ キー
 keyName True string

メタデータ キーの名前。
メタデータ値
 value True string

メタデータ キーの値。

トリガー

グループが作成されたとき

この操作は、グループが作成されたときにフローをトリガーします
グループが削除されたとき

この操作は、グループが削除されたときにフローをトリガーします
グループが更新されたとき

この操作は、グループが更新されたときにフローをトリガーします
ファイルがコピーされたとき

この操作は、ファイルがフォルダーにコピーされたときにフローをトリガーします。
ファイルがロックされている場合

この操作は、ファイルがロックされているときにフローをトリガーします
ファイルが作成されたとき (webhook)

この操作は、ファイルが特定のフォルダーに作成されたときにフローをトリガーします
ファイルが作成されたとき (ポーリング)

この操作は、フォルダーに新しいファイルが作成されたときにフローをトリガーします。
ファイルが削除されたとき

この操作は、フォルダー内のファイルが削除されたときにフローをトリガーします。
ファイルが更新されたとき

この操作は、特定のフォルダーでファイルが更新されたときにフローをトリガーします
ファイルが移動されたとき

この操作は、ファイルがフォルダー内に移動されたときにフローをトリガーします。
ファイルのロックが解除されたとき

この操作は、ファイルのロックが解除されたときにフローをトリガーします
ファイルの名前が変更されたとき

この操作は、フォルダー内のファイルの名前が変更されたときにフローをトリガーします。
ファイルまたはフォルダーのアクセス許可が変更されたとき

この操作は、ファイルまたはフォルダーのアクセス許可が変更されたときにフローをトリガーします
ファイルまたはフォルダーのメタデータが変更されたとき

この操作は、ファイルまたはフォルダーのメタデータが変更されたときにフローをトリガーします
フォルダーがコピーされたとき

この操作は、サブフォルダーがフォルダーにコピーされたときにフローをトリガーします。
フォルダーがプロジェクトとしてマークされていない場合

この操作は、フォルダーがプロジェクトとしてマークされていないときにフローをトリガーします
フォルダーが作成されたとき

この操作は、サブフォルダーがフォルダーに作成されたときにフローをトリガーします。
フォルダーが削除されたとき

この操作は、フォルダー内のサブフォルダーが削除されたときにフローをトリガーします。
フォルダーが移動されたとき

この操作は、サブフォルダーがフォルダー内に移動されたときにフローをトリガーします。
フォルダーの名前が変更されたとき

この操作は、フォルダー内のサブフォルダーの名前が変更されたときにフローをトリガーします。
プロジェクト フォルダーが作成されたとき

この操作は、プロジェクト フォルダーが作成されたとき、または既存のフォルダーがプロジェクト フォルダーとしてマークされたときにフローをトリガーします
プロジェクトが更新されたとき

この操作は、プロジェクトが更新されたときにフローをトリガーします
ワークフローが完了したとき

この操作は、ワークフローが完了したときにフローをトリガーします
ワークフローの作成時

この操作は、ワークフローの作成時にフローをトリガーします。
共有リンクが作成されたとき

この操作は、共有リンクが作成されたときにフローをトリガーします
共有リンクが削除されたとき

この操作は、共有リンクが削除されたときにフローをトリガーします
承認の種類のワークフローが承認されたとき

この操作は、承認の種類のワークフローが承認されたときにフローをトリガーします
承認の種類のワークフローが拒否されたとき

この操作は、承認の種類のワークフローが拒否されたときにフローをトリガーします

グループが作成されたとき

操作 ID:
groupCreated

この操作は、グループが作成されたときにフローをトリガーします

戻り値

名前 パス 型 説明
ユーザーID
 user.id integer

ユーザーの一意識別子。
氏名
 user.fullName string

ユーザーのフル ネーム。
ユーザー名
 user.userName string

ユーザーのユーザー名。
ユーザーの電子メール
 user.email string

ユーザーの電子メール アドレス。
ユーザーID
 owner.id integer

ユーザーの一意識別子。
氏名
 owner.fullName string

ユーザーのフル ネーム。
ユーザー名
 owner.userName string

ユーザーのユーザー名。
ユーザーの電子メール
 owner.email string

ユーザーの電子メール アドレス。
グループ名
 groupName string

グループの名前を指定します。
グループ識別子
 groupId string

グループの一意識別子。
Members
 members array of GroupUser

グループのメンバー。

グループが削除されたとき

操作 ID:
groupDeleted

この操作は、グループが削除されたときにフローをトリガーします

戻り値

名前 パス 型 説明
ユーザーID
 user.id integer

ユーザーの一意識別子。
氏名
 user.fullName string

ユーザーのフル ネーム。
ユーザー名
 user.userName string

ユーザーのユーザー名。
ユーザーの電子メール
 user.email string

ユーザーの電子メール アドレス。
グループ名
 groupName string

グループの名前を指定します。
グループ識別子
 groupId string

グループの一意識別子。

グループが更新されたとき

操作 ID:
groupUpdated

この操作は、グループが更新されたときにフローをトリガーします

戻り値

名前 パス 型 説明
ユーザーID
 user.id integer

ユーザーの一意識別子。
氏名
 user.fullName string

ユーザーのフル ネーム。
ユーザー名
 user.userName string

ユーザーのユーザー名。
ユーザーの電子メール
 user.email string

ユーザーの電子メール アドレス。
ユーザーID
 owner.id integer

ユーザーの一意識別子。
氏名
 owner.fullName string

ユーザーのフル ネーム。
ユーザー名
 owner.userName string

ユーザーのユーザー名。
ユーザーの電子メール
 owner.email string

ユーザーの電子メール アドレス。
グループ名
 groupName string

グループの名前を指定します。
グループ識別子
 groupId string

グループの一意識別子。
アクション
 action string

グループの更新をトリガーした特定のアクション。
Members
 members array of GroupUser

グループのメンバー。

ファイルがコピーされたとき

操作 ID:
pollCopiedFiles

この操作は、ファイルがフォルダーにコピーされたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
ファイル パス
 data.target_path string

ファイルへの完全なパス。
バージョン ID
 data.target_id string

特定のバージョンのファイルの ID。
ファイル ID
 data.target_group_id string

ファイル全体を参照する ID。
ソース ファイル パス
 data.source_path string

ファイルへの完全な元のパス。
ソース ファイルのバージョン ID
 data.source_id string

ソース ファイル固有のバージョン ID。
ソース ファイル ID
 data.source_group_id string

ファイル全体を参照するソース ファイル ID。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細。

ファイルがロックされている場合

操作 ID:
fileLocked

この操作は、ファイルがロックされているときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット ファイルまたはフォルダーへのパス。

戻り値

Body
FileLockWebhookResponse

ファイルが作成されたとき (webhook)

操作 ID:
fileCreated

この操作は、ファイルが特定のフォルダーに作成されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット ファイルまたはフォルダーへのパス。

戻り値

名前 パス 型 説明
ファイル エントリ ID
 targetEntryId string
ファイル ID
 targetGroupId string
ファイル パス
 targetPath string
リンク URL のアップロード
 uploadLinkUrl string

アップロード リンクを使用してファイルがアップロードされた場合にのみ使用できます

ファイルが作成されたとき (ポーリング)

操作 ID:
pollCreatedFiles

この操作は、フォルダーに新しいファイルが作成されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

イベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
ファイル パス
 data.target_path string

ファイルへの完全なパス。
バージョン ID
 data.target_id string

特定のバージョンのファイルの ID。
ファイル ID
 data.target_group_id string

ファイル全体を参照する ID。
Is Folder
 data.is_folder boolean

リソースがフォルダー (True または False) かどうか。
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細。

ファイルが削除されたとき

操作 ID:
pollDeletedFiles

この操作は、フォルダー内のファイルが削除されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

イベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
バージョン パス
 data.target_path string

特定のファイル バージョンへの完全パス。
ファイル ID
 data.target_group_id string

ファイル全体を参照する ID。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。

ファイルが更新されたとき

操作 ID:
fileUpdated

この操作は、特定のフォルダーでファイルが更新されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット ファイルまたはフォルダーへのパス。

戻り値

名前 パス 型 説明
ファイル エントリ ID
 targetEntryId string
ファイル ID
 targetGroupId string
ファイル パス
 targetPath string

ファイルが移動されたとき

操作 ID:
pollMovedFiles

この操作は、ファイルがフォルダー内に移動されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
ファイル パス
 data.target_path string

ファイルへの完全なパス。
バージョン ID
 data.target_id string

特定のバージョンのファイルの ID。
ファイル ID
 data.target_group_id string

ファイル全体を参照する ID。
ソース ファイル パス
 data.source_path string

ファイルへの完全な元のパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細。

ファイルのロックが解除されたとき

操作 ID:
fileUnlocked

この操作は、ファイルのロックが解除されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット ファイルまたはフォルダーへのパス。

戻り値

Body
FileLockWebhookResponse

ファイルの名前が変更されたとき

操作 ID:
pollRenamedFiles

この操作は、フォルダー内のファイルの名前が変更されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
ファイル パス
 data.target_path string

名前が変更されたファイルへの完全なパス
バージョン ID
 data.target_id string

特定のバージョンのファイルの ID。
ファイル ID
 data.target_group_id string

ファイル全体を参照する ID。
ソース ファイル パス
 data.source_path string

ファイルへの完全な元のパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細

ファイルまたはフォルダーのアクセス許可が変更されたとき

操作 ID:
fileOrFolderPermissionChange

この操作は、ファイルまたはフォルダーのアクセス許可が変更されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
担当者
 assignee string
担当者 ID
 assigneeId number
Assigner
 assigner string
担当者 ID
 assignerId number
フォルダー パス
 folderPath string
新しい特権
 newPrivilege string
以前の特権
 oldPrivilege string
グループ名
 groupName string

ファイルまたはフォルダーのメタデータが変更されたとき

操作 ID:
fileOrFolderMetadataChange

この操作は、ファイルまたはフォルダーのメタデータが変更されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
ターゲット パス
 targetPath string
ターゲット グループ ID
 targetGroupId string
Namespace
 namespace string
Key
 key string
アクション
 action string

フォルダーがコピーされたとき

操作 ID:
pollCopiedFolders

この操作は、サブフォルダーがフォルダーにコピーされたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
フォルダー パス
 data.target_path string

フォルダーへの完全な宛先パス
ソース フォルダー パス
 data.source_path string

フォルダーへの完全な元のパス
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細

フォルダーがプロジェクトとしてマークされていない場合

操作 ID:
folderProjectUnmarked

この操作は、フォルダーがプロジェクトとしてマークされていないときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
FolderProjectCommon

フォルダーが作成されたとき

操作 ID:
pollCreatedFolders

この操作は、サブフォルダーがフォルダーに作成されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

イベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
フォルダー パス
 data.target_path string

フォルダーへの完全なパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細。

フォルダーが削除されたとき

操作 ID:
pollDeletedFolders

この操作は、フォルダー内のサブフォルダーが削除されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

イベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
フォルダー パス
 data.target_path string

削除されたフォルダーへの完全なパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。

フォルダーが移動されたとき

操作 ID:
pollMovedFolders

この操作は、サブフォルダーがフォルダー内に移動されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
フォルダー パス
 data.target_path string

フォルダーへの完全な宛先パス。
ソース フォルダー パス
 data.source_path string

フォルダーへの完全な元のパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細

フォルダーの名前が変更されたとき

操作 ID:
pollRenamedFolders

この操作は、フォルダー内のサブフォルダーの名前が変更されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
イベント ID
 id integer

個々のイベントの ID。
タイムスタンプ
 timestamp string

このイベントが記録されたときの ISO-8601 形式のタイムスタンプ。
ユーザーID
 actor integer

アクションを実行したユーザーの数値 ID。
アクション
 action string

このイベントに関連付けられているアクション。
フォルダー パス
 data.target_path string

フォルダーへの完全な宛先パス。
ソース フォルダー パス
 data.source_path string

フォルダーへの完全な元のパス。
Is Folder
 data.is_folder boolean

リソースがフォルダーかどうか。 (True または False)
アクション ソース
 action_source string

イベントのソース。 たとえば、WebUI、Mobile などです。
オブジェクトの詳細
 object_detail string

オブジェクトの詳細

プロジェクト フォルダーが作成されたとき

操作 ID:
folderProjectAdded

この操作は、プロジェクト フォルダーが作成されたとき、または既存のフォルダーがプロジェクト フォルダーとしてマークされたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
FolderProjectCommon

プロジェクトが更新されたとき

操作 ID:
folderProjectUpdated

この操作は、プロジェクトが更新されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string
プロジェクト名
 name string
プロジェクトの場所
 location string
プロジェクトの状態
 status string

プロジェクトの状態 (保留中、進行中、保留中、完了、取り消し済み)

ワークフローが完了したとき

操作 ID:
workflowCompleted

この操作は、ワークフローが完了したときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
ワークフロー ID
 workflow.id string
ワークフロー名
 workflow.name string
ワークフロー表示 ID
 workflow.displayId number
ワークフローの種類
 workflow.type string
ワークフロー テンプレート ID
 workflow.templateId string
ワークフロー アクションの状態
 workflow.actionStatus string
最初のエンティティ型
 firstEntity.type string
最初のエンティティ パス
 firstEntity.filePath string
最初のエンティティ エントリ ID
 firstEntity.entryID string
最初のエンティティ グループ ID
 firstEntity.groupID string
完了状態コード
 completionStatusCode string
ステップの合計数
 totalNumberOfSteps number
完了日
 completionDate number

ワークフローの作成時

操作 ID:
workflowCreated

この操作は、ワークフローの作成時にフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

名前 パス 型 説明
ワークフロー ID
 workflow.id string
ワークフロー名
 workflow.name string
ワークフロー表示 ID
 workflow.displayId number
ワークフローの種類
 workflow.type string
ワークフロー テンプレート ID
 workflow.templateId string
ワークフロー アクションの状態
 workflow.actionStatus string
最初のエンティティ型
 firstEntity.type string
最初のエンティティ パス
 firstEntity.filePath string
最初のエンティティ エントリ ID
 firstEntity.entryID string
最初のエンティティ グループ ID
 firstEntity.groupID string
JSON 定義
 definitionJson string

共有リンクが作成されたとき

操作 ID:
shareLinkCreated

この操作は、共有リンクが作成されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
LinkWebhookResponse

共有リンクが削除されたとき

操作 ID:
shareLinkDeleted

この操作は、共有リンクが削除されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
LinkWebhookResponse

承認の種類のワークフローが承認されたとき

操作 ID:
workflowApprovalTaskApproved

この操作は、承認の種類のワークフローが承認されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
WorkflowStepResponse

承認の種類のワークフローが拒否されたとき

操作 ID:
workflowApprovalTaskRejected

この操作は、承認の種類のワークフローが拒否されたときにフローをトリガーします

パラメーター

名前 キー 必須 型 説明
フォルダー パス
 FolderPath True string

ターゲット フォルダーへのパス。

戻り値

Body
WorkflowStepResponse

定義

GroupUser

名前 パス 型 説明
ユーザーID
 id integer

ユーザーの一意識別子。
氏名
 fullName string

ユーザーのフル ネーム。
ユーザー名
 userName string

ユーザーのユーザー名。
ユーザーの電子メール
 email string

ユーザーの電子メール アドレス。

LinkWebhookResponse

名前 パス 型 説明
ソース パス
 sourcePath string
リンク ID
 linkId string
リンクの種類
 linkType string

フォルダーまたはファイル
リンク URL
 linkURL string

FileInfoResponse

名前 パス 型 説明
チェックサム
 checksum string

ファイルの変更を決定するために使用されるファイルの現在のバージョンのチェックサム値。
サイズ
 size integer

ファイルのサイズ (バイト単位)。
ファイル パス
 path string

ファイルの完全なパス。
名前
 name string

ファイルの名前。
ロック
 locked boolean

ファイルのロックの状態。
フォルダー
 is_folder boolean

リソースがフォルダーかどうか。 True または False
バージョン ID
 entry_id string

ファイルの現在のバージョンの ID。
ファイル ID
 group_id string

ファイル全体を参照する ID。
親フォルダー ID
 parent_id string

要求された親フォルダーの ID。
最終更新日時
 last_modified string

ファイルの現在のバージョンの最終変更時刻。
アップロード者
 uploaded_by string

現在のバージョンをアップロードしたユーザーのユーザー名。
アップロードされたタイムスタンプ
 uploaded integer

ファイルの現在のバージョンのアップロード時刻。
バージョンの数
 num_versions integer

特定のファイル パスに関連付けられているバージョンの合計数。
versions
 versions array of object

Versions
フォルダー (バージョン)
 versions.is_folder boolean

リソースがフォルダーかどうか。 True または False
バージョン ID
 versions.entry_id string

特定のバージョンのファイルの ID。
チェックサム (バージョン)
 versions.checksum string

ファイルの変更を決定するために使用されるファイルのバージョンのチェックサム値。
最終更新日時 (バージョン)
 versions.last_modified string

特定のバージョンのファイルの最終変更時刻。
アップロード者 (バージョン)
 versions.uploaded_by string

バージョンをアップロードしたユーザーのユーザー名。
アップロードされたタイムスタンプ (バージョン)
 versions.uploaded integer

特定のバージョンのファイルのアップロード時刻。
サイズ (バージョン)
 versions.size integer

特定のバージョンのファイルのサイズ (バイト単位)。

UserInfoResponse

ユーザー情報

名前 パス 型 説明
ユーザーID
 id integer

ユーザー ID
ユーザー名
 userName string

ユーザーのユーザー名
外部 ID
 externalId string

外部 ID
Email
 email string

ユーザーの電子メール
姓
 name.familyName string

ユーザー ファミリ名 (姓)
指定された名前
 name.givenName string

ユーザー指定の名前 (名)
Active
 active boolean

ユーザー アカウントがアクティブか
作成日
 createdDate string

ユーザーが作成された日付
最終変更日
 lastModificationDate string

ユーザーが最後に変更された日付
最後のアクティブな日付
 lastActiveDate string

ユーザーがアクティブだった最後の日付
ロックされています
 locked boolean

ユーザーがロックされている
Language
 language string

"language" パラメーターは、言語パックがドメインに対して有効になっている場合にのみ受け入れられます。
認証の種類
 authType string

ユーザーの認証の種類。
ユーザー タイプ
 userType string

ユーザーの種類。
Role
 role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
IDP ユーザー ID
 idpUserId string

ID プロバイダーのユーザー ID
サービス アカウント
 isServiceAccount boolean

サービス アカウントとして使用されるアカウント
期限切れ時に削除する
 deleteOnExpiry string

アカウントは有効期限が切れた後に削除されますか?
電子メールの変更が保留中
 emailChangePending boolean

ユーザーの電子メールの変更が保留中か
有効期限日
 expiryDate string

アカウントの有効期限
ユーザー プリンシパル名
 userPrincipalName string
groups
 groups array of object
[表示名]
 groups.displayName string

グループの名前
グループ識別子
 groups.value string

グループの ID

UserListResponse

ユーザー リストの応答を取得する

名前 パス 型 説明
合計結果
 totalResults integer

クエリに一致する結果の合計数。
ページあたりのアイテム数
 itemsPerPage integer

返された結果の数。
インデックスの開始
 startIndex integer

現在の結果セットの最初の結果の 1 から始まるインデックス。
resources
 resources array of object
ユーザーID
 resources.id integer

ユーザーの ID
ユーザー名
 resources.userName string

ユーザーのユーザー名
外部 ID
 resources.externalId string

外部 ID
Email
 resources.email string

ユーザーの電子メール
書式設定された名前
 resources.name.formatted string

ユーザー形式の名前
姓
 resources.name.familyName string

ユーザー ファミリ名 (姓)
指定された名前
 resources.name.givenName string

ユーザー指定の名前 (名)
Active
 resources.active boolean

ユーザー アカウントがアクティブか
ロックされています
 resources.locked boolean

ユーザー アカウントがロックされているか
作成日
 resources.createdDate string

ユーザーが作成された日付
最終変更日
 resources.lastModificationDate string

ユーザーが最後に変更された日付
最後のアクティブな日付
 resources.lastActiveDate string

ユーザーがアクティブだった最後の日付
Language
 resources.language string

"language" パラメーターは、言語パックがドメインに対して有効になっている場合にのみ受け入れられます。
認証の種類
 resources.authType string

ユーザーの認証の種類。
ユーザー タイプ
 resources.userType string

ユーザーの種類。
Role
 resources.role string

ユーザーに割り当てられたロール。 Power Users にのみ適用されます。
IDP ユーザー ID
 resources.idpUserId string

ID プロバイダーのユーザー ID
サービス アカウント
 resources.isServiceAccount boolean

サービス アカウントとして使用されるアカウント
期限切れ時に削除する
 resources.deleteOnExpiry string

アカウントは有効期限が切れた後に削除されますか?
電子メールの変更が保留中
 resources.emailChangePending boolean

ユーザーの電子メールの変更が保留中か
有効期限日
 resources.expiryDate string

アカウントの有効期限
ユーザー プリンシパル名
 resources.userPrincipalName string

FolderInfoResponse

名前 パス 型 説明
名前
 name string

フォルダーの名前。
最終更新日時
 lastModified integer

フォルダー内のファイル (サブフォルダー内ではない) が変更された最新時刻。
アップロードされたタイムスタンプ
 uploaded integer

フォルダーがアップロードまたは作成された時刻。
フォルダー パス
 path string

フォルダーの完全なパス。
フォルダー ID
 folder_id string

フォルダーの一意の ID。
親フォルダー ID
 parent_id string

親フォルダーの ID。
サブ項目数
 total_count integer

実際に返されるアイテムの合計数。
フォルダー
 is_folder boolean

リソースがフォルダーかどうか。 True または False
使用可能なパブリック リンク
 public_links string

[このフォルダーからのパブリック リンクを許可する] を設定する方法に関するフォルダー オプションの設定。
共有可能
 allow_links boolean

共有可能ですか? T または F
削除または移動可能
 restrict_move_delete boolean

削除または移動できますか? T または F
フォルダー
 folders array of object

フォルダー
名前 (サブフォルダー)
 folders.name string

フォルダーの名前。
最終更新日時 (サブフォルダー)
 folders.lastModified integer

フォルダー内のファイル (サブフォルダー内ではない) が変更された最新時刻。
アップロードされたタイムスタンプ (サブフォルダー)
 folders.uploaded integer

フォルダーがアップロードまたは作成された時刻。
パス (サブフォルダー)
 folders.path string

要求されたフォルダーの完全なパス。
ID (サブフォルダー)
 folders.folder_id string

要求されたフォルダーの ID。
フォルダー (サブフォルダー)
 folders.is_folder boolean

リソースがフォルダーかどうか。 True または False
親フォルダー ID (サブフォルダー)
 folders.parent_id string

親フォルダーの ID。
files
 files array of object

Files
チェックサム (ファイル)
 files.checksum string

ファイルの変更を決定するために使用されるファイルの現在のバージョンのチェックサム値。
サイズ (ファイル)
 files.size integer

ファイルのサイズ (バイト単位)。
パス (ファイル)
 files.path string

ファイルの完全なパス。
名前 (ファイル)
 files.name string

ファイルの名前。
ロックされている (ファイル)
 files.locked boolean

ファイルのロックの状態。
フォルダー (ファイル)
 files.is_folder boolean

リソースがフォルダーかどうか。 True または False
バージョン ID (ファイル)
 files.entry_id string

特定のバージョンのファイルの ID。
ID (ファイル)
 files.group_id string

ファイル全体を参照する ID。
親フォルダー ID (ファイル)
 files.parent_id string

親フォルダーの ID。
最終更新日時 (ファイル)
 files.last_modified string

ファイルの現在のバージョンの最終変更時刻。
アップロード者 (ファイル)
 files.uploaded_by string

バージョンをアップロードしたユーザーのユーザー名。
アップロードされたタイムスタンプ (ファイル)
 files.uploaded integer

ファイルの現在のバージョンのアップロード時刻。
バージョン数 (ファイル)
 files.num_versions integer

特定のファイル パスに関連付けられているバージョンの合計数。

NamespaceItem

名前 パス 型 説明
名前空間名
 name string
名前空間スコープ
 scope string
keys
 keys object
ディスプレイ名
 displayName string

UI で名前空間を識別する名前
priority
 priority number

キーの優先順位 (順序) を指定します。 キーは優先順位に従って降順に表示されます (優先順位の高いキーが最初に表示されます)
継承
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
編集
 editable boolean

ProjectItem

名前 パス 型 説明
ID (アイディー)
 id string

アイテム ID
ルート フォルダー ID
 rootFolderId string

ルート フォルダー ID
名前
 name string

プロジェクトの名前
プロジェクト ID
 projectId string

プロジェクトの ID
顧客名
 customerName string

プロジェクトに関連付けられている顧客
Description
 description string

フォルダーの説明
位置
 location ProjectLocationItem
ステータス
 status string

プロジェクトの状態
作成者
 createdBy number

作成者
最終更新日時
 lastUpdatedBy number

最終更新日時
作成時間
 creationTime string

作成時間
最終修正日時
 lastModifiedTime string

最終修正日時
開始日
 startDate string

プロジェクトの開始日。
完了日
 completionDate string

プロジェクトの完了日。

ProjectLocationItem

名前 パス 型 説明
番地 1
 streetAddress1 string

住所の 1 行目
番地 2
 streetAddress2 string

番地の 2 行目
市区町村
 city string

市区町村
都道府県
 state string

都道府県
Country
 country string

Country
郵便番号または郵便番号
 postalCode string

郵便番号または郵便番号

FileLockWebhookResponse

名前 パス 型 説明
ファイル ID
 targetGroupId string
ファイル チェックサム
 targetFileChecksum string
ファイル パス
 targetPath string

FolderProjectCommon

名前 パス 型 説明
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string

WorkflowStepResponse

名前 パス 型 説明
ワークフロー ID
 workflow.id string
ワークフロー名
 workflow.name string
ワークフロー表示 ID
 workflow.displayId number
ワークフローの種類
 workflow.type string
ワークフロー テンプレート ID
 workflow.templateId string
ワークフロー アクションの状態
 workflow.actionStatus string
最初のエンティティ型
 firstEntity.type string
最初のエンティティ パス
 firstEntity.filePath string
最初のエンティティ エントリ ID
 firstEntity.entryID string
最初のエンティティ グループ ID
 firstEntity.groupID string
ステップ ID
 step.id string
ステップ名
 step.name string
ステップの種類
 step.type string
担当者 ID
 assignee.id number
担当者の表示名
 assignee.displayName string
割り当て先ユーザー名
 assignee.username string
担当者の電子メール
 assignee.email string
ステップの合計数
 totalNumberOfSteps number
完了日
 completionDate number
[作成日付]
 creationDate number

AIQuestionResponse

名前 パス 型 説明
response
 response AIResponse
引用
 citations array of AICitation

応答の生成に使用される引用と参照

AISummaryResponse

名前 パス 型 説明
response
 response AIResponse

AICopilotResponse

名前 パス 型 説明
response
 response AIResponse
引用
 citations array of AICitation

応答の生成に使用される引用と参照
会話 ID
 conversationId string

会話の一意識別子

AICitation

名前 パス 型 説明
Filename
 filename string

ソース ファイルの名前
エントリ ID
 entryId string

ソース ファイルのエントリ ID
テキスト チャンク
 chunks array of object

ソースからのテキスト チャンクの配列
チャンク ID
 chunks.chunkId string

テキスト チャンクの ID
ソース テキスト
 chunks.sourceText string

チャンクのテキスト コンテンツ

AIResponse

名前 パス 型 説明
応答テキスト
 text string

AI によって生成された応答テキスト