iManage Work
iManage Work コネクターは、iManage Work 環境にすべてのファイルを安全に保管しながら、繰り返しのタスクや承認プロセスを自動化することを可能にします。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | iManage LLC |
| [URL] | https://docs.imanage.com |
| メール | cloudsupport@imanage.com |
| Connector Metadata | |
|---|---|
| 発行者 | iManage LLC |
| Web サイト | https://imanage.com |
| プライバシー ポリシー | https://imanage.com/about/privacy-notice/ |
| カテゴリー | コンテンツとファイル;生産性 |
iManage Work
iManage は、ナレッジワーカー向けのドキュメントおよび電子メール管理ソリューションの業界をリードするプロバイダーです。 iManage プラットフォームは、文書や電子メールの情報を整理して保護するため、プロフェッショナルは必要なものを検索し、それに基づいて行動し、より効果的にコラボレーションを行うことができます。 iManage Work コネクターは、iManage Work 環境にすべてのファイルを安全に保管しながら、繰り返しのタスクや承認プロセスを自動化することを可能にします。
前提条件
このコネクタは、cloudimanage.com に接続するすべての iManage Work のお客様が利用できます。 まず、Power Automate アプリケーションは、iManage Work 環境の 管理者が有効化する必要があります。 有効にすると、環境に固有のURLと、コネクタがアクションを実行できるログイン アカウントとパスワードが必要になります。 詳細については、FAQ を参照してください。
資格情報の入手方法
既存の iManage Work ユーザーの場合は、iManage Work の認証情報を入力してログインしてください。 そうでない場合は、システム管理者にお問い合わせください。
iManage Work コネクタを使い始める
iManage Work コネクタを使い始めるには、以下の手順を実行します:
- 作成およびインスタント クラウド フローを作成し、+ 新規ステップを選択します。
- iManage Work を検索すると、利用可能なすべての iManage Work アクションが表示されます。
- 目的の iManage Work アクションを選択します。
- iManage Work にサインインしていない場合は、サインインの画面が表示されます。
- サインインを選択します。
- cloudimanage.com など、iManage Work への接続に使用する URL を入力します。
- iManage Work のユーザー ID を入力します。
- 選択したアカウントのパスワードを入力し、ログインを選択します。 この時点から、iManage Work アクションを使用するすべてのフローは、これらのユーザー認証情報を使用して接続されます。 別の iManage ユーザー アカウントは、マイ コネクションで新しい接続を追加し、切り替えることで使用できます。
既知の問題と制限事項
既知の問題と制限については、https://docs.imanage.com/power-automate/index.html を確認してください。
一般的なエラーと解決策
一般的なエラーと解決策のリストについては、https://docs.imanage.com/power-automate/index.html を参照してください。
よくあるご質問
よくあるご質問については、https://docs.imanage.com/power-automate/index.html を参照してください。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アクセス許可のコピー |
アクセス許可、オプションでデフォルトのセキュリティを、ある iManage Work オブジェクトから別の iManage Work オブジェクトにコピーします。 「コピーの種類」では、ソースとコピー先のアクセス許可の組み合わせを処理する方法を選択できます。 「上書き」では、ターゲット オブジェクトのユーザー、グループ、アクセス許可レベルがソース オブジェクトのものと完全に一致するように更新されます。 「マージ」はソース オブジェクト上のすべてのユーザーとグループを維持し、それらをソースと結合しますが、個人またはグループのアクセス許可レベルが競合する場合、「マージ (オプティミスティック)」は下位のアクセス許可を取得し、「マージ (オプティミスティック)」は、競合するユーザーまたはグループに対して上位のアクセス許可を取得します。 |
| アクセス許可の取得 |
ドキュメント、フォルダー、またはワークスペースのユーザーまたはグループのアクセス許可プロパティを取得します。 応答プロパティは、ユーザーまたはグループの権限によって異なる場合があります。 |
| アクセス許可の更新 |
オブジェクトの権限を更新します。 |
| クラスの取得 |
指定された条件に一致する、ライブラリで利用可能なドキュメント クラスのリストを取得します。 |
| グループのメンバーを取得 |
指定されたグループに所属し、指定された条件に合致するユーザーの詳細を取得します。 |
| コア拡張メタデータ分類ノード値の検索 |
指定された検索条件に一致するコア拡張メタデータ タクソノミーのノード値を検索します。 |
| サブ クラスの取得 |
指定された条件に一致するすべてのライブラリのサブクラスを取得します。 |
| ドキュメント バージョンのレベル上げ |
ドキュメントの既存のバージョンを最新バージョンに昇格します。 指定されたジャーナル ID またはバージョンから新しいバージョンが作成され、最新バージョンに昇格されます。 ジャーナル ID またはバージョンのどちらかを指定する必要がありますが、両方を指定することはできません。 |
| ドキュメント バージョンを取得する |
現在のユーザーが指定されたドキュメントに対してアクセスできるすべてのバージョンのプロファイルを取得します。 |
| ドキュメント プロパティの更新 |
ドキュメント プロファイルの更新を実行します。 プロファイルの更新中は、ドキュメントが使用中であってはならず、チェックアウトされたドキュメントのプロファイルを更新できません。 操作後に更新されたドキュメント プロファイルを返します。 |
| ドキュメント プロファイルの取得 |
特定のドキュメント ID に関連付けられたドキュメント プロパティを取得します。 |
| ドキュメント リファレンスを追加する |
ドキュメント参照またはドキュメント ショートカットを別のフォルダに追加します。 |
| ドキュメントのアップロード |
指定したフォルダーにファイルを新規ドキュメントとしてアップロードします。 |
| ドキュメントのコア拡張メタデータ プロパティを取得する |
ドキュメントのコア拡張メタデータ プロパティを取得します。 |
| ドキュメントのコア拡張メタデータ プロパティを設定する |
ドキュメントのコア拡張メタデータ プロパティを設定します。 |
| ドキュメントをコピーする |
指定したフォルダーにドキュメントをコピーします。 |
| ドキュメントをダウンロードする |
ドキュメント ID に基づいて、特定のドキュメントのバージョンをダウンロードします。 latest が trueの場合、このドキュメントの最新版がダウンロードされます。 ダウンロードはストリームであるため、ローカルには保存されません。 |
| ドキュメントを移動する |
指定したフォルダーにドキュメントを移動します。 |
| ドキュメント参照の削除 |
指定されたフォルダーからドキュメント参照を削除します。 |
| ドキュメント履歴エントリーの追加 |
エントリーをドキュメントの履歴にイベントとして追加します。 |
| フォルダーの検索 |
フォルダーの検索。 |
| ユーザーの詳細を取得する |
指定されたライブラリからユーザーに関する情報を取得します。 |
| ライブラリの取得 |
ユーザがアクセスできるライブラリの一覧を取得します。 |
| ワークスペースのテンプレートを取得する |
ライブラリで利用可能なテンプレートのリストを取得します。 ワークスペース テンプレートは、構造が新しいワークスペースにコピーされる定義済みのワークスペースです。 |
| ワークスペースのプロファイル取得する |
ワークスペースのプロファイルを取得し、オプションでワークスペースの許可された操作のリストを取得します。 |
| ワークスペースの作成 |
選択したテンプレートに基づき、新しいワークスペースを作成します。 ワークスペース テンプレートは、構造が新しいワークスペースにコピーされる定義済みのワークスペースです。 新しいワーク スペースを作成すると、ワークスペース テンプレートに対する制限が自動的に適用されます。 |
| ワークスペースの更新 |
指定されたワークスペースの情報を更新します。 文字列フィールドの既存の値を削除するには、フィールドの値を一重引用符または二重引用符で囲んだ空の文字列に設定します。 |
| ワークスペース検索 |
ワークスペースの検索。 |
| ワークフロー状態の更新 |
ワークフローの実行状態を更新します。 このアクションは、iManage が提供するトリガーで開始するように作成されたワークフローでのみ使用できます。 |
| 受託者を取得する |
ドキュメント、フォルダー、またはワークスペースに対する特定の権限を持つ受託者のリストを取得します。 受託者は、ユーザーまたはグループにすることができます。 |
| 既定のセキュリティを更新する |
ドキュメント、フォルダー、ワークスペースの既定のセキュリティを更新します。 |
| 現在のドキュメント バージョンを更新するか、新しいドキュメント バージョンを作成する |
ドキュメントの指定されたバージョンを更新するか、新しいバージョンを作成します。 このアクションは、ドキュメントのプロファイルとコンテンツを更新できます。 「現在のバージョンを更新」オプションが指定された場合、ドキュメントは新しいものに置き換えられ、以前のドキュメントのプロファイルは維持されます。 「新しいバージョンの作成」を指定すると、フォルダーのプロファイルを継承した新しいバージョンのドキュメントが作成されます。 操作が正常に実行されると、ドキュメント プロファイルが返されます。 |
| 編集 name-value ペア |
ドキュメント、フォルダ、またはワークスペースの name-value ペアのプロパティを作成、更新、または削除します。 名前と値のペアを削除するには、キーの値を一重引用符または二重引用符 ('') で囲んだ空の文字列に設定します。 |
アクセス許可のコピー
アクセス許可、オプションでデフォルトのセキュリティを、ある iManage Work オブジェクトから別の iManage Work オブジェクトにコピーします。 「コピーの種類」では、ソースとコピー先のアクセス許可の組み合わせを処理する方法を選択できます。 「上書き」では、ターゲット オブジェクトのユーザー、グループ、アクセス許可レベルがソース オブジェクトのものと完全に一致するように更新されます。 「マージ」はソース オブジェクト上のすべてのユーザーとグループを維持し、それらをソースと結合しますが、個人またはグループのアクセス許可レベルが競合する場合、「マージ (オプティミスティック)」は下位のアクセス許可を取得し、「マージ (オプティミスティック)」は、競合するユーザーまたはグループに対して上位のアクセス許可を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ソース オブジェクトの種類
|
sourceObjectType | True | string |
ソース オブジェクトの種類を指定します。 |
|
ソース オブジェクト ID
|
sourceObjectId | True | string |
アクセス許可のコピー元のオブジェクトの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
|
ターゲット オブジェクトの種類
|
targetObjectType | True | string |
ターゲット オブジェクトの種類を指定します。 |
|
ターゲット オブジェクト ID
|
targetObjectId | True | string |
アクセス許可のコピー先のオブジェクトの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
|
コピーの種類
|
copyType | True | string |
ソース オブジェクトのアクセス許可をターゲット オブジェクトのアクセス許可とマージするか、ターゲット オブジェクトのアクセス許可をソースのアクセス許可で上書きするかを指定します。 詳細については、アクションの説明を参照してください。 |
|
デフォルト セキュリティのコピー
|
copyDefaultSecurity | True | boolean |
ソース オブジェクトのデフォルト セキュリティをターゲット オブジェクトにコピーするように指定します。 ソース オブジェクトのデフォルト セキュリティが「継承」の場合、継承されたデフォルト セキュリティはソースからターゲット オブジェクトにコピーされます。 |
戻り値
アクセス許可の取得
ドキュメント、フォルダー、またはワークスペースのユーザーまたはグループのアクセス許可プロパティを取得します。 応答プロパティは、ユーザーまたはグループの権限によって異なる場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
Object ID
|
objectId | True | string |
ドキュメント、フォルダ、ワークスペースの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
既定のセキュリティ
|
data.default_security | string |
オブジェクトの既定のセキュリティを示す。 指定可能な値は 「inherit」, 「public」, 「view」, 「private」 のいずれかです。 |
|
継承済みの既定のセキュリティ
|
data.inherited_default_security | string |
規定のセキュリティが「継承」に設定されている場合、フォルダの継承された規定のセキュリティを示します。 可能な値は、「public」、「view」、「public」 です。 |
|
アクセス許可
|
data.acl | AccessPermissions |
1 人以上のユーザーおよび/またはグループのアクセス許可の集合を示します。 |
|
すべてのユーザーの ID
|
data.all_user_ids | string |
すべてのユーザーの ID のリストを文字列として連結し、セミコロンで区切って示します。 |
|
すべてのグループの ID
|
data.all_group_ids | string |
すべてのユーザーの ID のグループを文字列として連結し、セミコロンで区切って示します。 |
アクセス許可の更新
オブジェクトの権限を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
Object ID
|
objectId | True | string |
ドキュメント、フォルダ、ワークスペースの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
|
アクセス レベル
|
access_level | True | string |
アクセスレベルを指定します。 |
|
Users
|
users | string |
アクセス レベルを設定する 1 人以上のユーザーをセミコロンで区切って指定します。 |
|
|
Groups
|
groups | string |
アクセス レベルを設定する 1 人以上のグループをセミコロンで区切って指定します。 |
戻り値
クラスの取得
指定された条件に一致する、ライブラリで利用可能なドキュメント クラスのリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット クラスのライブラリ ID を指定します。 |
|
クラス ID
|
alias | string |
検索するクラスの ID を指定します。 カンマ区切りのリストが可能です。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 |
|
|
説明設定
|
description | string |
説明フィールドで照合するテキストを指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) に対応しています。 部分一致には対応していません。 |
|
|
エコー
|
echo | boolean |
このクラスのドキュメントがドキュメントをエコーできるかどうかを指定します。 |
|
|
HIPAA
|
hipaa | boolean |
このクラスのドキュメントが HIPAA に準拠した暗号化を使用しているかどうかを指定します。 |
|
|
Indexable
|
indexable | boolean |
このクラスのドキュメントがシステムのフルテキスト インデクサによってインデックス化されるかどうかを指定します。 |
|
|
クエリ
|
query | string |
ID または説明フィールドと一致させるテキストを指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
サブクラス必須
|
subclass_required | boolean |
クラスが必須のサブクラスを持っているかどうかを指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
上位一致クラス ID
|
data.topMatchingId | string |
上位一致クラスの ID を示します。 例: 'PETITION'。 |
|
上位一致クラスの説明
|
data.topMatchingDescription | string |
上位一致クラスの説明を示します。 |
|
results
|
data.results | array of object |
指定された基準に一致するライブラリで使用可能なクラスのリストを示します。 |
|
プロパティ
|
data.results.description | string |
クラスに関する追加情報を示します。 |
|
HIPAA である
|
data.results.hipaa | boolean |
文書が暗号化されているかどうかを示します。 |
|
ID
|
data.results.id | string |
クラスの ID を示します。 例: 'PETITION'。 |
|
Indexable である
|
data.results.indexable | boolean |
ドキュメントがシステムによって索引付けされているかどうかを示します。 |
|
既定のセキュリティ
|
data.results.default_security | string |
既定のセキュリティ アクセスレベルを示します。 可能な値は、「public」、「view」、「private」 です。 |
|
保持する
|
data.results.retain | integer |
このクラスの非アクティブ ドキュメントが期限切れとなるまでの日数を示します。 |
|
必須フィールド
|
data.results.required_fields | array of string |
このクラスのドキュメントを作成、または更新する際に入力が必須であるカスタムプロパティを示します。 |
|
シャドウである
|
data.results.shadow | boolean |
このクラスのドキュメントをチェックインした後、ユーザのローカル コンピュータにシャドーイング (保持) されるかどうかを示します。 |
|
サブクラス必須である
|
data.results.subclass_required | boolean |
このクラスにサブクラスが必要であるかどうかを示します。 |
グループのメンバーを取得
指定されたグループに所属し、指定された条件に合致するユーザーの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット グループのライブラリ ID を指定します。 |
|
Group ID
|
groupId | True | string |
グループの ID を指定します。 例: 'MARKETING'。 |
|
ログイン ステータス
|
logon_status | string |
各ユーザーの現在の「allow_logon」 プロパティ値に基づいて、ユーザーに対するフィルタを指定します。 |
|
|
Limit
|
limit | integer |
グループの総メンバー数に関係なく、返すメンバーの最大数を指定します。 |
|
|
優先するライブラリ
|
preferred_library | string |
優先ライブラリーが指定された値と一致するユーザーのみを返すように指定します。 |
|
|
場所
|
location | string |
地理的な場所に基づいてユーザーを検索するために使用する場所を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) には対応していません。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of UserProfileInArray |
指定されたグループに属し、指定された基準に一致するユーザーのリストを示します。 |
コア拡張メタデータ分類ノード値の検索
指定された検索条件に一致するコア拡張メタデータ タクソノミーのノード値を検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
検索を実行するライブラリの ID を指定します。 |
|
Taxonomy プロパティ
|
taxonomyProperty | True | string |
ノード値を検索する分類プロパティを指定します。 |
|
ID
|
id | string |
分類ノード値の表示識別子を指定します。 この検索では、大文字と小文字は区別されません。 部分一致には対応していません。 |
|
|
クエリ
|
query | string |
ワイルドカード (*) 検索を使用して分類ノード値を照合するクエリを指定し、表示識別子または説明の部分一致を提供します。 |
|
|
ノードの状態
|
enabled_state | string |
有効または無効、またはその両方の分類ノード値のみを返すように指定します。 |
|
|
パスを含める
|
include_path | boolean |
一致するノード値へのフルパスを返すように指定します。 パスは、分類内の最上位ノードから始まり、一致するノードの直接の親までのすべてのノードを含む順序付きリストです。 |
|
|
祖先ノードの SSID
|
children_of_ssid | string |
検索を制限する分類ノードの一意のシステム生成 ID を指定します。 |
|
|
直属の子のみ
|
immediate_children_only | boolean |
検索結果を "祖先ノード SSID" で指定された分類ノードの直接の子孫に限定するように指定します。 "祖先ノード SSID" に空の文字列を一重引用符または二重引用符で囲んで指定することで、検索を分類法のルート レベルに限定できます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SSID
|
data.topMatchingResult.created_by.ssid | string |
上位に一致するノード値を作成したユーザーの一意のシステム生成 ID を示します。 |
|
作成日
|
data.topMatchingResult.create_date | string |
上位一致ノード値が作成された日時 (ISO 8601 形式) を示します。 |
|
Description
|
data.topMatchingResult.description | string |
上位に一致するノード値の説明を示します。 |
|
SSID
|
data.topMatchingResult.edited_by.ssid | string |
上位に一致するノード値を最後に編集したユーザーの一意のシステム生成 ID を示します。 |
|
日付の編集
|
data.topMatchingResult.edit_date | string |
上位一致ノード値が最後に編集された日時 (ISO 8601 形式) を示します。 |
|
Is Enabled
|
data.topMatchingResult.enabled | boolean |
上位一致ノード値が有効かどうかを示します。 |
|
ID
|
data.topMatchingResult.id | string |
上位に一致するノード値の ID を示します。 |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
上位に一致するノード値の即時親ノードの、独自のシステム生成 ID を示します。 |
|
SSID
|
data.topMatchingResult.ssid | string |
上位に一致するノード値の一意のシステム生成 ID を示します。 |
|
Path
|
data.topMatchingResult.path | array of object |
上位に一致するノード値へのフルパスを示します。 パスは、分類内の最上位ノードから始まり、一致するノードの直接の親までのすべてのノードを含む順序付きリストです。 |
|
各 ID
|
data.topMatchingResult.path.id | string |
上位に一致するノードのパスのノード値の表示 ID を示します。 |
|
各 SSID
|
data.topMatchingResult.path.ssid | string |
上位に一致するノード値のノード値の、独自のシステム生成 ID を示します。 |
|
コア拡張メタデータ タクソノミーの検索結果
|
data.results | array of TaxonomyNodeValue |
検索に一致する 1 つ以上のコア拡張メタデータ タクソノミーのノード値を示します。 |
|
すべての分類ノード SSID
|
data.all_taxonomy_ssids | string |
すべての分類ノード SSID のリストを文字列として連結し、セミコロンで区切って示します。 |
サブ クラスの取得
指定された条件に一致するすべてのライブラリのサブクラスを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット サブクラスのライブラリ ID を指定します。 |
|
クラス ID
|
classId | True | string |
このサブクラスの親となるクラスの ID を指定します。 例: 'PETITION'。 |
|
サブクラス ID
|
alias | string |
検索するサブクラスの ID を指定します。 カンマ区切りのリストが可能です。 ワイルドカード文字 (*) に対応しています。 ワイルドカード文字を使用した場合、部分一致に対応しています。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 |
|
|
説明設定
|
description | string |
説明フィールドで照合するテキストを指定します。 ワイルドカード文字 (*) に対応しています。 ワイルドカード文字を使用した場合、部分一致に対応しています。 |
|
|
エコー
|
echo | boolean |
サブクラスがユーザーのローカル ハードディスクにエコーされるかどうかを指定します。 これは、オフラインでの作業を容易にするためです。 |
|
|
HIPAA
|
hipaa | boolean |
HIPAA 準拠のサブクラスが返されるかどうかを指定します。 |
|
|
クエリ
|
query | string |
サブクラス ID または説明フィールドと一致させるテキストを指定します。 ワイルドカード文字 (*) に対応しています。 部分一致に対応しています。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
上位一致サブクラス ID
|
data.topMatchingId | string |
上位一致サブクラスの ID を示します。 |
|
上位一致サブクラスの説明
|
data.topMatchingDescription | string |
上位一致サブクラスの説明を示します。 |
|
results
|
data.results | array of object | |
|
既定のセキュリティ
|
data.results.default_security | string |
既定のセキュリティ アクセスレベルを示します。 可能な値は、「public」、「view」、「private」 です。 |
|
プロパティ
|
data.results.description | string |
サブクラスに関する追加情報を示します。 最大 255 文字までです。 |
|
HIPAA である
|
data.results.hipaa | boolean |
文書が暗号化されているかどうかを示します。 |
|
ID
|
data.results.id | string |
ドキュメント プロファイル情報を作成または変更するために使用されるサブクラスの ID を示します。 例: 'GUARDIANSHIP'。 |
|
Parent ID
|
data.results.parent.id | string |
サブクラスの親クラス ID を示します。 |
|
必須フィールド
|
data.results.required_fields | array of string |
このサブクラスのドキュメントを作成、または更新する際に入力が必須であるカスタムプロパティを示します。 |
|
保持する
|
data.results.retain | integer |
このサブクラスの非アクティブ ドキュメントが期限切れとなるまでの日数を示します。 |
|
シャドウである
|
data.results.shadow | boolean |
このサブクラスのドキュメントをチェックインした後、ユーザのローカル コンピュータにシャドーイング (保持) されるかどうかを示します。 |
ドキュメント バージョンのレベル上げ
ドキュメントの既存のバージョンを最新バージョンに昇格します。 指定されたジャーナル ID またはバージョンから新しいバージョンが作成され、最新バージョンに昇格されます。 ジャーナル ID またはバージョンのどちらかを指定する必要がありますが、両方を指定することはできません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
Version
|
version | integer |
新しく昇格したバージョンの基礎として使用するバージョン番号を指定します。 |
|
|
ジャーナル ID
|
journalId | string |
新しく昇格したジャーナル ID の基礎として使用するバージョン番号を指定します。 |
|
|
Comment
|
comment | string |
ドキュメントの追加情報を指定します。 |
|
|
Alias
|
alias | string |
このドキュメントのエイリアスを指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
ドキュメントのクラス
|
class | string |
ドキュメントのクラスを指定します。 |
|
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 |
|
|
拒否された
|
is_declared | boolean |
ドキュメントの新しいバージョンをレコードとして宣言するかどうかを指定します。 レコードとして宣言されたドキュメントは、iManage Work システム 管理者を除き、編集または削除できません。 |
|
|
HIPAA である
|
is_hipaa | boolean |
新しいバージョンの文書を暗号化するかどうかを指定します。 |
|
|
ドキュメント名
|
name | string |
ドキュメントのファイル名を指定します。 |
|
|
Operator
|
operator | string |
ドキュメントをチェックアウトしているユーザー、またはドキュメントのプロファイルを編集中のユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
保持日数
|
retain_days | integer |
非アクティブな文書がアーカイブの対象となるまでの日数を指定します。 |
|
|
サブクラス
|
subclass | string |
ドキュメントのサブクラスを指定します。 |
|
|
Custom1
|
custom1 | string |
custom1 の値を指定します。 |
|
|
Custom2
|
custom2 | string |
custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
custom21 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom23
|
custom23 | string |
custom23 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom24
|
custom24 | string |
custom24 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
ドキュメント バージョンを取得する
現在のユーザーが指定されたドキュメントに対してアクセスできるすべてのバージョンのプロファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント プロファイル
|
data | array of MinimalDocumentProfileInArray |
ドキュメント プロパティの更新
ドキュメント プロファイルの更新を実行します。 プロファイルの更新中は、ドキュメントが使用中であってはならず、チェックアウトされたドキュメントのプロファイルを更新できません。 操作後に更新されたドキュメント プロファイルを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Alias
|
alias | string |
このドキュメントのエイリアスを指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
ドキュメントのクラス
|
class | string |
ドキュメントのクラスを指定します。 |
|
|
Comment
|
comment | string |
ドキュメントの追加情報を指定します。 |
|
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 |
|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
拒否された
|
is_declared | boolean |
ドキュメントをレコードとして宣言するかどうかを指定します。 レコードとして宣言されたドキュメントは、iManage Work システム 管理者を除き、編集または削除できません。 |
|
|
HIPAA である
|
is_hipaa | boolean |
ドキュメントを暗号化するかどうかを指定します。 |
|
|
ドキュメント名
|
name | string |
ドキュメントのファイル名を指定します。 |
|
|
Operator
|
operator | string |
ドキュメントをチェックアウトしているユーザー、またはドキュメントのプロファイルを編集中のユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
保持日数
|
retain_days | integer |
非アクティブな文書がアーカイブの対象となるまでの日数を指定します。 |
|
|
サブクラス
|
subclass | string |
ドキュメントのサブクラスを指定します。 |
|
|
Custom1
|
custom1 | string |
custom1 の値を指定します。 |
|
|
Custom2
|
custom2 | string |
custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
custom21 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom23
|
custom23 | string |
custom23 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom24
|
custom24 | string |
custom24 プロパティの値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
ドキュメント プロファイルの取得
特定のドキュメント ID に関連付けられたドキュメント プロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
最新バージョンの取得
|
latest | boolean |
最新版のドキュメントを指定します。 |
ドキュメント リファレンスを追加する
ドキュメント参照またはドキュメント ショートカットを別のフォルダに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
フォルダー ID
|
folderId | True | string |
フォルダーの ID を指定します。 例: 'ACTIVE_US!773'。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント 参照 ID
|
data.id | string |
ドキュメント参照と document_shortcut を示します。 |
|
Wstype
|
data.wstype | string |
オブジェクトの iManage Work タイプを示します。 可能な値は、「document」、「document_shortcut」、「email」 です。 |
ドキュメントのアップロード
指定したフォルダーにファイルを新規ドキュメントとしてアップロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ライブラリの ID を指定します。 |
|
フォルダー ID
|
folderId | True | string |
対象フォルダのフォルダー ID を指定します。 例: 'ACTIVE_US!987'。 |
|
フォルダー プロファイルの継承
|
inherit_profile_from_folder | True | boolean |
プロファイル データが親フォルダーから継承されるかどうかを指定します。 |
|
ロックを保持する
|
keep_locked | boolean |
アップロード後にドキュメントのロックを保持するかどうかを指定します。 |
|
|
Comment
|
comment | string |
更新の追加情報を指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの iManage Work ID を指定します。 |
|
|
Operator
|
operator | string |
ドキュメントをチェックアウトしているユーザー、またはドキュメントのプロファイルを編集中のユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
クラス
|
class | string |
ドキュメントを識別、区別するためのクラスを指定します。 ドキュメント クラスは、ジャンル、部門、地域などで分類されています。 |
|
|
サブクラス
|
subclass | string |
ドキュメントを識別、区別するためのサブクラスを指定します。 ドキュメント サブクラスは、ジャンル、部門、地域などで分類されています。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 可能な値は、「inherit」、「private」、「view」、「public」 です。 |
|
|
HIPAA である
|
is_hipaa | boolean |
ドキュメントを暗号化するかどうかを指定します。 |
|
|
保持日数
|
retain_days | integer |
ドキュメントをアーカイブ用にマークする前に、非アクティブにする必要がある日数を指定します。 |
|
|
ファイル コンテンツ
|
file | True | file |
ファイルのコンテンツを指定します。 |
|
ファイルの作成日
|
file_create_date | date-time |
ファイルが作成された日時 (ISO 8601 形式)を指定します。 ファイルは、iManage Work システムの外部で作成された可能性があります。 この日付は 「create_date」 とは異なる場合があります。 create_date は、iManage Work システムでファイルが作成またはインポートされた日付です。 |
|
|
ファイルの編集日
|
file_edit_date | date-time |
ファイルに対する最新の変更日時 (ISO 8601 形式) を指定します。 ファイルは、iManage Work システムにアップロードされる前に変更された可能性があります。 |
|
|
Custom1
|
custom1 | string |
custom1 の値を指定します。 |
|
|
Custom2
|
custom2 | string |
custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
custom21 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom23
|
custom23 | string |
custom23 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom24
|
custom24 | string |
custom24 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
ドキュメントのコア拡張メタデータ プロパティを取得する
ドキュメントのコア拡張メタデータ プロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
最新
|
latest | boolean |
最新版のドキュメントを指定します。 |
ドキュメントのコア拡張メタデータ プロパティを設定する
ドキュメントのコア拡張メタデータ プロパティを設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
件名
|
key | True | string |
コア拡張メタデータ プロパティの名前を指定します。 |
|
価値
|
value | True | string |
コア拡張メタデータ プロパティに設定する 1 つ以上の値をセミコロンで区切って指定します。 値の設定を解除するには、キーの値を一重引用符または二重引用符で囲まれた空の文字列に設定します。 |
ドキュメントをコピーする
指定したフォルダーにドキュメントをコピーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
宛先フォルダー ID
|
folderId | True | string |
ドキュメントのコピー先の宛先フォルダー ID を指定します。 例: 'ACTIVE_US!987'。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント アクセス
|
data.access | string |
ドキュメントまたはコンテナーに設定されたアクセス レベルのアクセス許可を示します。 アクセス レベルは、作成者またはアイテムへのフル アクセス権を持つユーザーによって設定されます。 可能な値は「no_access」、「read」、「read_write」、「full_access」です。 |
|
Alias
|
data.alias | string |
このドキュメントのエイリアスを示します。 |
|
Author
|
data.author | string |
ドキュメントを作成したユーザーの ID を示します。 例: 'JSMITH'。 |
|
作成者の説明
|
data.author_description | string |
ドキュメントの作成者についての追加情報を示します。 |
|
Cc
|
data.cc | string |
電子メールのカーボン コピー先の受信者を示します。 メールにのみ適用されます。 |
|
ドキュメントのクラス
|
data.class | string |
ドキュメントのクラスを示します。 |
|
ドキュメント クラスの説明
|
data.class_description | string |
ドキュメント クラスに関する追加情報を示します。 |
|
Content Type
|
data.content_type | string |
ドキュメントのコンテンツ タイプを示します。 |
|
ドキュメント作成日
|
data.create_date | string |
ドキュメントが iManage Work システムにインポートされた日付と時刻 (ISO 8601形式) を示します。 この日付は 「file_create_date」 とは異なる場合があります。 |
|
データベース
|
data.database | string |
ドキュメントが保存されているライブラリを示します。 |
|
ドキュメントの既定のセキュリティ
|
data.default_security | string |
既定のセキュリティ アクセスレベルを示します。 可能な値は、「inherit」、「private」、「view」、「public」 です。 |
|
Document Number
|
data.document_number | integer |
ドキュメントのドキュメント番号を示します。 |
|
Document URL
|
data.document_url | string |
ドキュメントの共有可能なリンクを示します。 |
|
ドキュメント編集日
|
data.edit_date | string |
ドキュメントに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
プロファイルの編集日
|
data.edit_profile_date | string |
ドキュメント プロファイルに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
ドキュメントの拡張子
|
data.extension | string |
ドキュメントのファイル名拡張子 (アプリケーション拡張子とも呼ばれます) を示します。 |
|
ファイルの作成日
|
data.file_create_date | string |
ファイルが作成された日時 (ISO 8601 形式) を示します。 ファイルは、iManage Work システムの外部で作成された可能性があります。 この日付は 「create_date」 とは異なる場合があります。 |
|
ファイルの編集日
|
data.file_edit_date | string |
ファイルに対する最新の変更日時 (ISO 8601 形式) を示します。 ファイルは、iManage Work システムにアップロードされる前に変更された可能性があります。 |
|
送信者
|
data.from | string |
メールの送信者を示す。 メールにのみ適用されます。 |
|
完全なファイル名
|
data.full_file_name | string |
文書の完全なファイル名を示します。 ファイル名の拡張子を含めてください。 |
|
Has Attachment
|
data.has_attachment | boolean |
電子メールに添付ファイルがあるかどうかを示します。 メールにのみ適用されます。 |
|
ドキュメントの基本プロパティ
|
data.basic_properties | string |
基本的なドキュメント プロパティを含む埋め込み可能な 「」 要素を示します。 |
|
Document ID
|
data.id | string |
ドキュメントの ID を示します。 例: 'ACTIVE_US!453.1'。 |
|
Indexable である
|
data.indexable | boolean |
ドキュメントがシステムによって索引付けされているかどうかを示します。 |
|
チェックアウト済である
|
data.is_checked_out | boolean |
文書がチェックアウトされているかどうかを示します。 |
|
拒否された
|
data.is_declared | boolean |
ドキュメントがレコードとして宣言されているかどうかを示します。 レコードとして宣言されたドキュメントは、iManage Work システム 管理者を除き、編集または削除できません。 |
|
外部である
|
data.is_external | boolean |
ドキュメントが外部ユーザーと共有されているかどうかを示します。 |
|
通常どおり外部である
|
data.is_external_as_normal | boolean |
ドキュメントが通常どおり外部にあるかどうかを示します。 |
|
HIPAA である
|
data.is_hipaa | boolean |
文書が暗号化されているかどうかを示します。 |
|
使用中である
|
data.is_in_use | boolean |
文書が使用中であるかどうかを示します。 |
|
ドキュメント リンク
|
data.iwl | string |
ドキュメントの iManage Work Link (iWL) を示します。 iWL は、「read_write」 または 「full_access」 権限を持つユーザーが保護されたビュー モードでドキュメントを開くために使用されます。 |
|
最終使用ユーザー
|
data.last_user | string |
ドキュメントを直近で編集したユーザーの ID を示します。 例: 'JSMITH'。 |
|
最終使用ユーザーの説明
|
data.last_user_description | string |
ドキュメントを直近で編集したユーザーに関する追加情報を示す。 |
|
ドキュメント名
|
data.name | string |
ドキュメントの完全なファイル名を示します。 |
|
Operator
|
data.operator | string |
ドキュメントをチェックアウトしたユーザ、または現在プロファイルを編集しているユーザーの ID を示します。 例: 'JSMITH'。 |
|
演算子の説明
|
data.operator_description | string |
演算子に関する追加情報を示します。 |
|
受信日
|
data.received_date | string |
メールを受信した日時 (ISO 8601 形式) を示します。 メールにのみ適用されます。 |
|
保持日数
|
data.retain_days | integer |
ドキュメントがアーカイブの対象となるまでの日数を示します。 非アクティブなドキュメントにのみ適用されます。 |
|
送信日
|
data.sent_date | string |
メールを送信した日時 (ISO 8601 形式) を示します。 メールにのみ適用されます。 |
|
ドキュメントのサイズ
|
data.size | integer |
ドキュメントのサイズをバイト数で示します。 |
|
サブクラス
|
data.subclass | string |
ドキュメントのサブクラスを示します。 |
|
サブクラスの説明
|
data.subclass_description | string |
ドキュメントのサブクラスに関する追加情報を示します。 |
|
受信先
|
data.to | string |
メールの受信者を示します。 メールにのみ適用されます。 |
|
タイプ
|
data.type | string |
ドキュメントの種類を示します。 たとえば、Microsoft Word の場合、WORD になります。 現在の種類のリストについては、iManage Work のシステム管理者に問い合わせてください。 |
|
タイプの説明
|
data.type_description | string |
ドキュメントの種類についての追加情報を示します。 |
|
ドキュメントのバージョン
|
data.version | integer |
ドキュメントのバージョン番号を示します。 |
|
Workspace ID
|
data.workspace_id | string |
ドキュメント ワークスペースの ID を示します。 例: 'ACTIVE_US!427'。 |
|
Workspace Name
|
data.workspace_name | string |
ドキュメント ワークスペースの名前を示します。 |
|
Wstype
|
data.wstype | string |
オブジェクトの iManage Work タイプを示します。 可能な値は、「document」、「folder」、「workspace」、「email」、「document_shortcut」、「folder_shortcut」、「workspace_shortcut」、「user」 です。 |
|
Custom13
|
data.custom13 | string |
custom13 の値を示します。 |
|
Custom14
|
data.custom14 | string |
custom14 の値を示します。 |
|
Custom15
|
data.custom15 | string |
custom15 の値を示します。 |
|
Custom16
|
data.custom16 | string |
custom16 の値を示します。 |
|
Custom21
|
data.custom21 | string |
custom21 プロパティの値を ISO 8601 datetime フォーマットで示します。 |
|
Custom22
|
data.custom22 | string |
custom22 プロパティの値を ISO 8601 datetime フォーマットで示します。 |
ドキュメントをダウンロードする
ドキュメント ID に基づいて、特定のドキュメントのバージョンをダウンロードします。 latest が trueの場合、このドキュメントの最新版がダウンロードされます。 ダウンロードはストリームであるため、ローカルには保存されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_USE!453.1'。 |
|
最新バージョンの取得
|
latest | boolean |
最新版のドキュメントをダウンロードを指定します。 |
戻り値
ファイルの内容を示します。
- ファイル内容
- binary
ドキュメントを移動する
指定したフォルダーにドキュメントを移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親フォルダー ID
|
folderId | True | string |
親フォルダのフォルダー ID を指定する。 例: 'ACTIVE_US!987'。 |
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
宛先フォルダー ID
|
destination_folder_id | True | string |
ドキュメントの移動先の宛先フォルダー ID を指定します。 例: 'ACTIVE_US!987'。 |
|
宛先プロファイルの適用
|
update_profile | boolean |
ドキュメント プロファイルを宛先フォルダー プロファイルで更新するかどうかを指定します。 |
|
|
宛先セキュリティの適用
|
update_security | boolean |
ドキュメントのセキュリティを宛先フォルダーのセキュリティで更新するかどうかを指定します。 このパラメーターは、Update Profile が true に設定されている場合にのみ適用されます。 |
|
|
タイムラインのコメント
|
comments | string |
演算子の追加情報を指定します。 これらのコメントはドキュメントのタイムラインに表示されます。 |
ドキュメント参照の削除
指定されたフォルダーからドキュメント参照を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
フォルダー ID
|
folderId | True | string |
フォルダーの ID を指定します。 例: 'ACTIVE_US!773'。 |
戻り値
- 返答
- object
ドキュメント履歴エントリーの追加
エントリーをドキュメントの履歴にイベントとして追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
ドキュメントの ID を指定します。 例: 'ACTIVE_US!453.1'。 |
|
活動
|
activity_code | True | integer |
ドキュメントに対して実行されるアクティビティのタイプを指定します。 |
|
Comments
|
comments | string |
アクティビティに関する追加情報を指定します。 |
|
|
長さ
|
duration | integer |
ユーザーがドキュメントの作業に費やした秒数を指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | object |
フォルダーの検索
フォルダーの検索。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット フォルダーのライブラリ ID を指定します。 |
|
コンテナー ID
|
container_id | string |
フォルダーを返すワークスペース、またはフォルダーの ID を指定します。 例: 'ACTIVE_US!987'。 このパラメーターを指定すると、指定したワークスペース、またはフォルダーからのみフォルダーを返します。 |
|
|
フォルダーの説明
|
description | string |
フォルダーの説明プロパティで検出される値を指定します。 この検索では、大文字と小文字は区別されません。 部分一致に対応しています。 |
|
|
フォルダーの電子メール アドレス
|
string |
フォルダーの電子メール アドレスと一致する電子メール アドレスを指定します。 例: 'email1234@ajubalaw.com'。 |
||
|
フォルダー名
|
name | string |
フォルダーの名前プロパティで検出される値を指定します。 この検索では、大文字と小文字は区別されません。 部分一致に対応しています。 |
|
|
フォルダーの所有者
|
owner | string |
フォルダーに関連付けられた所有者と一致する文字列を指定します。 この検索では、大文字と小文字は区別されません。 部分一致に対応しています。 |
|
|
Workspace Name
|
workspace_name | string |
フォルダーが属する親ワークスペースの名前を指定します。 この検索では、大文字と小文字は区別されません。 部分一致に対応しています。 |
ユーザーの詳細を取得する
指定されたライブラリからユーザーに関する情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ユーザーのライブラリ ID を指定します。 |
|
User ID
|
userId | True | string |
詳細なプロファイル情報を取得するユーザーの ID を指定します。 例: 'JSMITH'。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | UserProfile |
ユーザーについての情報を表示します。 |
ライブラリの取得
ユーザがアクセスできるライブラリの一覧を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
ユーザーがアクセスできるライブラリのリストを示します。 |
|
ID
|
data.id | string |
ライブラリの名称を示します。 |
|
件名
|
data.display_name | string |
ライブラリの表示名を示します。 |
|
タイプ
|
data.type | string |
ライブラリの種類を示します。 考えられる値は 'worksite' または 'linksite' です。 |
|
非表示
|
data.is_hidden | boolean |
ライブラリが非表示であるかどうかを示します。 |
ワークスペースのテンプレートを取得する
ライブラリで利用可能なテンプレートのリストを取得します。 ワークスペース テンプレートは、構造が新しいワークスペースにコピーされる定義済みのワークスペースです。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ワークスペースのライブラリ ID を指定します。 |
|
Custom1
|
custom1 | string |
ワークスペースのテンプレートに関連付けられた custom1 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom2
|
custom2 | string |
ワークスペースのテンプレートに関連付けられた custom2 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom3
|
custom3 | string |
ワークスペースのテンプレートに関連付けられた custom3 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom4
|
custom4 | string |
ワークスペースのテンプレートに関連付けられた custom4 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom5
|
custom5 | string |
ワークスペースのテンプレートに関連付けられた custom5 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom6
|
custom6 | string |
ワークスペースのテンプレートに関連付けられた custom6 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom7
|
custom7 | string |
ワークスペースのテンプレートに関連付けられた custom7 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom8
|
custom8 | string |
ワークスペースのテンプレートに関連付けられた custom8 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom9
|
custom9 | string |
ワークスペースのテンプレートに関連付けられた custom9 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom10
|
custom10 | string |
ワークスペースのテンプレートに関連付けられた custom10 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom11
|
custom11 | string |
ワークスペースのテンプレートに関連付けられた custom11 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom12
|
custom12 | string |
ワークスペースのテンプレートに関連付けられた custom12 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
ワークスペース テンプレートに関連付けられた custom21 で検索する値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom22
|
custom22 | string |
ワークスペース テンプレートに関連付けられた custom22 で検索する値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom23
|
custom23 | string |
ワークスペース テンプレートに関連付けられた custom23 で検索する値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom24
|
custom24 | string |
ワークスペース テンプレートに関連付けられた custom24 で検索する値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom21 (下限)
|
custom21_from | string |
検索する custom21 (ISO 8601 datetime フォーマット) の下限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom21 (上限)
|
custom21_to | string |
検索する custom21 (ISO 8601 datetime フォーマット) の上限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom21 (相対)
|
custom21_relative | string |
現在の日付を基準にして、検索する期間を指定します。 このパラメーターの形式は、[開始]:[終了][時間単位 (d、m、または y)] です。 たとえば、-15:1d は、現在の日付の 15 日前から現在の日付の 1 日後まで (1 日先まで) の日付範囲を指定します。 |
|
|
Custom22 (下限)
|
custom22_from | string |
検索する custom22 (ISO 8601 datetime フォーマット) の下限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom22 (上限)
|
custom22_to | string |
検索する custom22 (ISO 8601 datetime フォーマット) の上限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom22 (相対)
|
custom22_relative | string |
現在の日付を基準にして、検索する期間を指定します。 このパラメーターの形式は、[開始]:[終了][時間単位 (d、m、または y)] です。 たとえば、-15:1d は、現在の日付の 15 日前から現在の日付の 1 日後まで (1 日先まで) の日付範囲を指定します。 |
|
|
Custom23 (下限)
|
custom23_from | string |
検索する custom23 (ISO 8601 datetime フォーマット) の下限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom23 (上限)
|
custom23_to | string |
検索する custom23 (ISO 8601 datetime フォーマット) の上限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom23 (相対)
|
custom23_relative | string |
現在の日付を基準にして、検索する期間を指定します。 このパラメーターの形式は、[開始]:[終了][時間単位 (d、m、または y)] です。 たとえば、-15:1d は、現在の日付の 15 日前から現在の日付の 1 日後まで (1 日先まで) の日付範囲を指定します。 |
|
|
Custom24 (下限)
|
custom24_from | string |
検索する custom24 (ISO 8601 datetime フォーマット) の下限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom24 (上限)
|
custom24_to | string |
検索する custom24 (ISO 8601 datetime フォーマット) の上限を指定します。 このプロパティは、iManage Work で予約されていないため、有効な値ではありません。 これは、会社の要件に合わせてカスタマイズすることを意図しています。 |
|
|
Custom24 (相対)
|
custom24_relative | string |
現在の日付を基準にして、検索する期間を指定します。 このパラメーターの形式は、[開始]:[終了][時間単位 (d、m、または y)] です。 たとえば、-15:1d は、現在の日付の 15 日前から現在の日付の 1 日後まで (1 日先まで) の日付範囲を指定します。 |
|
|
Custom25
|
custom25 | boolean |
検索する custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
検索する custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
検索する custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
検索する custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom30
|
custom30 | string |
custom30 と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
ワークスペースのプロファイル取得する
ワークスペースのプロファイルを取得し、オプションでワークスペースの許可された操作のリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace ID
|
workspaceId | True | string |
ワークスペースの ID を指定します。 例: 'ACTIVE_US!427'。 |
ワークスペースの作成
選択したテンプレートに基づき、新しいワークスペースを作成します。 ワークスペース テンプレートは、構造が新しいワークスペースにコピーされる定義済みのワークスペースです。 新しいワーク スペースを作成すると、ワークスペース テンプレートに対する制限が自動的に適用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ワークスペースのライブラリ ID を指定します。 |
|
Template
|
templateId | True | string |
ワークスペースとその子の作成に使用するワークスペース テンプレートを指定します。 |
|
件名
|
name | True | string |
ワークスペースの名前を指定します。 |
|
子の作成
|
createChildren | True | string |
すべてのフォルダー (オプションと必須) を作成するか、必要なフォルダーのみを作成するかを指定します。 |
|
ワークスペースの所有者
|
owner | string |
ワークスペースの所有者を指定します。 ワークスペースの所有者を設定するには、iManage Work のシステム管理者である必要があります。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のアクセスレベルを指定します。 指定しない場合は、選択したテンプレートの既定のアクセス レベルが使用されます。 |
|
|
説明設定
|
description | string |
ワークスペースの追加情報を指定します。 |
|
|
Custom1
|
custom1 | string |
新規に作成するワークスペースに関連付ける custom1 の値を指定します。 この値は、選択されたテンプレートワークスペースの custom1 値が存在する場合、それを上書きします。 子フォルダに custom1 値が設定されている場合、それらの子フォルダの custom1 値は上書きされません。 |
|
|
Custom2
|
custom2 | string |
新規に作成するワークスペースに関連付ける custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 この値は、選択されたテンプレートワークスペースの custom2 値が存在する場合、それを上書きします。 子フォルダに custom2 値が設定されている場合、それらの子フォルダの custom2 値は上書きされません。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
ISO 8601 の日時形式で custom21 の値を指定します。 |
|
|
Custom22
|
custom22 | string |
ISO 8601 の日時形式で custom22 の値を指定します。 |
|
|
Custom23
|
custom23 | string |
ISO 8601 の日時形式で custom23 の値を指定します。 |
|
|
Custom24
|
custom24 | string |
ISO 8601 の日時形式で custom24 の値を指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
|
|
通常どおり外部である
|
is_external_as_normal | boolean |
ワークスペースをパブリック ワークスペースとして扱えるようにすることを指定します。 'true' に設定され、かつ 'default_security' が 'private' でない場合、 'is_external' を 'true' に設定します。 |
|
|
プロジェクト Custom1
|
project_custom1 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
プロジェクト Custom2
|
project_custom2 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
プロジェクト Custom3
|
project_custom3 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
ワークスペース サブクラス
|
subclass | string |
ワークスペースが含むドキュメントのサブクラスに基づいて、ワークスペースのサブクラスを指定します。 |
ワークスペースの更新
指定されたワークスペースの情報を更新します。 文字列フィールドの既存の値を削除するには、フィールドの値を一重引用符または二重引用符で囲んだ空の文字列に設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Workspace ID
|
id | True | string |
更新するワークスペースの ID を指定します。 例: 'ACTIVE_US!427'。 |
|
件名
|
name | string |
ワークスペースの名前を指定します。 |
|
|
ワークスペースの所有者
|
owner | string |
ワークスペースの所有者を指定します。 |
|
|
Custom1
|
custom1 | string |
custom1 の値を指定します。 |
|
|
Custom2
|
custom2 | string |
custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
custom21 の値を ISO 8601 の datetime 形式で指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 の値をISO 8601 の datetime 形式で指定します。 |
|
|
Custom23
|
custom23 | string |
custom23 の値を ISO 8601 の日時形式で指定します。 |
|
|
Custom24
|
custom24 | string |
custom24 の値を ISO 8601 の日時形式で指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 |
|
|
説明設定
|
description | string |
ワークスペースの追加情報を指定します。 |
|
|
通常どおり外部である
|
is_external_as_normal | boolean |
ワークスペースをパブリック ワークスペースとして扱うかどうかを指定します。 true' に設定され、かつ 'default_security' が 'private' でない場合、 'is_external' は 'true' に設定されます。 |
|
|
プロジェクト Custom1
|
project_custom1 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
プロジェクト Custom2
|
project_custom2 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
プロジェクト Custom3
|
project_custom3 | string |
ワークスペースの追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられたメタデータ カスタム フィールドとは異なります。 これは、フォーマットする必要のない説明テキストであり、検証されません。 |
|
|
ワークスペース サブクラス
|
subclass | string |
ワークスペースが含むドキュメントのサブクラスに基づいて、ワークスペースのサブクラスを指定します。 |
ワークスペース検索
ワークスペースの検索。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ワークスペースのライブラリ ID を指定します。 |
|
肩書き
|
name | string |
ワークスペースの名前プロパティで検索する文字列を指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
Owner
|
owner | string |
ワークスペースに関連付けられた所有者と一致する文字列を指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
Keyword
|
anywhere | string |
ワークスペース プロファイルの任意の場所で検索するテキストを指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
説明設定
|
description | string |
ワークスペースの説明プロパティで検索するテキストを指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
サブクラス
|
subclass | string |
ワークスペースに関連付けられたサブクラスの値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
Custom1
|
custom1 | string |
ワークスペースに関連付けられた custom1 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom2
|
custom2 | string |
ワークスペースに関連付けられた custom2 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom3
|
custom3 | string |
ワークスペースに関連付けられた custom3 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom4
|
custom4 | string |
ワークスペースに関連付けられた custom4 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom5
|
custom5 | string |
ワークスペースに関連付けられた custom5 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom6
|
custom6 | string |
ワークスペースに関連付けられた custom6 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom7
|
custom7 | string |
ワークスペースに関連付けられた custom7 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom8
|
custom8 | string |
ワークスペースに関連付けられた custom8 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom9
|
custom9 | string |
ワークスペースに関連付けられた custom9 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom10
|
custom10 | string |
ワークスペースに関連付けられた custom10 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom11
|
custom11 | string |
ワークスペースに関連付けられた custom11 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom12
|
custom12 | string |
ワークスペースに関連付けられた custom12 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom13
|
custom13 | string |
ワークスペースに関連付けられた custom13 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
Custom14
|
custom14 | string |
ワークスペースに関連付けられた custom14 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
Custom15
|
custom15 | string |
ワークスペースに関連付けられた custom15 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
Custom16
|
custom16 | string |
ワークスペースに関連付けられた custom16 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致に対応しています。 |
|
|
Custom17
|
custom17 | string |
ワークスペースに関連付けられた custom17 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom18
|
custom18 | string |
ワークスペースに関連付けられた custom18 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom19
|
custom19 | string |
ワークスペースに関連付けられた custom19 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom20
|
custom20 | string |
ワークスペースに関連付けられた custom20 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom21 (下限)
|
custom21_from | string |
ワークスペースに関連付けられた custom21 プロパティで検索する下限値 (ISO 8601 datetime 形式) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom21 (上限)
|
custom21_to | string |
ワークスペースに関連付けられた custom21 プロパティで検索する上限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom22 (下限)
|
custom22_from | string |
ワークスペースに関連付けられた custom22 プロパティで検索する下限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom22 (上限)
|
custom22_to | string |
ワークスペースに関連付けられた custom22 プロパティで検索する上限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom23 (下限)
|
custom23_from | string |
ワークスペースに関連付けられた custom23 プロパティで検索する下限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom23 (上限)
|
custom23_to | string |
ワークスペースに関連付けられた custom23 プロパティで検索する上限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom24 (下限)
|
custom24_from | string |
ワークスペースに関連付けられた custom24 プロパティで検索する下限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom24 (上限)
|
custom24_to | string |
ワークスペースに関連付けられた custom24 プロパティで検索する上限値 (ISO 8601 datetimeフォーマット) を指定します。 この検索では、大文字と小文字は区別されません。 ワークスペースの場合、このプロパティの使用は、iManage Work インストール用にカスタマイズされます。 |
|
|
Custom25
|
custom25 | boolean |
ワークスペースに関連付けられた custom25 の値と一致する値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
ワークスペースに関連付けられた custom26 の値と一致する値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
ワークスペースに関連付けられた custom27 の値と一致する値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
ワークスペースに関連付けられた custom28 の値と一致する値を指定します。 |
|
|
Custom29
|
custom29 | string |
ワークスペースに関連付けられた custom29 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 |
|
|
Custom30
|
custom30 | string |
ワークスペースに関連付けられた custom30 の値と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致には対応していません。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
ワークフロー状態の更新
ワークフローの実行状態を更新します。 このアクションは、iManage が提供するトリガーで開始するように作成されたワークフローでのみ使用できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ワークフローを定義するライブラリの ID を指定します。 |
|
状態
|
state | True | string |
ワークフロー実行の現在の状態を指定します。 |
|
ステータス
|
status | string |
ワークフロー実行の現在の状態を指定します。 最大 128 文字までです。 |
|
|
状態メッセージ
|
statusMessage | string |
ワークフロー実行の現在の状態を表すカスタマイズされたメッセージを指定します。 最大 256 文字までです。 |
戻り値
- 返答
- object
受託者を取得する
ドキュメント、フォルダー、またはワークスペースに対する特定の権限を持つ受託者のリストを取得します。 受託者は、ユーザーまたはグループにすることができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
Object ID
|
objectId | True | string |
ドキュメント、フォルダ、ワークスペースの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
ドキュメント、フォルダー、またはワークスペースに対する特定の権限を持つ受託者のリストを示します。 受託者は、ユーザーまたはグループにすることができます。 |
|
正式な名前
|
data.full_name | string |
受託者の氏名を示します。 |
|
ID
|
data.id | string |
受託者の ID を示します。 これは、グループIDまたはユーザーIDです。 例: 'JSMITH' または 'MARKETING'。 |
|
SSID
|
data.ssid | string |
受託者の一意のシステム生成 ID を示します。 |
|
タイプ
|
data.type | string |
返されるエンティティの種類を示します。 指定できる値は、 'user' または 'group' です。 |
既定のセキュリティを更新する
ドキュメント、フォルダー、ワークスペースの既定のセキュリティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
Object ID
|
objectId | True | string |
ドキュメント、フォルダ、ワークスペースの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
|
既定のセキュリティ
|
default_security | True | string |
オブジェクトの既定のセキュリティを指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
既定のセキュリティ
|
data.default_security | string |
オブジェクトの既定のセキュリティを示す。 指定可能な値は 「inherit」, 「public」, 「view」, 「private」 のいずれかです。 |
|
アクセス許可
|
data.acl | AccessPermissions |
1 人以上のユーザーおよび/またはグループのアクセス許可の集合を示します。 |
現在のドキュメント バージョンを更新するか、新しいドキュメント バージョンを作成する
ドキュメントの指定されたバージョンを更新するか、新しいバージョンを作成します。 このアクションは、ドキュメントのプロファイルとコンテンツを更新できます。 「現在のバージョンを更新」オプションが指定された場合、ドキュメントは新しいものに置き換えられ、以前のドキュメントのプロファイルは維持されます。 「新しいバージョンの作成」を指定すると、フォルダーのプロファイルを継承した新しいバージョンのドキュメントが作成されます。 操作が正常に実行されると、ドキュメント プロファイルが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
更新または新バージョンの作成
|
updateOrCreate | True | string |
ドキュメントの現在のバージョンを更新するか、新しいバージョンを作成するかを指定します。 |
|
既存のドキュメント ID
|
documentId | True | string |
既存のドキュメント ID を指定します。 例: 'ACTIVE_US!556.1'。 |
|
ロックを保持する
|
keep_locked | boolean |
アップロード後にドキュメントのロックを保持するかどうかを指定します。 |
|
|
Comment
|
comment | string |
更新の追加情報を指定します。 |
|
|
ドキュメント名
|
name | string |
ドキュメントの名前を指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの iManage Work ID を指定します。 |
|
|
Operator
|
operator | string |
ドキュメントをチェックアウトしているユーザー、またはドキュメントのプロファイルを編集中のユーザーの ID を指定します。 例: 'JSMITH'。 |
|
|
クラス
|
class | string |
ドキュメントを識別、区別するためのクラスを指定します。 ドキュメント クラスは、ジャンル、部門、地域などで分類されています。 |
|
|
サブクラス
|
subclass | string |
ドキュメントを識別、区別するためのサブクラスを指定します。 ドキュメント サブクラスは、ジャンル、部門、地域などで分類されています。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを指定します。 可能な値は、「inherit」、「private」、「view」、「public」 です。 |
|
|
HIPAA である
|
is_hipaa | boolean |
ドキュメントを暗号化するかどうかを指定します。 |
|
|
保持日数
|
retain_days | integer |
ドキュメントをアーカイブ用にマークする前に、非アクティブにする必要がある日数を指定します。 |
|
|
ファイル コンテンツ
|
file | True | file |
ファイルのコンテンツを指定します。 |
|
ファイルの作成日
|
file_create_date | date-time |
ファイルが作成された日時 (ISO 8601 形式)を指定します。 ファイルは、iManage Work システムの外部で作成された可能性があります。 この日付は 「create_date」 とは異なる場合があります。 create_date は、iManage Work システムでファイルが作成またはインポートされた日付です。 |
|
|
ファイルの編集日
|
file_edit_date | date-time |
ファイルに対する最新の変更日時 (ISO 8601 形式) を指定します。 ファイルは、iManage Work システムにアップロードされる前に変更された可能性があります。 |
|
|
Custom1
|
custom1 | string |
custom1 の値を指定します。 |
|
|
Custom2
|
custom2 | string |
custom2 の値を指定します。 custom2 に値を指定するには、同じリクエストで custom1 にも値を指定する必要がありますが、これは両者の親子関係によるものです。 |
|
|
Custom3
|
custom3 | string |
custom3 の値を指定します。 |
|
|
Custom4
|
custom4 | string |
custom4 の値を指定します。 |
|
|
Custom5
|
custom5 | string |
custom5 の値を指定します。 |
|
|
Custom6
|
custom6 | string |
custom6 の値を指定します。 |
|
|
Custom7
|
custom7 | string |
custom7 の値を指定します。 |
|
|
Custom8
|
custom8 | string |
custom8 の値を指定します。 |
|
|
Custom9
|
custom9 | string |
custom9 の値を指定します。 |
|
|
Custom10
|
custom10 | string |
custom10 の値を指定します。 |
|
|
Custom11
|
custom11 | string |
custom11 の値を指定します。 |
|
|
Custom12
|
custom12 | string |
custom12 の値を指定します。 |
|
|
Custom13
|
custom13 | string |
custom13 の値を指定します。 |
|
|
Custom14
|
custom14 | string |
custom14 の値を指定します。 |
|
|
Custom15
|
custom15 | string |
custom15 の値を指定します。 |
|
|
Custom16
|
custom16 | string |
custom16 の値を指定します。 |
|
|
Custom17
|
custom17 | double |
custom17 の値を指定します。 |
|
|
Custom18
|
custom18 | double |
custom18 の値を指定します。 |
|
|
Custom19
|
custom19 | double |
custom19 の値を指定します。 |
|
|
Custom20
|
custom20 | double |
custom20 の値を指定します。 |
|
|
Custom21
|
custom21 | string |
custom21 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom23
|
custom23 | string |
custom23 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom24
|
custom24 | string |
custom24 の値を ISO 8601 datetime フォーマットで指定します。 |
|
|
Custom25
|
custom25 | boolean |
custom25 の値を指定します。 |
|
|
Custom26
|
custom26 | boolean |
custom26 の値を指定します。 |
|
|
Custom27
|
custom27 | boolean |
custom27 の値を指定します。 |
|
|
Custom28
|
custom28 | boolean |
custom28 の値を指定します。 |
|
|
Custom29
|
custom29 | string |
custom29 の値を指定します。 |
|
|
Custom30
|
custom30 | string |
custom30 の値を指定します。 custom30 に値を指定するには、同じリクエストで custom29 にも値を指定する必要がありますが、これは両者の親子関係に起因します。 |
編集 name-value ペア
ドキュメント、フォルダ、またはワークスペースの name-value ペアのプロパティを作成、更新、または削除します。 名前と値のペアを削除するには、キーの値を一重引用符または二重引用符 ('') で囲んだ空の文字列に設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 可能な値は「document」、「folder」、「workspace」です。 |
|
Object ID
|
objectId | True | string |
ドキュメント、フォルダ、ワークスペースの ID を指定します。 ドキュメント ID の例は「ACTIVE_US!453.1」です。 フォルダやワークスペース ID の例としては、「ACTIVE_US!123」などがあります。 |
|
名の値のペア
|
nameValuePairs | object |
このドキュメントの自由形式の名前と値のペアを指定します。 |
トリガー
| 選択したドキュメントの場合 |
このトリガーにより、iManage Work ライブラリで選択されたドキュメントのワークフローを開始することができます。 iManage Work アプリケーションでユーザーに表示される 表示名を指定します。 「完了を待機する」が「はい」に設定されている場合、ワークフローで「ワークフロー状態の更新」アクションを使用する必要があります。これを使用しない場合、アプリケーションはユーザーに完了状態を示さずに最終的にタイムアウトになります。 |
選択したドキュメントの場合
このトリガーにより、iManage Work ライブラリで選択されたドキュメントのワークフローを開始することができます。 iManage Work アプリケーションでユーザーに表示される 表示名を指定します。 「完了を待機する」が「はい」に設定されている場合、ワークフローで「ワークフロー状態の更新」アクションを使用する必要があります。これを使用しない場合、アプリケーションはユーザーに完了状態を示さずに最終的にタイムアウトになります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフローの表示名
|
workflowName | True | string |
iManage Work ユーザーに表示されるワークフローの 表示名 を指定します。 |
|
Description
|
description | True | string |
ワークフローの説明を指定します。 |
|
ライブラリ ID
|
libraryId | True | string |
ワークフローが利用可能なライブラリの ID を指定します。 |
|
Form ID
|
formId | True | string |
ワークフローで使用される入力を収集するためにユーザーに表示されるフォームの ID を指定します。 |
|
リターン フォルダの ID
|
inferFolderId | True | boolean |
ワークフローでドキュメントのフォルダー ID が必要かどうかを指定します。 |
|
ユーザーが使用可能
|
users | string |
ワークフローを利用できる 1 つ以上のユーザー ID をセミコロンで区切って指定します。 |
|
|
グループに利用可能
|
groups | string |
ワークフローを利用できる 1 つ以上のグループ ID をセミコロンで区切って指定します。 |
|
|
ワークスペースで使用可能
|
workspaces | string |
ワークフローを利用できる 1 つ以上のワークスペース ID をセミコロンで区切って指定します。 |
|
|
ドキュメント クラス
|
classes | string |
ワークフローを利用できる 1 つ以上のドキュメント クラスの ID をセミコロンで区切って指定します。 |
|
|
完了まで待機する
|
waitForCompletion | boolean |
ワークフローの実行が完了するまでアプリケーションが待機するかどうかを指定します。 「はい」に設定した場合は、「ワークフロー状態の更新」アクションを使用する必要があります。 |
戻り値
定義
MinimalDocumentProfileInArray
ドキュメントの各バージョンのプロファイルを示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を示します。 例: 'JSMITH'。 |
|
作成者の説明
|
author_description | string |
ドキュメントの作成者についての追加情報を示します。 |
|
ドキュメントの基本プロパティ
|
basic_properties | string |
基本的なドキュメント プロパティを含む埋め込み可能な 「」 要素を示します。 |
|
ドキュメントのクラス
|
class | string |
ドキュメントのクラスを示します。 |
|
Comment
|
comment | string |
ドキュメントに関する追加の情報を示します。 |
|
Content Type
|
content_type | string |
ドキュメントのコンテンツ タイプを示します。 |
|
ドキュメント作成日
|
create_date | string |
ドキュメントが iManage Work システムにインポートされた日付と時刻 (ISO 8601形式) を示します。 この日付は 「file_create_date」 とは異なる場合があります。 |
|
Custom1
|
custom1 | string |
custom 1 の値を示します。 |
|
Custom1 の説明
|
custom1_description | string |
Custom1 のプロパティに関する追加の情報を示します。 |
|
Custom2
|
custom2 | string |
custom2 の値を示します。 |
|
custom2 の説明
|
custom2_description | string |
custom2 のプロパティに関する追加の情報を示します。 |
|
Custom3
|
custom3 | string |
custom3 の値を示します。 |
|
custom3 の説明
|
custom3_description | string |
custom3 のプロパティに関する追加の情報を示します。 |
|
Custom4
|
custom4 | string |
custom4 の値を示します。 |
|
custom4 の説明
|
custom4_description | string |
custom4 のプロパティに関する追加の情報を示します。 |
|
Custom5
|
custom5 | string |
custom5 の値を示します。 |
|
custom5 の説明
|
custom5_description | string |
custom5 のプロパティに関する追加の情報を示します。 |
|
Custom6
|
custom6 | string |
custom6 の値を示します。 |
|
Custom6 の説明
|
custom6_description | string |
Custom6 のプロパティに関する追加の情報を示します。 |
|
Custom7
|
custom7 | string |
custom7 の値を示します。 |
|
custom7 の説明
|
custom7_description | string |
custom7 のプロパティに関する追加の情報を示します。 |
|
Custom8
|
custom8 | string |
custom8 の値を示します。 |
|
custom8 の説明
|
custom8_description | string |
custom8 のプロパティに関する追加の情報を示します。 |
|
Custom9
|
custom9 | string |
custom9 の値を示します。 |
|
custom9 の説明
|
custom9_description | string |
custom9 のプロパティに関する追加の情報を示します。 |
|
Custom10
|
custom10 | string |
custom10 の値を示します。 |
|
custom10 の説明
|
custom10_description | string |
custom10 のプロパティに関する追加の情報を示します。 |
|
Custom11
|
custom11 | string |
custom11 の値を示します。 |
|
Custom11 の説明
|
custom11_description | string |
Custom11 のプロパティに関する追加の情報を示します。 |
|
Custom12
|
custom12 | string |
custom12 の値を示します。 |
|
custom12 の説明
|
custom12_description | string |
custom12 のプロパティに関する追加の情報を示します。 |
|
Custom13
|
custom13 | string |
custom13 の値を示します。 |
|
Custom14
|
custom14 | string |
custom14 の値を示します。 |
|
Custom15
|
custom15 | string |
custom15 の値を示します。 |
|
Custom16
|
custom16 | string |
custom16 の値を示します。 |
|
Custom17
|
custom17 | double |
custom17 の値を示します。 |
|
Custom18
|
custom18 | double |
custom18 の値を示します。 |
|
Custom19
|
custom19 | double |
custom19 の値を示します。 |
|
Custom20
|
custom20 | double |
custom20 の値を示します。 |
|
Custom21
|
custom21 | string |
custom21 プロパティの値を ISO 8601 datetime フォーマットで示します。 |
|
Custom22
|
custom22 | string |
custom22 プロパティの値を ISO 8601 datetime フォーマットで示します。 |
|
Custom23
|
custom23 | string |
Custom23 プロパティの値を ISO 8601 datetime 形式で示します。 |
|
Custom24
|
custom24 | string |
custom24 プロパティの値を ISO 8601 datetime 形式で示します。 |
|
Custom25
|
custom25 | boolean |
custom25 の値を示します。 |
|
Custom26
|
custom26 | boolean |
custom26 の値を示します。 |
|
Custom27
|
custom27 | boolean |
custom27 の値を示します。 |
|
Custom28
|
custom28 | boolean |
custom28 の値を示します。 |
|
Custom29
|
custom29 | string |
custom29 の値を示します。 |
|
Custom29 の説明
|
custom29_description | string |
Custom29 のプロパティに関する追加の情報を示します。 |
|
Custom30
|
custom30 | string |
custom30 の値を示します。 |
|
custom30 の説明
|
custom30_description | string |
custom30 のプロパティに関する追加の情報を示します。 |
|
データベース
|
database | string |
ドキュメントが保存されているライブラリを示します。 |
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセスレベルを示します。 可能な値は、「inherit」、「private」、「view」、「public」 です。 |
|
Document Number
|
document_number | integer |
ドキュメントのドキュメント番号を示します。 |
|
Document URL
|
document_url | string |
ドキュメントの共有可能なリンクを示します。 |
|
ドキュメント編集日
|
edit_date | string |
ドキュメントに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
プロファイルの編集日
|
edit_profile_date | string |
ドキュメント プロファイルに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
ドキュメントの拡張子
|
extension | string |
ドキュメントのファイル名拡張子 (アプリケーション拡張子とも呼ばれます) を示します。 |
|
完全なファイル名
|
full_file_name | string |
文書の完全なファイル名を示します。 ファイル名の拡張子を含めてください。 |
|
Document ID
|
id | string |
ドキュメントの ID を示します。 例: 'ACTIVE_US!453.1'。 |
|
Indexable である
|
indexable | boolean |
ドキュメントがシステムによって索引付けされているかどうかを示します。 |
|
チェックアウト済である
|
is_checked_out | boolean |
文書がチェックアウトされているかどうかを示します。 |
|
拒否された
|
is_declared | boolean |
ドキュメントがレコードとして宣言されているかどうかを示します。 レコードとして宣言されたドキュメントは、iManage Work システム 管理者を除き、編集または削除できません。 |
|
外部である
|
is_external | boolean |
ドキュメントが外部ユーザーと共有されているかどうかを示します。 |
|
HIPAA である
|
is_hipaa | boolean |
文書が暗号化されているかどうかを示します。 |
|
使用中である
|
is_in_use | boolean |
文書が使用中であるかどうかを示します。 |
|
ドキュメント リンク
|
iwl | string |
ドキュメントの iManage Work Link (iWL) を示します。 iWL は、「read_write」 または 「full_access」 権限を持つユーザーが保護されたビュー モードでドキュメントを開くために使用されます。 |
|
最終使用ユーザー
|
last_user | string |
ドキュメントを直近で編集したユーザーの ID を示します。 例: 'JSMITH'。 |
|
最終使用ユーザーの説明
|
last_user_description | string |
ドキュメントを直近で編集したユーザーに関する追加情報を示す。 |
|
ドキュメント名
|
name | string |
ドキュメントの完全なファイル名を示します。 |
|
Operator
|
operator | string |
ドキュメントをチェックアウトしたユーザ、または現在プロファイルを編集しているユーザーの ID を示します。 例: 'JSMITH'。 |
|
演算子の説明
|
operator_description | string |
演算子に関する追加情報を示します。 |
|
次と関連している
|
is_related | boolean |
ドキュメントが別のドキュメントに関連しているかどうかを示します。 |
|
ドキュメントのサイズ
|
size | integer |
ドキュメントのサイズをバイト数で示します。 |
|
タイプ
|
type | string |
ドキュメントの種類を示します。 たとえば、Microsoft Word の場合、WORD になります。 現在の種類のリストについては、iManage Work のシステム管理者に問い合わせてください。 |
|
ドキュメントのバージョン
|
version | integer |
ドキュメントのバージョン番号を示します。 |
|
Wstype
|
wstype | string |
オブジェクトの iManage Work タイプを示します。 可能な値は、「document」、「folder」、「workspace」、「email」、「document_shortcut」、「folder_shortcut」、「workspace_shortcut」、「user」 です。 |
UserProfile
ユーザーについての情報を表示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ログオンを許可
|
allow_logon | boolean |
ユーザーがログオンを許可されているかどうかを示します。 |
|
Custom1
|
custom1 | string |
ユーザーに関する追加情報を示します。 |
|
Custom2
|
custom2 | string |
ユーザーに関する追加情報を示します。 |
|
Custom3
|
custom3 | string |
ユーザーに関する追加情報を示します。 |
|
ディレクトリ ID
|
directory_id | string |
ユーザー プロファイルの同期に使用される外部ディレクトリ (ADFSなど) からの ID を示します。 |
|
識別名
|
distinguished_name | string |
エントリーを LDAP ツリーのルートまで遡る名前の完全修飾パスを表すオブジェクトの名称を示します。 |
|
日付の編集
|
edit_date | string |
ユーザー プロファイルに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
メール
|
string |
ユーザーの電子メールを示します。 |
|
|
Exchange 自動検出 URL
|
exch_autodiscover | string |
ユーザーの Exchange server の詳細を示します。 |
|
内線番号
|
extension | string |
ユーザーの電話番号の内線番号を示します。 |
|
失敗したログオン試行
|
failed_logins | integer |
ユーザーの現在のサインイン失敗回数を示す。 |
|
Fax
|
fax | string |
利用者の FAX 番号を示します。 |
|
パスワード変更を強制する
|
force_password_change | boolean |
次回のサインイン時にパスワードの変更が必要であることを示します。 'user_nos' の値が '2' で示される仮想ユーザーにのみ適用されます。 |
|
正式な名前
|
full_name | string |
ユーザーの氏名を示します。 |
|
一般
|
general | string |
ユーザーに関する一般情報を示します。 |
|
User ID
|
id | string |
ユーザーの ID を示します。 例: 'JSMITH'。 |
|
外部ユーザーである
|
is_external | boolean |
外部ユーザーを示します。 外部ユーザーは、アクセス権が制限されているため、一時的なチームメンバー、コンサルタント、または組織の外部の人に使用されます。 |
|
最終同期時刻
|
last_sync_ts | string |
LDAP や Microsoft Active Directory (ADFS) などの外部ディレクトリとユーザー プロファイルの最終同期時刻 (ISO 8601 datetime形式) を示します。 |
|
場所
|
location | string |
ユーザーの地理的な位置を示します。 |
|
パスワードの有効期限なし
|
password_never_expire | boolean |
ユーザーのパスワードが無期限かどうかを示します。 |
|
Phone Number
|
phone | string |
ユーザーの電話番号を示します。 |
|
優先するライブラリ
|
preferred_library | string |
優先されりライブラリを示します。 優先されるライブラリは、ユーザーの既定のライブラリです。 各ユーザーは、優先ライブラリを 1 つ持っている必要があります。 |
|
パスワード変更時刻
|
pwd_changed_ts | string |
ユーザーのパスワードが最後に変更された時刻 (ISO 8601日時形式) を示します。 仮想ユーザー (User NOS が 2) のみに適用されます。 |
|
ユーザー ドメイン
|
user_domain | string |
ユーザーのディレクトリ サービスの完全修飾ドメイン名を示します。 |
|
拡張ユーザー ID
|
user_id_ex | string |
Microsoft Active Directory (ADFS) などの外部ディレクトリから受信したユーザー ID の元の値を示します。 |
|
User NOS
|
user_nos | integer |
ユーザーの同期元のオペレーティング システムの種類を示します。 可能な値は、'2' (仮想ユーザー) と '6' (エンタープライズ ユーザー) です。 詳細については、iManage Work のシステム管理者に問い合わせてください。 |
|
ユーザー番号
|
user_num | integer |
ユーザーの数値システムの ID を示します。 |
UserProfileInArray
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ログオンを許可
|
allow_logon | boolean |
ユーザーがログオンを許可されているかどうかを示します。 |
|
Custom1
|
custom1 | string |
ユーザーに関する追加情報を示します。 |
|
Custom2
|
custom2 | string |
ユーザーに関する追加情報を示します。 |
|
Custom3
|
custom3 | string |
ユーザーに関する追加情報を示します。 |
|
ディレクトリ ID
|
directory_id | string |
ユーザー プロファイルの同期に使用される外部ディレクトリ (ADFSなど) からの ID を示します。 |
|
識別名
|
distinguished_name | string |
エントリーを LDAP ツリーのルートまで遡る名前の完全修飾パスを表すオブジェクトの名称を示します。 |
|
日付の編集
|
edit_date | string |
ユーザー プロファイルに対する最新の変更日時 (ISO 8601 形式) を示します。 |
|
メール
|
string |
ユーザーの電子メールを示します。 |
|
|
Exchange 自動検出 URL
|
exch_autodiscover | string |
ユーザーの Exchange server の詳細を示します。 |
|
内線番号
|
extension | string |
ユーザーの電話番号の内線番号を示します。 |
|
失敗したログオン試行
|
failed_logins | integer |
ユーザーの現在のサインイン失敗回数を示す。 |
|
Fax
|
fax | string |
利用者の FAX 番号を示します。 |
|
パスワード変更を強制する
|
force_password_change | boolean |
次回のサインイン時にパスワードの変更が必要であることを示します。 'user_nos' の値が '2' で示される仮想ユーザーにのみ適用されます。 |
|
正式な名前
|
full_name | string |
ユーザーの氏名を示します。 |
|
一般
|
general | string |
ユーザーに関する一般情報を示します。 |
|
ID
|
id | string |
ユーザーの ID を示します。 例: 'JSMITH'。 |
|
外部ユーザーである
|
is_external | boolean |
外部ユーザーを示します。 外部ユーザーは、アクセス権が制限されているため、一時的なチームメンバー、コンサルタント、または組織の外部の人に使用されます。 |
|
最終同期時刻
|
last_sync_ts | string |
LDAP や Microsoft Active Directory (ADFS) などの外部ディレクトリとユーザー プロファイルの最終同期時刻 (ISO 8601 datetime形式) を示します。 |
|
場所
|
location | string |
ユーザーの地理的な位置を示します。 |
|
パスワードの有効期限なし
|
password_never_expire | boolean |
ユーザーのパスワードが無期限かどうかを示します。 |
|
Phone Number
|
phone | string |
ユーザーの電話番号を示します。 |
|
優先するライブラリ
|
preferred_library | string |
優先されりライブラリを示します。 優先されるライブラリは、ユーザーの既定のライブラリです。 各ユーザーは、優先ライブラリを 1 つ持っている必要があります。 |
|
パスワード変更時刻
|
pwd_changed_ts | string |
ユーザーのパスワードが最後に変更された時刻 (ISO 8601日時形式) を示します。 仮想ユーザー (User NOS が 2) のみに適用されます。 |
|
Domain
|
user_domain | string |
ユーザーのディレクトリ サービスの完全修飾ドメイン名を示します。 |
|
拡張ユーザー ID
|
user_id_ex | string |
Microsoft Active Directory (ADFS) などの外部ディレクトリから受信したユーザー ID の元の値を示します。 |
|
NOS
|
user_nos | integer |
ユーザーの同期元のオペレーティング システムの種類を示します。 可能な値は、'2' (仮想ユーザー) と '6' (エンタープライズ ユーザー) です。 詳細については、iManage Work のシステム管理者に問い合わせてください。 |
|
回数
|
user_num | integer |
ユーザーの数値システムの ID を示します。 |
TaxonomyNodeValue
各タクソノミー ノードの値を示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SSID
|
created_by.ssid | string |
上位に一致するノード値を作成したユーザーの一意のシステム生成 ID を示します。 |
|
作成日
|
create_date | date-time |
ノード値が作成された日時 (ISO 8601 形式) を示します。 |
|
Description
|
description | string |
ノード値の説明を示します。 |
|
SSID
|
edited_by.ssid | string |
最後に編集されたノード値を作成したユーザーの一意のシステム生成 ID を示します。 |
|
日付の編集
|
edit_date | date-time |
ノード値が最後に編集された日時 (ISO 8601 形式) を示します。 |
|
Is Enabled
|
enabled | boolean |
ノード値が有効かどうかを示します。 |
|
ID
|
id | string |
ノード値の表示 ID を示します。 |
|
SSID
|
parent.ssid | string |
即時親ノードの一意のシステム生成 ID を示します。 |
|
SSID
|
ssid | string |
ノード値の一意のシステム生成 ID を示します。 |
|
Path
|
path | array of object |
ノード値へのフルパスを示します。 パスは、分類内の最上位ノードから始まり、一致するノードの直接の親までのすべてのノードを含む順序付きリストです。 |
|
各 ID
|
path.id | string |
パスのノード値の表示 ID を示します。 |
|
各 SSID
|
path.ssid | string |
パスのノード値の一意のシステム生成 ID を示します。 |
UpdatePermissionsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
既定のセキュリティ
|
data.default_security | string |
オブジェクトの既定のセキュリティを示す。 指定可能な値は 「inherit」, 「public」, 「view」, 「private」 のいずれかです。 |
|
アクセス許可
|
data.acl | AccessPermissions |
1 人以上のユーザーおよび/またはグループのアクセス許可の集合を示します。 |
|
すべてのユーザーの ID
|
data.all_user_ids | string |
すべてのユーザーの ID のリストを文字列として連結し、セミコロンで区切って示します。 |
|
すべてのグループの ID
|
data.all_group_ids | string |
すべてのユーザーの ID のグループを文字列として連結し、セミコロンで区切って示します。 |
AccessPermissions
1 人以上のユーザーおよび/またはグループのアクセス許可の集合を示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受託者名
|
name | string |
受託者の名を示します。 |
|
受託者の ID
|
id | string |
受託者の ID を示します。 これは、ユーザー ID またはグループ ID です。 |
|
受託者の SID
|
sid | string |
ユーザーまたはグループのセキュリティ識別子を示します。 |
|
受託者タイプ
|
type | string |
返される受託者の種類を示します。 指定できる値は、 'user' または 'group' です。 |
|
アクセス レベル
|
access_level | string |
ユーザーまたはグループがオブジェクトに対して持っているアクセス権を示します。 可能な値は「no_access」、「read」、「read_write」、「full_access」です。 |
|
アクセス レベル表示名
|
access_level_display_name | string |
このオブジェクトのユーザーまたはグループに割り当てられた人間が判読できるアクセス レベル 表示名 を示します。 可能な値は、「アクセス許可なし」、「読み取り専用」、「読み取り/書き込み」、「フル アクセス」です。 |
|
アクセス
|
access | integer |
ユーザーまたはグループがオブジェクトに対して持っているアクセス許可の数値を示します。 可能な値は 0 (no_access)、1 (read)、2 (read_write)、3 (full_access) です。 |
|
外部である
|
is_external | boolean |
ユーザーが外部ユーザーであるか、またはグループが外部ユーザーに制限されているかどうかを示します。 |
|
ログオンを許可
|
allow_logon | boolean |
ユーザーがログオンを許可されているかどうかを示します。 グループには適用されません。 |
|
Is Enabled
|
enabled | boolean |
グループが有効化されているかどうかを示します。 ユーザーには適用されません。 |
|
制限されたメンバーがいます
|
has_restricted_member | boolean |
iManage Security Policy Manager によってこのオブジェクトへのアクセスが拒否されたユーザーがグループに少なくとも 1 人以上いるかどうかを示します。 |
オブジェクト
’オブジェクト’ という種類です。
binary
これは基本的なデータ型 'バイナリ' です。