NetDocuments
NetDocuments は、あらゆる規模の企業向けのクラウド コンテンツ管理サービスであり、いつでもどこでもドキュメントを安全に作成、保存、管理、共有できます。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure China の地域 - 米国国防総省 (DoD) |
| Power Automate | Standard | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | 標準 | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| 連絡先 | |
|---|---|
| URL | https://support.netdocuments.com/hc/en-us |
| コネクタのメタデータ | |
|---|---|
| 公開元 | NetDocuments Software, Inc. |
| Web サイト | https://www.netdocuments.com/ |
| プライバシー ポリシー | https://www.netdocuments.com/privacy-policy/ |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| リージョン | 文字列 | ネット ドキュメントが存在するリージョン。 | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 1 つ以上のキャビネットの検索 |
1 つ以上のキャビネットの検索 |
|
Create Collab |
新しい CollabSpace を作成します |
| キャビネット グループの取得 |
キャビネットに追加されたすべてのグループを取得する |
| キャビネットにグループを追加またはキャビネットから削除する |
グループおよびデフォルトのアクセス権をキャビネットに追加する |
| キャビネットのカスタム属性を取得する |
キャビネットのカスタム属性を取得する |
| キャビネットの検索および ACL の変更 |
キャビネットの検索および ACL の変更 |
| キャビネット外部グループの作成 |
キャビネット外部グループの作成 |
| キャビネット情報の取得 |
キャビネット情報の取得 |
| キャビネット設定の取得 |
キャビネット設定の取得 |
| グループ メンバーの追加または削除 |
グループ メンバーの追加または削除 |
| グループ メンバーシップの取得 |
グループ メンバーシップの取得 |
| グループ情報の取得 |
グループ情報の取得 |
| コンテナー コンテンツの取得 |
選択したコンテナーのコンテンツを取得する |
| セキュリティで保護されたリンクの作成 |
誰でもアクセスできるドキュメントへのリンクを生成する |
| ドキュメント コンテンツを取得する |
ドキュメントを取得する |
| ドキュメント バージョンの取得 |
ドキュメント バージョンの取得 |
| ドキュメント プロファイルの取得 |
ドキュメントに関する情報を取得する |
| ドキュメントのチェックアウト |
ドキュメントのチェックアウト |
| ドキュメントのチェックイン |
チェックアウトされたドキュメントをチェックインする |
| ドキュメントのフォロー |
ドキュメントが更新されたときにアラートを受信する |
| ドキュメントのロック |
ドキュメントのロック |
| ドキュメントのロック解除 |
ドキュメントのロックを解除する |
| ドキュメントの作成 |
新しいドキュメントの作成 |
| ドキュメントの名前の変更 |
ドキュメントの名前を変更する |
| ドキュメントの履歴 |
ドキュメントに対して実行されたアクションのリストを取得する |
| ドキュメントの更新 |
ドキュメントのコンテンツを更新する |
| ドキュメントをフォルダにファイリングまたはファイリング解除する |
フォルダー内のアイテムをファイリングするか、フォルダーからアイテムをファイリング解除する。 |
| ドキュメントを削除します |
ドキュメントの削除 |
| フォルダーのフォロー |
新しいコンテンツがフォルダーに追加されたときにアラートを受信する |
| フォルダーの作成 |
新しいフォルダーの作成 |
| フォルダーの削除 |
フォルダーの削除 |
| フォルダーの名前を変更 |
フォルダーの名前を変更する |
| フォルダー項目の取得 |
ドキュメントやサブフォルダーなど、フォルダーのコンテンツを取得する |
| ユーザー キャビネットのリストの取得 |
ユーザー キャビネット |
| ユーザーを作成 |
リポジトリにユーザーを作成する |
| ユーザー情報を取得 |
ユーザーに関する情報を取得する |
| リポジトリ グループの作成 |
リポジトリ グループを作成する |
| リポジトリ グループの削除 |
リポジトリ グループを削除する |
| リポジトリ グループの取得 |
リポジトリ グループの取得 |
| リポジトリ ユーザーの取得 |
リポジトリ ユーザーの取得 |
| リポジトリ ログの取得 |
リポジトリ ログの取得 |
| リポジトリへのユーザーの追加またはリポジトリからのユーザーの削除 |
リポジトリへのユーザーの追加またはリポジトリからのユーザーの削除 |
| リポジトリ情報の取得 |
リポジトリ情報の取得 |
| ルックアップ テーブル エントリの作成または更新 |
ルックアップ テーブル エントリの作成または更新 |
| ルックアップ テーブル エントリの取得、または子テーブル エントリの検索 |
ルックアップ テーブル エントリの取得、または子テーブル エントリの検索 |
| ルックアップ テーブル エントリの検索 |
ルックアップ テーブル エントリの検索 |
| ロックするドキュメントのバージョン |
ロックするドキュメントのバージョン |
| ワークスペースの取得または作成 (単一の属性を使用) |
ワークスペースの取得または作成 (単一の属性を使用) |
| ワークスペースの取得または作成 (親属性と子属性を使用) |
ワークスペースの取得または作成 (親属性と子属性を使用) |
| ワークスペースの情報の取得 |
ワークスペースの情報の取得 |
| ワークスペースの更新 |
ワークスペースの更新 |
| 子ルックアップ テーブル エントリの作成または更新 |
子ルックアップ テーブル エントリの作成または更新 |
| 子ルックアップ テーブル エントリの削除 |
子ルックアップ テーブル エントリの削除 |
| 子ルックアップ テーブル エントリの削除 |
子ルックアップ テーブル エントリの削除 |
| 子ルックアップ テーブル エントリの取得 |
子ルックアップ テーブル エントリの取得 |
| 新しいバージョンのドキュメントの作成 |
新しいバージョンのドキュメントを作成する |
| 現在のユーザー情報の取得 |
現在のユーザーに関する情報を取得する。ID は不要 |
| 非表示のキャビネット グループのアクセス権を取得する |
非表示のキャビネット グループのアクセス権を取得する |
1 つ以上のキャビネットの検索
1 つ以上のキャビネットの検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット
|
cabinets | True | string |
(コンマ区切り) |
|
Query
|
q | True | string |
(クエリの形式については、ドキュメントを確認してください) |
|
返す情報
|
select | True | string |
(返す形式については、ドキュメントを確認してください) |
|
並べ替え順
|
orderby | string |
(形式: field#|desc または field#|asc) |
|
|
返す結果数 (デフォルトは 50)
|
top | integer |
(1 ページあたり最大 500) |
|
|
スキップする結果の数
|
skip | integer |
スキップする結果の数 |
|
|
結果のページ分割に使用されるトークン
|
skiptoken | string |
結果のページ分割に使用されるトークン |
Create CollabSpace
新しい CollabSpace を作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークスペース ID
|
workspaceID | True | string |
ワークスペース ID |
|
CollabSpace の名前
|
name | True | string |
CollabSpace の名前 |
|
内容
|
description | string |
内容 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
Id | string | |
|
EnvUrl
|
EnvUrl | string |
キャビネット グループの取得
キャビネットに追加されたすべてのグループを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
Id | string | |
|
件名
|
Name | string | |
|
外部
|
External | boolean | |
|
非表示
|
Hidden | boolean |
キャビネットにグループを追加またはキャビネットから削除する
グループおよびデフォルトのアクセス権をキャビネットに追加する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
|
ユーザーの追加または削除
|
action | True | string |
ユーザーの追加または削除 |
|
グループ ID
|
id | True | string |
グループ ID (UG で始まる)。 |
|
表示権限
|
view | True | boolean |
表示権限 (V) - 追加のみ。 |
|
編集権限
|
edit | True | boolean |
編集権限 (E) - 追加のみ。 |
|
共有権限
|
share | True | boolean |
共有権限 (S) - 追加のみ。 |
|
管理者権限
|
administer | True | boolean |
管理者権限 (A) - 追加のみ。 |
|
アクセス権なし
|
noAccess | True | boolean |
アクセス権なし (N) - 追加のみ。 |
キャビネットのカスタム属性を取得する
キャビネットのカスタム属性を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
項目
|
object |
キャビネットの検索および ACL の変更
キャビネットの検索および ACL の変更
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
|
Query
|
q | True | string |
(クエリの形式については、ドキュメントを確認してください) |
|
ACL モードの変更
|
mode | True | string |
ACL モードの変更 |
|
新しい ACL
|
newAcl | True | string |
(適切な JSON 形式については、ドキュメントを確認してください) |
|
メール アドレス
|
(代わりにこのアドレスに通知を送信する) |
|||
|
完了通知のメール送信
|
completionEmail | string |
(true = 常に送信 (デフォルト)、false = 送信しない、fail = 失敗時にのみ送信) |
キャビネット外部グループの作成
キャビネット外部グループの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
|
グループ名
|
name | True | string |
グループ名 |
|
グループ オプション
|
options | string |
グループ オプション |
|
|
キャビネットへの既定のアクセス
|
access | string |
キャビネットへの既定のアクセス |
|
|
CollabSpace ID
|
collaborationSpaceId | string |
(これをCollabSpace 外部グループにするため) |
|
|
CollabSpace アクセス
|
collaborationspaceaccess | string |
CollabSpace アクセス |
|
|
最上位のワークスペース属性値
|
topwsattributegroupkey | string |
(通常のキャビネット外部グループの場合。グループを特定の最上位ワークスペース属性値に関連付けるため) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイプ
|
Type | integer | |
|
ID
|
Id | string | |
|
件名
|
Name | string | |
|
オプション
|
Options | string | |
|
アクセス
|
Access | string |
キャビネット情報の取得
キャビネット情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
キャビネット設定の取得
キャビネット設定の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
グループ メンバーの追加または削除
グループ メンバーの追加または削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ ID
|
groupID | True | string |
(UG で始まる) |
|
ユーザーの追加または削除
|
action | True | string |
ユーザーの追加または削除 |
|
ユーザー ID
|
member | True | string |
(すでにリポジトリのメンバーである必要があります。) |
グループ メンバーシップの取得
グループ メンバーシップの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ ID
|
groupID | True | string |
(UG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
displayName
|
displayName | string | |
|
ID
|
id | string |
グループ情報の取得
グループ情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ ID
|
groupID | True | string |
グループ ID (UG で始まる)。 |
|
グループ キャビネット メンバーシップ
|
cabMembership | boolean |
(「true」に設定されている場合、このグループはメンバーであり、各キャビネットのデフォルトのドキュメント アクセス権が含まれます。) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部
|
external | boolean | |
|
非表示
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
ID
|
id | string | |
|
名前
|
name | string | |
|
cabMembership
|
cabMembership | array of object | |
|
ID
|
cabMembership.id | string | |
|
名前
|
cabMembership.name | string | |
|
権限
|
cabMembership.rights | string |
コンテナー コンテンツの取得
選択したコンテナーのコンテンツを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテナー ID
|
containerID | True | string |
コンテナー ID |
|
返す情報
|
select | True | string |
(返す形式については、ドキュメントを確認してください) |
|
返す結果数 (デフォルトは 50)
|
top | integer |
(1 ページあたり最大 500) |
|
|
結果のページ分割に使用されるトークン
|
skiptoken | string |
結果のページ分割に使用されるトークン |
|
|
並べ替え順
|
orderby | string |
(形式: field#|desc または field#|asc) |
セキュリティで保護されたリンクの作成
誰でもアクセスできるドキュメントへのリンクを生成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
セキュリティで保護されたリンクのパスワード
|
password | string |
キャビネットの構成に応じて、パスワードはオプションになるか、または必須になります。 |
|
|
セキュリティで保護されたリンクの有効期限。
|
expirationdate | string |
入力形式: yyyy-MM-dd。 |
|
|
ドキュメントのバージョン
|
version | string |
共有するドキュメントのバージョン。 空の場合、公式バージョンが共有されます。 |
|
|
ドキュメントのダウンロード
|
download | boolean |
true の場合、受信者はドキュメントをダウンロードできます。 |
|
|
通知を受け取る
|
notifyme | boolean |
true の場合、セキュリティで保護されたリンクにアクセスしたときに送信者に通知されます。 |
|
|
ドキュメントのロック
|
lock | boolean |
必要に応じて、選択したバージョンのドキュメントをロックします。 これには編集権限が必要です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ビュー
|
standardAttributes.view | string | |
|
ダウンロード
|
standardAttributes.download | string |
ドキュメント コンテンツを取得する
ドキュメントを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
Base64 でエンコード済みか?
|
base64 | boolean |
Base64 でエンコード済みか? |
ドキュメント バージョンの取得
ドキュメント バージョンの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentID | True | string |
12 桁のドキュメント ID。 |
ドキュメント プロファイルの取得
ドキュメントに関する情報を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
ドキュメントのチェックアウト
ドキュメントのチェックアウト
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
コメント
|
comment | string |
コメント |
|
|
ドキュメントのダウンロード
|
download | boolean |
ドキュメントのコンテンツを返します。 |
|
|
ダウンロードするバージョン
|
version | string |
ダウンロードするコンテンツのバージョンを指定します。 デフォルトは公式バージョン。 |
|
|
最近使用したものに追加
|
addToRecent | boolean |
最近使用したものに追加 |
ドキュメントのチェックイン
チェックアウトされたドキュメントをチェックインする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
ドキュメントの延長期間
|
extension | string |
先行期間は含めないでください。 |
|
|
ドキュメントのコンテンツ
|
file | file |
マルチパート形式のドキュメント。 |
|
|
最近使用したものに追加
|
addToRecent | boolean |
ユーザーが最近使用したドキュメント リストに追加します。 |
ドキュメントのフォロー
ドキュメントが更新されたときにアラートを受信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
受信者
|
recipients | True | string |
セミコロンで区切られた、1 つ以上の有効なメール アドレスのリスト。 重複は無視されます。 |
|
送信
|
send | string |
アラートを受信するユーザーのカテゴリ。 |
ドキュメントのロック
ドキュメントのロック
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
ドキュメント ID |
|
コメント
|
comment | string |
コメント |
ドキュメントのロック解除
ドキュメントのロックを解除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
ドキュメント ID |
ドキュメントの作成
新しいドキュメントの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
移動先
|
destination | True | string |
フォルダー、フィルター、またはワークスペースの 12 桁の ID または EnvID。 |
|
ドキュメントのコンテンツ
|
file | True | file |
付随するファイル名フィールドにファイル名と拡張子を入力します。 |
|
最近使用したものに追加
|
addToRecent | boolean |
最近使用したものに追加 |
|
|
ドキュメント プロファイル
|
profile | string |
ドキュメント プロファイルの設定 (JSON形式) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string | |
|
拡張子
|
extension | string | |
|
名前
|
name | string |
ドキュメントの名前の変更
ドキュメントの名前を変更する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
新しい名前
|
name | True | string |
ドキュメントの履歴
ドキュメントに対して実行されたアクションのリストを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
ドキュメントの更新
ドキュメントのコンテンツを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
ドキュメントの延長期間
|
extension | string |
ドキュメントの延長期間を変更する場合にのみ必要。 先行期間は含めないでください。 |
|
|
Base64 でエンコード済みか?
|
base64 | boolean |
Base64 でエンコード済みか? |
|
|
更新されたドキュメント コンテンツ
|
body | True | byte |
ドキュメントのコンテンツ。 |
ドキュメントをフォルダにファイリングまたはファイリング解除する
フォルダー内のアイテムをファイリングするか、フォルダーからアイテムをファイリング解除する。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
id | True | string |
12 桁のフォルダー ID |
|
ドキュメント ID
|
item | True | string |
12 桁のドキュメント ID。 |
|
ファイリングまたはファイリング解除
|
action | True | string |
ファイリングまたはファイリング解除 |
ドキュメントを削除します
ドキュメントの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
完全に削除する
|
permanent | boolean |
ドキュメントを削除済みアイテムに移動するのではなく、完全に削除する必要があることを示します。 |
フォルダーのフォロー
新しいコンテンツがフォルダーに追加されたときにアラートを受信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
id | True | string |
12 桁のフォルダー ID |
|
受信者
|
recipients | True | string |
セミコロンで区切られた、1 つ以上の有効なメール アドレスのリスト。 重複は無視されます。 |
|
送信
|
send | string |
アラートを受信するユーザーのカテゴリ。 |
フォルダーの作成
新しいフォルダーの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー名
|
name | True | string |
フォルダー名。 |
|
親 ID
|
parent | string |
新しいフォルダの親コンテナーの ID または EnvID (12桁)。 |
|
|
キャビネット ID
|
cabinet | string |
(NG で始まる。) 親にフォルダーまたはワークスペース ID が指定されている場合は省略できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
standardAttributes.id | string | |
|
名前
|
standardAttributes.name | string |
フォルダーの削除
フォルダーの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
id | True | string |
12 桁のフォルダー ID |
|
完全に削除する
|
permanent | boolean |
フォルダーを削除済みアイテムに移動するのではなく、完全に削除する必要があることを示します。 下位のサブフォルダーを含むフォルダーのコンテンツは、完全に削除されません。 |
|
|
フォルダーのコンテンツを削除
|
deleteContents | boolean |
削除されたフォルダー (および下位のサブフォルダー) 内のドキュメントも、単にファイリング解除するのではなく、削除する必要があることを示します。 |
フォルダーの名前を変更
フォルダーの名前を変更する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
id | True | string |
12 桁のフォルダー ID |
|
新しい名前
|
name | True | string |
フォルダー項目の取得
ドキュメントやサブフォルダーなど、フォルダーのコンテンツを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォルダー ID
|
id | True | string |
12 桁のフォルダー ID |
|
返す属性
|
$select | string |
属性値のコンマ区切りの一覧。 詳細は、REST API のドキュメントを参照。 |
ユーザー キャビネットのリストの取得
ユーザー キャビネット
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string | |
|
isCollaborationSpacesEnabled
|
isCollaborationSpacesEnabled | string | |
|
名前
|
name | string | |
|
repositoryId
|
repositoryId | string | |
|
repositoryName
|
repositoryName | string | |
|
wsAttrNum
|
wsAttrNum | integer | |
|
wsOrgAttrNum
|
wsOrgAttrNum | integer |
ユーザーを作成
リポジトリにユーザーを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー名
|
username | True |
(ユーザーのメール アドレスと同じ) |
|
|
名
|
displayFirstName | True | string |
名 |
|
ミドルネーム
|
displayMiddleName | string |
ミドルネーム |
|
|
姓
|
displayLastName | True | string |
姓 |
|
メール アドレス
|
True |
メール アドレス |
||
|
外部ユーザー
|
external | True | boolean |
(追加時にのみ適用可能) |
|
ようこそメールの送信
|
sendWelcome | True | boolean |
ようこそメールの送信 |
|
リポジトリ ID
|
repository | True | string |
(CA で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
displayName
|
displayName | string | |
|
電子メール
|
|||
|
ID
|
id | string | |
|
外部
|
external | boolean |
ユーザー情報を取得
ユーザーに関する情報を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
id | True | string |
NetDocuments により割り当てられたユーザー ID。 |
|
キャビネット ID
|
cabGuid | string |
(NG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
displayName
|
displayName | string | |
|
電子メール
|
|||
|
ID
|
id | string | |
|
組織
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
外部
|
external | boolean |
リポジトリ グループの作成
リポジトリ グループを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
グループ名
|
name | True | string |
グループ名 |
|
外部
|
external | True | boolean |
外部 |
|
リストで非表示
|
hidden | True | boolean |
リストで非表示 |
|
非表示のメンバーシップ
|
hideMembership | True | boolean |
非表示のメンバーシップ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部
|
external | boolean | |
|
非表示
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
ID
|
id | string | |
|
名前
|
name | string |
リポジトリ グループの削除
リポジトリ グループを削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
グループ ID
|
groupID | True | string |
(UG で始まる) |
リポジトリ グループの取得
リポジトリ グループの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
フィルター
|
$filter | string |
(フィルター条件については、ドキュメントを参照してください) |
|
|
結果の件数
|
$top | string |
(既定値は 5,000。 最大 10,000) |
|
|
ページ分割
|
paging | boolean |
(結果をページで返す。デフォルトは false) |
|
|
ページング トークン
|
$skiptoken | string |
(ページング用。前の呼び出しによって「次へ」として返される) |
|
|
返される情報
|
returnInfo | string |
all はグループ名を返す。 デフォルトは空白で、ID のみを返す |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of string |
リポジトリ ユーザーの取得
リポジトリ ユーザーの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
displayName
|
displayName | string | |
|
電子メール
|
string | ||
|
外部
|
external | boolean | |
|
ID
|
id | string | |
|
lastLogin
|
lastLogin | string | |
|
登録済み
|
registered | string |
リポジトリ ログの取得
リポジトリ ログの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
開始日時
|
start | string |
(デフォルトは 30 日、形式 yyyy-MM-dd または yyyy-MM-ddThh:mm:ssZ) |
|
|
終了日時
|
end | string |
(開始日時と同じ形式。デフォルトは今日) |
|
|
ログ タイプ
|
Logtype | True | string |
ログ タイプ |
リポジトリへのユーザーの追加またはリポジトリからのユーザーの削除
リポジトリへのユーザーの追加またはリポジトリからのユーザーの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
ユーザーの追加または削除
|
action | True | string |
ユーザーの追加または削除 |
|
ユーザー ID
|
member | True | string |
ユーザー ID |
|
外部ユーザー
|
external | True | boolean |
外部ユーザー |
|
ユーザーの削除 (フェデレーションの場合)
|
deleteIfFederated | boolean |
(削除時にのみ適用可能) |
リポジトリ情報の取得
リポジトリ情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
ルックアップ テーブル エントリの作成または更新
ルックアップ テーブル エントリの作成または更新
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
属性 ID
|
attributeID | True | string |
(先頭の「10」を削除する) |
|
キー
|
parentID | True | string |
キー |
|
内容
|
description | string | ||
|
タイプ
|
defaulting | string | ||
|
訴訟ホールド
|
hold | boolean | ||
|
クローズ日
|
closed | string |
形式 '/Date(1970 年 1 月 1 日からのミリ秒数 +-UTC)'、例: '/Date(1582261200000-0500)/' |
|
|
フィルターされたアクセス許可
|
filtered_permissions | True | boolean | |
|
強制するアクセス許可
|
force_permissions | True | boolean | |
|
ビュー
|
view | True | boolean | |
|
編集
|
edit | True | boolean | |
|
共有
|
share | True | boolean | |
|
の管理
|
administer | True | boolean | |
|
アクセス権なし
|
noAccess | True | boolean | |
|
キャビネットの既定
|
cabDefault | True | boolean | |
|
プリンシパル
|
principal | True | string |
(ユーザーまたはグループ ID) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
ルックアップ テーブル エントリの取得、または子テーブル エントリの検索
ルックアップ テーブル エントリの取得、または子テーブル エントリの検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
属性 ID
|
attributeID | True | string |
(先頭の「10」を削除する。 単一の値を返すには、親属性 ID を入力する。子エントリを検索するには、子属性 ID を入力する。) |
|
キー
|
parentID | True | string |
(単一の値を返すには、単一属性キーを入力する。子エントリを検索するには、子属性キーを入力する。) |
|
フィルター (検索時のみ)
|
$filter | string |
(使用可能なフィルターについては、ドキュメントを参照) |
|
|
取得するフィールド
|
$select | string |
(「key」、「description」、「parent」、「hold」、「closed」、「defaulting」、「type」、「user」、「access」のコンマ区切りリストを含める) |
|
|
スキップする一致レコードの数
|
$skip | integer |
(結果のブロックを複数取得するときに使用される。) |
|
|
返す最大レコード数
|
$top | integer |
返す最大レコード数 |
|
|
順番の結果
|
$orderby | string |
順番の結果 |
ルックアップ テーブル エントリの検索
ルックアップ テーブル エントリの検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
属性 ID
|
attributeID | True | string |
(先頭の「10」を削除する) |
|
フィルター
|
$filter | string |
(使用可能なフィルターについては、ドキュメントを参照) |
|
|
取得するフィールド
|
$select | string |
(「key」、「description」、「parent」、「hold」、「closed」、「defaulting」、「type」、「user」、「access」のコンマ区切りリストを含める) |
|
|
スキップする一致レコードの数
|
$skip | integer |
(結果のブロックを複数取得するときに使用される。) |
|
|
返す最大レコード数
|
$top | integer |
返す最大レコード数 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
行
|
rows | array of object | |
|
デフォルト
|
rows.defaulting | string | |
|
説明
|
rows.description | string | |
|
保留
|
rows.hold | boolean | |
|
キー
|
rows.key | string | |
|
終了
|
rows.closed | string | |
|
アクセス
|
rows.access | string |
ロックするドキュメントのバージョン
ロックするドキュメントのバージョン
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
ドキュメントのバージョン
|
version | True | integer |
ドキュメントのバージョン |
|
バージョンの説明
|
description | string |
バージョンの説明 |
ワークスペースの取得または作成 (単一の属性を使用)
ワークスペースの取得または作成 (単一の属性を使用)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
|
単一の値
|
parentID | True | string |
キャビネット内のワークスペースを定義するために使用される単一の値。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
standardAttributes.id | string |
ワークスペースの取得または作成 (親属性と子属性を使用)
ワークスペースの取得または作成 (親属性と子属性を使用)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
|
親の値
|
parentID | True | string |
キャビネット内のワークスペースを定義するために使用される親の値。 |
|
子の値
|
childID | True | string |
キャビネット内のワークスペースを定義するために使用される子の値。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
standardAttributes.id | string |
ワークスペースの情報の取得
ワークスペースの情報の取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークスペース ID
|
workspaceID | True | string |
ワークスペース ID |
ワークスペースの更新
ワークスペースの更新
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークスペース ID
|
workspaceID | True | string |
ワークスペース ID |
子ルックアップ テーブル エントリの作成または更新
子ルックアップ テーブル エントリの作成または更新
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
子属性 ID
|
childAttributeID | True | string |
(先頭の「10」を削除する) |
|
親キー
|
parentID | True | string |
親キー |
|
子キー
|
childID | True | string |
子キー |
|
内容
|
description | string | ||
|
タイプ
|
defaulting | string | ||
|
訴訟ホールド
|
hold | boolean | ||
|
クローズ日
|
closed | string |
形式 '/Date(1970 年 1 月 1 日からのミリ秒数 +-UTC)'、例: '/Date(1582261200000-0500)/' |
|
|
フィルターされたアクセス許可
|
filtered_permissions | True | boolean | |
|
強制するアクセス許可
|
force_permissions | True | boolean | |
|
ビュー
|
view | True | boolean | |
|
編集
|
edit | True | boolean | |
|
共有
|
share | True | boolean | |
|
の管理
|
administer | True | boolean | |
|
アクセス権なし
|
noAccess | True | boolean | |
|
キャビネットの既定
|
cabDefault | True | boolean | |
|
プリンシパル
|
principal | True | string |
(ユーザーまたはグループ ID) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
子ルックアップ テーブル エントリの削除
子ルックアップ テーブル エントリの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
子属性 ID
|
childAttributeID | True | string |
(先頭の「10」を削除する) |
|
親キー
|
parentID | True | string |
親キー |
|
子キー
|
childID | True | string |
子キー |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
子ルックアップ テーブル エントリの削除
子ルックアップ テーブル エントリの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
属性 ID
|
attributeID | True | string |
(先頭の「10」を削除する) |
|
キー
|
parentID | True | string |
キー |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
子ルックアップ テーブル エントリの取得
子ルックアップ テーブル エントリの取得
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リポジトリ ID
|
repositoryID | True | string |
(CA で始まる) |
|
子属性 ID
|
childAttributeID | True | string |
(先頭の「10」を削除する) |
|
親キー
|
parentID | True | string |
親キー |
|
子キー
|
childID | True | string |
子キー |
戻り値
新しいバージョンのドキュメントの作成
新しいバージョンのドキュメントを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
id | True | string |
12 桁のドキュメント ID。 |
|
ドキュメントの延長期間
|
extension | string |
先行期間は含めないでください。 |
|
|
バージョンの説明
|
version_description | string |
バージョンの説明 |
|
|
新しいバージョンの名前
|
verName | string |
新しいバージョンの名前 |
|
|
公式バージョンの作成
|
official | boolean |
このパラメータが設定されていない場合、新しいバージョンは公式バージョンにはなりません。 |
|
|
最近のドキュメントに追加
|
addToRecent | boolean |
最近のドキュメントに追加 |
|
|
ソース バージョン番号
|
srcVer | string |
以前のバージョンからコンテンツをコピーする場合、コピーするドキュメントのバージョン。 |
|
|
サブバージョンとして作成する
|
allocatesubversion | boolean |
フルバージョンではなく、サブバージョンとして作成します。 |
|
|
新しいバージョンのドキュメント コンテンツ
|
body | binary |
別のバージョンや公式バージョンをコピーしていない場合、新しいバージョンのコンテンツ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
latestVersionNumber
|
latestVersionNumber | integer | |
|
newVer
|
newVer | integer | |
|
newVersionLabel
|
newVersionLabel | string | |
|
officialVer
|
officialVer | integer | |
|
officialVerName
|
officialVerName | string | |
|
バージョン
|
versions | integer |
現在のユーザー情報の取得
現在のユーザーに関する情報を取得する。ID は不要
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabGuid | string |
(NG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
displayName
|
displayName | string | |
|
電子メール
|
|||
|
ID
|
id | string | |
|
組織
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
外部
|
external | boolean |
非表示のキャビネット グループのアクセス権を取得する
非表示のキャビネット グループのアクセス権を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabinetID | True | string |
(NG で始まる) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
管理
|
administer | boolean | |
|
cabDefault
|
cabDefault | boolean | |
|
編集
|
edit | boolean | |
|
名前
|
name | string | |
|
noAccess
|
noAccess | boolean | |
|
プリンシパル
|
principal | string | |
|
共有
|
share | boolean | |
|
ビュー
|
view | boolean |
トリガー
| キャビネットの検索 |
特定のキャビネットを検索する |
キャビネットの検索
特定のキャビネットを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャビネット ID
|
cabId | True | string |
(NG で始まる) |
|
検索条件
|
q | True | string |
NetDocuments Web インターフェイスと、同じ形式と演算子を使用する。 |
|
並べ替え順
|
$orderby | string |
並べ替え順 |
|
|
結果の最大数
|
$top | string |
1 から 500 までの整数 既定値は 100 です。 |
|
|
返す属性
|
$select | string |
属性値のコンマ区切りの一覧。 詳細は、REST API のドキュメントを参照。 |