iManage Work
iManage Work コネクタを使用すると、ユーザーは反復的なタスクと承認プロセスを自動化しながら、すべてのファイルを iManage Work 環境で安全に保つことができます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | iManage LLC |
| URL | https://docs.imanage.com |
| cloudsupport@imanage.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | iManage Power Platform コネクタ |
| Website | 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 にサインインしていない場合は、サインインを求められます。
- [ サインイン] を選択します。
- iManage Work への接続に使用する URL (cloudimanage.com など) を入力します。
- iManage Work ユーザー ID を入力します。
- 選択したアカウントのパスワードを入力し、[ ログイン] を選択します。 この時点から、iManage Work アクションを使用するすべてのフローは、これらのユーザー資格情報を使用して接続します。 別の iManage ユーザー アカウントを使用するには、[ マイ接続] に新しい接続を追加し、それに切り替えることができます。
既知の問題と制限事項
既知の問題と制限事項の一覧については、 https://docs.imanage.com/power-automate/index.htmlを参照してください。
一般的なエラーと解決方法
一般的なエラーと解決方法の一覧については、 https://docs.imanage.com/power-automate/index.htmlを参照してください。
FAQ
よく寄せられる質問の一覧については、 https://docs.imanage.com/power-automate/index.htmlを参照してください。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アクセス許可のコピー |
アクセス許可と、必要に応じて既定のセキュリティを 1 つの iManage Work オブジェクトから別の iManage Work オブジェクトにコピーします。 [コピーの種類] には、ソースと宛先のアクセス許可の組み合わせを処理する方法のオプションが用意されています。 'Overwrite' は、ターゲット オブジェクトのユーザー、グループ、およびアクセス許可レベルをソース オブジェクトと完全に一致するように更新します。 'Merge' は宛先オブジェクトのすべてのユーザーとグループを保持し、それらをソースと結合しますが、個々またはグループのアクセス許可レベルが競合する場合は、'Merge (Pessimistic)' の方が低いアクセス許可を受け取り、'Merge (オプティミスティック) は競合するユーザーまたはグループに対して高いアクセス許可を取得します。 |
| アクセス許可の取得 |
ドキュメント、フォルダー、またはワークスペースのユーザーまたはグループ のアクセス許可プロパティを取得します。 応答プロパティは、ユーザーまたはグループのアクセス許可によって異なる場合があります。 |
| アクセス許可を更新する |
オブジェクトのアクセス許可を更新します。 |
| クラスを取得する |
指定した条件に一致するライブラリで使用できるドキュメント クラスの一覧を取得します。 |
| グループ メンバーを取得する |
指定したグループに属し、指定した条件に一致するユーザーの詳細を取得します。 |
| コア拡張メタデータ分類ノード値を検索する |
指定された検索条件に一致するコア拡張メタデータ分類ノード値を検索します。 |
| サブクラスを取得する |
指定した条件に一致するすべてのライブラリ サブクラスを取得します。 |
| トラスティを取得する |
ドキュメント、フォルダー、またはワークスペースに対する特定のアクセス許可を持つトラスティの一覧を取得します。 トラスティには、ユーザーまたはグループを指定できます。 |
| ドキュメント バージョンの昇格 |
ドキュメントの既存のバージョンを最新バージョンに昇格します。 指定した履歴 ID またはバージョンから新しいバージョンが作成され、最新バージョンに昇格されます。 ジャーナル ID またはバージョンを指定する必要がありますが、両方を指定する必要はありません。 |
| ドキュメント プロファイルを取得する |
特定のドキュメント ID に関連付けられているドキュメント プロパティを取得します。 |
| ドキュメント プロファイルを更新する |
ドキュメント プロファイルに対して更新を実行します。 プロファイルの更新中にドキュメントを使用しないでください。また、チェックアウトされたドキュメントのプロファイルを更新することはできません。 操作後に更新されたドキュメント プロファイルを返します。 |
| ドキュメントにコア拡張メタデータ プロパティを設定する |
ドキュメントの主要な拡張メタデータ プロパティを設定します。 |
| ドキュメントのコア拡張メタデータ プロパティを取得する |
ドキュメントのコア拡張メタデータ プロパティを取得します。 |
| ドキュメントのダウンロード |
ドキュメント ID に基づいて、特定のドキュメントのバージョンをダウンロードします。 latest が true の場合、このドキュメントの最新バージョンがダウンロードされます。 ダウンロードはストリームであり、ローカルに保存されません。 |
| ドキュメントのバージョンを取得する |
現在のユーザーが指定したドキュメントに対してアクセスできるすべてのバージョンのプロファイルを取得します。 |
| ドキュメントのリレーションシップを削除する |
ライブラリ内の指定したドキュメント間の関係を削除します。 |
| ドキュメントの移動 |
指定したフォルダーにドキュメントを移動します。 |
| ドキュメントの関係を作成する |
ライブラリ内の指定したドキュメント間にリレーションシップを作成します。 |
| ドキュメントをアップロードする |
指定したフォルダーに新しいドキュメントとしてファイルをアップロードします。 |
| ドキュメントをコピーする |
指定したフォルダーにドキュメントをコピーします。 |
| ドキュメントを削除する |
指定した文書を削除します。 |
| ドキュメント参照の削除 |
指定したフォルダーからドキュメント参照を削除します。 |
| ドキュメント参照を追加する |
別のフォルダーにドキュメント参照またはドキュメント ショートカットを追加します。 |
| ドキュメント履歴エントリを追加する |
ドキュメントの履歴にイベントとしてエントリを追加します。 |
| フォルダーを検索する |
フォルダーを検索します。 |
| ユーザーの検索 |
指定した検索条件に一致する iManage Work ユーザーを検索します。 |
| ユーザーの詳細を取得する |
指定したライブラリからユーザーに関する情報を取得します。 |
| ライブラリを取得する |
ユーザーがアクセスできるライブラリの一覧を取得します。 |
| ワークスペース テンプレートを取得する |
ライブラリで使用できるテンプレートの一覧を取得します。 ワークスペース テンプレートは、新しいワークスペースの構造がコピーされる定義済みのワークスペースです。 |
| ワークスペース プロファイルを取得する |
ワークスペース プロファイルと、必要に応じてワークスペースに対して許可される操作の一覧を取得します。 |
| ワークスペースを作成する |
選択したテンプレートに基づいて新しいワークスペースを作成します。 ワークスペース テンプレートは、構造が新しいワークスペースにコピーされる定義済みのワークスペースです。 ワークスペース テンプレートに対する制限は、新しいワークスペースの作成時に自動的に適用されます。 |
| ワークスペースを更新する |
指定したワークスペースの情報を更新します。 文字列フィールドの既存の値を削除するには、フィールドの値を、単一引用符または二重引用符で囲まれた空の文字列に設定します。 |
| ワークスペースを検索する |
ワークスペースを検索します。 |
| ワークフローの状態を更新する |
ワークフロー実行の状態を更新します。 このアクションは、iManage によって提供されるトリガーで開始するために作成されたワークフローでのみ使用できます。 |
| 名前と値のペアを編集する |
ドキュメント、フォルダー、またはワークスペースの名前と値のペアのプロパティを作成、更新、または削除します。 名前と値のペアを削除するには、キーの値を、単一引用符または二重引用符で囲まれた空の文字列に設定します。 |
| 既定のセキュリティを更新する |
ドキュメント、フォルダー、またはワークスペースの既定のセキュリティを更新します。 |
| 現在のバージョンを更新するか、新しいドキュメント バージョンを作成する |
指定したバージョンのドキュメントを更新するか、新しいバージョンを作成します。 このアクションにより、ドキュメントのプロファイルとコンテンツを更新できます。 [現在のバージョンの更新] オプションが指定されている場合、ドキュメントは新しいバージョンに置き換えられ、前のドキュメントのプロファイルが保持されます。 [新しいバージョンの作成] を指定すると、フォルダーのプロファイルを継承するドキュメントの新しいバージョンが作成されます。 操作が正常に実行されると、ドキュメント プロファイルが返されます。 |
アクセス許可のコピー
アクセス許可と、必要に応じて既定のセキュリティを 1 つの iManage Work オブジェクトから別の iManage Work オブジェクトにコピーします。 [コピーの種類] には、ソースと宛先のアクセス許可の組み合わせを処理する方法のオプションが用意されています。 'Overwrite' は、ターゲット オブジェクトのユーザー、グループ、およびアクセス許可レベルをソース オブジェクトと完全に一致するように更新します。 'Merge' は宛先オブジェクトのすべてのユーザーとグループを保持し、それらをソースと結合しますが、個々またはグループのアクセス許可レベルが競合する場合は、'Merge (Pessimistic)' の方が低いアクセス許可を受け取り、'Merge (オプティミスティック) は競合するユーザーまたはグループに対して高いアクセス許可を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ソース オブジェクトの種類
|
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 |
ソース オブジェクトの既定のセキュリティをターゲット オブジェクトにコピーすることを指定します。 ソース オブジェクトの既定のセキュリティが 'inherit' の場合、継承された既定のセキュリティはソースからターゲット オブジェクトにコピーされます。 |
戻り値
アクセス許可の取得
ドキュメント、フォルダー、またはワークスペースのユーザーまたはグループ のアクセス許可プロパティを取得します。 応答プロパティは、ユーザーまたはグループのアクセス許可によって異なる場合があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object Type/オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
オブジェクト 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'、または 'private' です。 |
|
アクセス許可
|
data.acl | AccessPermissions |
1 つ以上のユーザーまたはグループのアクセス許可のコレクションを示します。 |
|
すべてのユーザー ID
|
data.all_user_ids | string |
文字列として連結され、セミコロンで区切られた、すべてのユーザー ID の一覧を示します。 |
|
すべてのグループ ID
|
data.all_group_ids | string |
文字列として連結され、セミコロンで区切られた、すべてのグループ ID の一覧を示します。 |
アクセス許可を更新する
オブジェクトのアクセス許可を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object Type/オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
オブジェクト ID
|
objectId | True | string |
ドキュメント、フォルダー、またはワークスペースの ID を指定します。 ドキュメント ID の例として、"ACTIVE_US!453.1" があります。 フォルダーまたはワークスペース ID の例として、"ACTIVE_US!123" があります。 |
|
アクセス レベル
|
access_level | True | string |
アクセス レベルを指定します。 |
|
ユーザー
|
users | string |
アクセス レベルを設定する 1 人以上のユーザーをセミコロンで区切って指定します。 |
|
|
Groups
|
groups | string |
アクセス レベルを設定する 1 つ以上のグループをセミコロンで区切って指定します。 |
戻り値
クラスを取得する
指定した条件に一致するライブラリで使用できるドキュメント クラスの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット クラスのライブラリ ID を指定します。 |
|
クラスID
|
alias | string |
検索するクラスの ID を指定します。 コンマ区切りのリストを指定できます。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致がサポートされています。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 |
|
|
Description
|
description | string |
説明フィールドで一致するテキストを指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) がサポートされています。 部分的な一致はサポートされていません。 |
|
|
Echo
|
echo | boolean |
このクラスのドキュメントがドキュメントをエコーできるかどうかを指定します。 |
|
|
HIPAA
|
hipaa | boolean |
このクラスのドキュメントで HIPAA 準拠の暗号化を使用するかどうかを指定します。 |
|
|
インデックス
|
indexable | boolean |
このクラスのドキュメントがシステムのフルテキスト インデクサーによってインデックス付けされるかどうかを指定します。 |
|
|
Query
|
query | string |
ID フィールドまたは説明フィールドと一致するテキストを指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致がサポートされています。 |
|
|
サブクラス必須
|
subclass_required | boolean |
クラスに必須のサブクラスがあるかどうかを指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
上位照合クラス ID
|
data.topMatchingId | string |
一致する最上位クラスの ID を示します。 たとえば、"署名" などです。 |
|
上位照合クラスの説明
|
data.topMatchingDescription | string |
一致する最上位クラスの説明を示します。 |
|
results
|
data.results | array of object |
指定した条件に一致するライブラリで使用できるクラスの一覧を示します。 |
|
Description
|
data.results.description | string |
クラスに関する追加情報を示します。 |
|
Is HIPAA
|
data.results.hipaa | boolean |
ドキュメントが暗号化されているかどうかを示します。 |
|
ID
|
data.results.id | string |
クラスの ID を示します。 たとえば、"署名" などです。 |
|
インデックス可能
|
data.results.indexable | boolean |
ドキュメントがシステムによってインデックス付けされているかどうかを示します。 |
|
既定のセキュリティ
|
data.results.default_security | string |
既定のセキュリティ アクセス レベルを示します。 指定できる値は、'public'、'view'、'private' です。 |
|
Retain
|
data.results.retain | integer |
このクラスの非アクティブなドキュメントを期限切れとしてマークするまでの日数を示します。 |
|
必須フィールド
|
data.results.required_fields | array of string |
このクラスのドキュメントを作成または更新するときに入力する必須のカスタム プロパティを示します。 |
|
影付き
|
data.results.shadow | boolean |
チェックイン後に、このクラスのドキュメントがユーザーのローカル コンピューターでシャドウ (保持) されているかどうかを示します。 |
|
Is サブクラスが必要です
|
data.results.subclass_required | boolean |
このクラスにサブクラスが必要かどうかを示します。 |
グループ メンバーを取得する
指定したグループに属し、指定した条件に一致するユーザーの詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット グループのライブラリ ID を指定します。 |
|
グループ識別子
|
groupId | True | string |
グループの ID を指定します。 たとえば、"MARKETING" です。 |
|
ログオンの状態
|
logon_status | string |
各ユーザーの現在の 'allow_logon' プロパティ値に基づいて、ユーザーのフィルターを指定します。 |
|
|
極限
|
limit | integer |
グループ内のメンバーの合計数に関係なく、返されるメンバーの最大数を指定します。 |
|
|
優先ライブラリ
|
preferred_library | string |
優先ライブラリが指定された値と一致するユーザーのみを返すように指定します。 |
|
|
ロケーション
|
___location | string |
地理的な場所に基づいてユーザーを検索するために使用する場所を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) はサポートされていません。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of UserProfileInArray |
指定したグループに属し、指定した条件に一致するユーザーの一覧を示します。 |
コア拡張メタデータ分類ノード値を検索する
指定された検索条件に一致するコア拡張メタデータ分類ノード値を検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
検索を実行するライブラリの ID を指定します。 |
|
Taxonomy プロパティ
|
taxonomyProperty | True | string |
ノード値を検索する分類プロパティを指定します。 |
|
ID
|
id | string |
分類ノード値の表示識別子を指定します。 この検索では、大文字と小文字は区別されません。 部分的な一致はサポートされていません。 |
|
|
Query
|
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 形式) を示します。 |
|
有効
|
data.topMatchingResult.enabled | boolean |
一致する最上位のノード値が有効かどうかを示します。 |
|
ID
|
data.topMatchingResult.id | string |
一致する一番上のノード値の表示識別子を示します。 |
|
SSID
|
data.topMatchingResult.parent.ssid | string |
最上位の一致するノード値の直接の親ノードに対して、システムによって生成された一意の ID を示します。 |
|
SSID
|
data.topMatchingResult.ssid | string |
一致する一番上のノード値の一意のシステム生成 ID を示します。 |
|
経路
|
data.topMatchingResult.path | array of object |
一致する一番上のノード値への完全パスを示します。 パスは、分類の最上位ノードから始まり、一致するノードの直接の親までのすべてのノードから順に並べ替えられたリストです。 |
|
各 ID
|
data.topMatchingResult.path.id | string |
一致する一番上のノードのパス内のノード値の表示識別子を示します。 |
|
各 SSID
|
data.topMatchingResult.path.ssid | string |
一致する最上位ノードのパス内のノード値に対して、システムによって生成された一意の ID を示します。 |
|
コア拡張メタデータ分類の検索結果
|
data.results | array of TaxonomyNodeValue |
検索に一致する 1 つ以上のコア拡張メタデータ分類ノード値を示します。 |
|
すべての分類ノード SSD
|
data.all_taxonomy_ssids | string |
文字列として連結され、セミコロンで区切られた、すべての分類ノード SSD の一覧を示します。 |
サブクラスを取得する
指定した条件に一致するすべてのライブラリ サブクラスを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット サブクラスのライブラリ ID を指定します。 |
|
クラスID
|
classId | True | string |
このサブクラスの親であるクラスの ID を指定します。 たとえば、"署名" などです。 |
|
サブクラス ID
|
alias | string |
検索するサブクラスの ID を指定します。 コンマ区切りのリストを指定できます。 ワイルドカード文字 (*) がサポートされています。 ワイルドカード文字を使用する場合は、部分的な一致がサポートされます。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 |
|
|
Description
|
description | string |
説明フィールドで一致するテキストを指定します。 ワイルドカード文字 (*) がサポートされています。 ワイルドカード文字を使用する場合は、部分的な一致がサポートされます。 |
|
|
Echo
|
echo | boolean |
サブクラスをユーザーのローカル ハード ドライブにエコーできるかどうかを指定します。 これは、オフラインでの作業を容易にするためです。 |
|
|
HIPAA
|
hipaa | boolean |
HIPAA 準拠サブクラスを返すかどうかを指定します。 |
|
|
Query
|
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' です。 |
|
Description
|
data.results.description | string |
サブクラスに関する追加情報を示します。 最大文字数は 255 文字です。 |
|
Is HIPAA
|
data.results.hipaa | boolean |
ドキュメントが暗号化されているかどうかを示します。 |
|
ID
|
data.results.id | string |
ドキュメント プロファイル情報の作成または変更に使用するサブクラスの ID を示します。 たとえば、"GUARDIANSHIP" などです。 |
|
親 ID
|
data.results.parent.id | string |
サブクラスの親クラス ID を示します。 |
|
必須フィールド
|
data.results.required_fields | array of string |
このサブクラスのドキュメントを作成または更新するときに入力する必須のカスタム プロパティを示します。 |
|
Retain
|
data.results.retain | integer |
このサブクラスの非アクティブなドキュメントを期限切れとしてマークするまでの日数を示します。 |
|
影付き
|
data.results.shadow | boolean |
このサブクラスのドキュメントが、チェックイン後にユーザーのローカル コンピューターでシャドウ (保持) されているかどうかを示します。 |
トラスティを取得する
ドキュメント、フォルダー、またはワークスペースに対する特定のアクセス許可を持つトラスティの一覧を取得します。 トラスティには、ユーザーまたはグループを指定できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object Type/オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
オブジェクト 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' です。 |
ドキュメント バージョンの昇格
ドキュメントの既存のバージョンを最新バージョンに昇格します。 指定した履歴 ID またはバージョンから新しいバージョンが作成され、最新バージョンに昇格されます。 ジャーナル ID またはバージョンを指定する必要がありますが、両方を指定する必要はありません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
バージョン
|
version | integer |
昇格された新しいバージョンの基礎として使用するバージョン番号を指定します。 |
|
|
履歴 ID
|
journalId | string |
昇格された新しいバージョンの基礎として使用するジャーナル ID を指定します。 |
|
|
コメント
|
comment | string |
ドキュメントに関する追加情報を指定します。 |
|
|
エイリアス
|
alias | string |
このドキュメントのエイリアスを指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を指定します。 たとえば、"JSMITH" などです。 |
|
|
Document クラス
|
class | string |
ドキュメント クラスを指定します。 |
|
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 |
|
|
Is Declared
|
is_declared | boolean |
ドキュメントの新しいバージョンをレコードとして宣言するかどうかを指定します。 レコードとして宣言されているドキュメントは、iManage Work システム管理者を除き、編集または削除できません。 |
|
|
Is 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 |
ISO 8601 datetime 形式で custom21 プロパティの値を指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 プロパティの値を ISO 8601 datetime 形式で指定します。 |
|
|
Custom23
|
custom23 | string |
ISO 8601 datetime 形式で custom23 プロパティの値を指定します。 |
|
|
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 に関連付けられているドキュメント プロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
最新バージョンを取得する
|
latest | boolean |
ドキュメントの最新バージョンを取得するように指定します。 |
ドキュメント プロファイルを更新する
ドキュメント プロファイルに対して更新を実行します。 プロファイルの更新中にドキュメントを使用しないでください。また、チェックアウトされたドキュメントのプロファイルを更新することはできません。 操作後に更新されたドキュメント プロファイルを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エイリアス
|
alias | string |
このドキュメントのエイリアスを指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を指定します。 たとえば、"JSMITH" などです。 |
|
|
コメント
|
comment | string |
ドキュメントに関する追加情報を指定します。 |
|
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 |
|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
Is Declared
|
is_declared | boolean |
ドキュメントをレコードとして宣言するかどうかを指定します。 レコードとして宣言されているドキュメントは、iManage Work システム管理者を除き、編集または削除できません。 |
|
|
Is HIPAA
|
is_hipaa | boolean |
ドキュメントを暗号化するかどうかを指定します。 |
|
|
監査コメント
|
audit_comment | string |
ドキュメント プロファイルの更新に関する追加情報を指定します。 |
|
|
Document クラス
|
class | string |
ドキュメント クラスを指定します。 |
|
|
ドキュメント名
|
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 |
ISO 8601 datetime 形式で custom21 プロパティの値を指定します。 |
|
|
Custom22
|
custom22 | string |
custom22 プロパティの値を ISO 8601 datetime 形式で指定します。 |
|
|
Custom23
|
custom23 | string |
ISO 8601 datetime 形式で custom23 プロパティの値を指定します。 |
|
|
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
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
名前
|
key | True | string |
コア拡張メタデータ プロパティの名前を指定します。 |
|
価値
|
value | True | string |
コア拡張メタデータ プロパティに設定する 1 つ以上の値をセミコロンで区切って指定します。 値の設定を解除するには、キーの値を、単一引用符または二重引用符で囲まれた空の文字列に設定します。 |
ドキュメントのコア拡張メタデータ プロパティを取得する
ドキュメントのコア拡張メタデータ プロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
最新
|
latest | boolean |
ドキュメントの最新バージョンを取得するように指定します。 |
ドキュメントのダウンロード
ドキュメント ID に基づいて、特定のドキュメントのバージョンをダウンロードします。 latest が true の場合、このドキュメントの最新バージョンがダウンロードされます。 ダウンロードはストリームであり、ローカルに保存されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_USE!453.1' などです。 |
|
最新バージョンを取得する
|
latest | boolean |
ドキュメントの最新バージョンをダウンロードするように指定します。 |
戻り値
ファイルの内容を示します。
- ファイル コンテンツ
- binary
ドキュメントのバージョンを取得する
現在のユーザーが指定したドキュメントに対してアクセスできるすべてのバージョンのプロファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント プロファイル
|
data | array of MinimalDocumentProfileInArray |
ドキュメントのリレーションシップを削除する
ライブラリ内の指定したドキュメント間の関係を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プライマリ ドキュメント ID
|
primaryDocumentId | True | string |
プライマリ ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
関連ドキュメント ID
|
relatedDocumentId | True | string |
関連するドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
戻り値
- response
- object
ドキュメントの移動
指定したフォルダーにドキュメントを移動します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
親フォルダー ID
|
folderId | True | string |
親フォルダーのフォルダー ID を指定します。 たとえば、'ACTIVE_US!987' などです。 |
|
ドキュメント 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 |
ドキュメントのセキュリティを移行先フォルダーのセキュリティで更新するかどうかを指定します。 このパラメーターは、更新プロファイルが true に設定されている場合にのみ適用されます。 |
|
|
タイムラインコメント
|
comments | string |
操作に関する追加情報を指定します。 これらのコメントは、ドキュメントのタイムラインに表示されます。 |
ドキュメントの関係を作成する
ライブラリ内の指定したドキュメント間にリレーションシップを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プライマリ ドキュメント ID
|
primaryDocumentId | True | string |
関連付けるプライマリ ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
関連ドキュメント ID
|
relatedDocumentId | True | string |
関連付けるドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
戻り値
- response
- object
ドキュメントをアップロードする
指定したフォルダーに新しいドキュメントとしてファイルをアップロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ライブラリの ID を指定します。 |
|
フォルダー ID
|
folderId | True | string |
ターゲット フォルダーのフォルダー ID を指定します。 たとえば、'ACTIVE_US!987' などです。 |
|
フォルダー プロファイルの継承
|
inherit_profile_from_folder | True | boolean |
プロファイル データを親フォルダーから継承するかどうかを指定します。 |
|
ロックを維持する
|
keep_locked | boolean |
アップロード後にドキュメントロックを保持するかどうかを指定します。 |
|
|
コメント
|
comment | string |
更新プログラムに関する追加情報を指定します。 |
|
|
Author
|
author | string |
ドキュメントを作成したユーザーの iManage Work ID を指定します。 |
|
|
Operator
|
operator | string |
ドキュメントがチェックアウトされているか、現在ドキュメントのプロファイルを編集しているユーザーの ID を指定します。 たとえば、"JSMITH" などです。 |
|
|
クラス
|
class | string |
ドキュメントを識別および区別するためのクラスを指定します。 ドキュメント クラスは、ジャンル、部門、地域などで分類されます。 |
|
|
亜綱
|
subclass | string |
ドキュメントを識別および区別するためのサブクラスを指定します。 ドキュメント サブクラスは、ジャンル、部門、地域などで分類されます。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 指定できる値は、'inherit'、'private'、'view'、'public' です。 |
|
|
Is 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 |
iso 8601 datetime 形式の custom21 の値を指定します。 |
|
|
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
|
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' です。 |
|
エイリアス
|
data.alias | string |
このドキュメントのエイリアスを示します。 |
|
Author
|
data.author | string |
ドキュメントを作成したユーザーの ID を示します。 たとえば、"JSMITH" などです。 |
|
作成者の説明
|
data.author_description | string |
ドキュメントの作成者に関する追加情報を示します。 |
|
[Cc]
|
data.cc | string |
メールのカーボン コピー先の受信者を示します。 メールにのみ適用されます。 |
|
Document クラス
|
data.class | string |
ドキュメントのクラスを示します。 |
|
ドキュメント クラスの説明
|
data.class_description | string |
ドキュメント クラスに関する追加情報を示します。 |
|
コンテンツ タイプ
|
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' です。 |
|
ドキュメント番号
|
data.document_number | integer |
ドキュメントのドキュメント番号を示します。 |
|
ドキュメント 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 |
ドキュメントの完全なファイル名を示します。 ファイル名拡張子が含まれます。 |
|
添付ファイルがある
|
data.has_attachment | boolean |
電子メールに添付ファイルがあるかどうかを示します。 メールにのみ適用されます。 |
|
基本的なドキュメントのプロパティ
|
data.basic_properties | string |
基本的なドキュメント プロパティを含む埋め込み可能な '' 要素を示します。 |
|
ドキュメント ID
|
data.id | string |
ドキュメントの ID を示します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
インデックス可能
|
data.indexable | boolean |
ドキュメントがシステムによってインデックス付けされているかどうかを示します。 |
|
チェックアウト済み
|
data.is_checked_out | boolean |
ドキュメントがチェックアウトされているかどうかを示します。 |
|
Is Declared
|
data.is_declared | boolean |
ドキュメントがレコードとして宣言されているかどうかを示します。 レコードとして宣言されているドキュメントは、iManage Work システム管理者を除き、編集または削除できません。 |
|
外部
|
data.is_external | boolean |
ドキュメントが外部ユーザーと共有されているかどうかを示します。 |
|
通常どおり外部
|
data.is_external_as_normal | boolean |
ドキュメントが通常どおり外部にあるかどうかを示します。 |
|
Is 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 |
ドキュメントの種類を示します。 たとえば、Word for Microsoft Word などです。 現在の種類の一覧については、iManage Work システム管理者にお問い合わせください。 |
|
型の説明
|
data.type_description | string |
ドキュメントの種類に関する追加情報を示します。 |
|
ドキュメントのバージョン
|
data.version | integer |
ドキュメントのバージョン番号を示します。 |
|
ワークスペース ID
|
data.workspace_id | string |
ドキュメントのワークスペースの ID を示します。 たとえば、'ACTIVE_US!427' などです。 |
|
ワークスペース名
|
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 |
ISO 8601 datetime 形式の custom21 プロパティの値を示します。 |
|
Custom22
|
data.custom22 | string |
ISO 8601 datetime 形式の custom22 プロパティの値を示します。 |
ドキュメントを削除する
指定した文書を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
すべてのバージョンを削除する
|
deleteAllVersions | True | boolean |
ドキュメントのすべてのバージョンを削除するように指定します。 |
ドキュメント参照の削除
指定したフォルダーからドキュメント参照を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
フォルダー ID
|
folderId | True | string |
フォルダーの ID を指定します。 たとえば、'ACTIVE_US!773' などです。 |
戻り値
- response
- object
ドキュメント参照を追加する
別のフォルダーにドキュメント参照またはドキュメント ショートカットを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント 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
|
documentId | True | string |
ドキュメントの ID を指定します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
Activity
|
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 |
フォルダーの description プロパティで見つかる値を指定します。 この検索では、大文字と小文字は区別されません。 部分的な一致がサポートされています。 |
|
|
フォルダーの電子メール アドレス
|
string |
フォルダーのメール アドレスと一致する電子メール アドレスを指定します。 たとえば、"email1234@ajubalaw.com" です。 |
||
|
フォルダー名
|
name | string |
フォルダーの name プロパティで見つかる値を指定します。 この検索では、大文字と小文字は区別されません。 部分的な一致がサポートされています。 |
|
|
フォルダーの所有者
|
owner | string |
フォルダーに関連付けられている所有者と一致する文字列を指定します。 この検索では、大文字と小文字は区別されません。 部分的な一致がサポートされています。 |
|
|
ワークスペース名
|
workspace_name | string |
フォルダーが属する親ワークスペースの名前を指定します。 この検索では、大文字と小文字は区別されません。 部分的な一致がサポートされています。 |
ユーザーの検索
指定した検索条件に一致する iManage Work ユーザーを検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電子メール ID
|
string |
検索する電子メール ID を指定します。 たとえば、"JSMITH@XYZ.COM" です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ログオンを許可する
|
data.topMatchingUser.allow_logon | boolean |
ユーザーがログオンを許可されているかどうかを示します。 |
|
Custom1
|
data.topMatchingUser.custom1 | string |
ユーザーに関する追加情報を示します。 |
|
Custom2
|
data.topMatchingUser.custom2 | string |
ユーザーに関する追加情報を示します。 |
|
Custom3
|
data.topMatchingUser.custom3 | string |
ユーザーに関する追加情報を示します。 |
|
ディレクトリ ID
|
data.topMatchingUser.directory_id | string |
ユーザー プロファイルの同期に使用される外部ディレクトリ (ADFS など) の ID を示します。 |
|
識別名
|
data.topMatchingUser.distinguished_name | string |
LDAP ツリーのルートまでエントリをトレースする名前の完全修飾パスを表すオブジェクトの名前を示します。 |
|
日付の編集
|
data.topMatchingUser.edit_date | string |
ユーザー プロファイルに対する最新の変更の日付と時刻 (ISO 8601 形式) を示します。 |
|
Email
|
data.topMatchingUser.email | string |
ユーザーの電子メール ID を示します。 |
|
Exchange 自動検出 URL
|
data.topMatchingUser.exch_autodiscover | string |
ユーザーの Exchange サーバーの詳細を示します。 |
|
Extension
|
data.topMatchingUser.extension | string |
ユーザーの電話番号の拡張子を示します。 |
|
失敗したログオン試行
|
data.topMatchingUser.failed_logins | integer |
ユーザーの現在の失敗したサインイン試行回数を示します。 |
|
ファクス
|
data.topMatchingUser.fax | string |
ユーザーの FAX 番号を示します。 |
|
パスワードの変更を強制する
|
data.topMatchingUser.force_password_change | boolean |
ユーザーが次のサインイン時にパスワードを変更する必要があることを示します。 "user_nos" 値 '2' で示される仮想ユーザーにのみ適用されます。 |
|
氏名
|
data.topMatchingUser.full_name | string |
ユーザーの完全な名前を示します。 |
|
全般
|
data.topMatchingUser.general | string |
ユーザーに関する一般的な情報を示します。 |
|
ID
|
data.topMatchingUser.id | string |
ユーザーの ID を示します。 たとえば、"JSMITH" などです。 |
|
外部
|
data.topMatchingUser.is_external | boolean |
外部ユーザーを示します。 外部ユーザーはアクセスが制限されており、一時的なチーム メンバー、コンサルタント、または組織の外部ユーザーに一般的に使用されます。 |
|
最終同期時刻
|
data.topMatchingUser.last_sync_ts | string |
LDAP や Microsoft Active Directory (ADFS) などの外部ディレクトリを持つユーザーのプロファイルの最終同期時刻 (ISO 8601 datetime 形式) を示します。 |
|
ロケーション
|
data.topMatchingUser.___location | string |
ユーザーの地理的な場所を示します。 |
|
パスワードの有効期限なし
|
data.topMatchingUser.password_never_expire | boolean |
ユーザーのパスワードの有効期限が切れないかどうかを示します。 |
|
電話番号
|
data.topMatchingUser.phone | string |
ユーザーの電話番号を示します。 |
|
優先ライブラリ
|
data.topMatchingUser.preferred_library | string |
優先ライブラリを示します。 優先ライブラリは、ユーザーの既定のライブラリです。 各ユーザーには、1 つの優先ライブラリが必要です。 |
|
パスワードの変更時刻
|
data.topMatchingUser.pwd_changed_ts | string |
ユーザーのパスワードが最後に変更された時刻 (ISO 8601 datetime 形式) を示します。 これは、仮想ユーザー (ユーザー NOS が 2) にのみ適用されます。 |
|
SSID
|
data.topMatchingUser.ssid | string |
ユーザーの一意のシステム生成 ID を示します。 |
|
ドメイン
|
data.topMatchingUser.user_domain | string |
ユーザーのディレクトリ サービスの完全修飾ドメイン名を示します。 |
|
拡張 ID
|
data.topMatchingUser.user_id_ex | string |
Microsoft Active Directory (ADFS) などの外部ディレクトリから受信したユーザー ID の元の値を示します。 |
|
NOS
|
data.topMatchingUser.user_nos | integer |
ユーザーの同期元のオペレーティング システムの種類を示します。 指定できる値は、2 (仮想ユーザー) と 6 (エンタープライズ ユーザー) です。 詳細については、iManage Work システム管理者にお問い合わせください。 |
|
Number
|
data.topMatchingUser.user_num | integer |
ユーザーの数値システム ID を示します。 |
|
results
|
data.results | array of UserProfileInArray |
ユーザーの詳細を取得する
指定したライブラリからユーザーに関する情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ユーザーのライブラリ ID を指定します。 |
|
ユーザー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 |
現在の日付を基準にして、検索する日付範囲を指定します。 このパラメーターの形式は [begin]:[end][time units (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 |
現在の日付を基準にして、検索する日付範囲を指定します。 このパラメーターの形式は [begin]:[end][time units (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 |
現在の日付を基準にして、検索する日付範囲を指定します。 このパラメーターの形式は [begin]:[end][time units (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 |
現在の日付を基準にして、検索する日付範囲を指定します。 このパラメーターの形式は [begin]:[end][time units (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 と一致する値を指定します。 この検索では、大文字と小文字は区別されません。 ワイルドカード文字 (*) と部分一致はサポートされていません。 |
ワークスペース プロファイルを取得する
ワークスペース プロファイルと、必要に応じてワークスペースに対して許可される操作の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークスペース 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
|
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 datetime 形式で custom21 の値を指定します。 |
|
|
Custom22
|
custom22 | string |
iso 8601 datetime 形式で custom22 の値を指定します。 |
|
|
Custom23
|
custom23 | string |
iso 8601 datetime 形式で custom23 の値を指定します。 |
|
|
Custom24
|
custom24 | string |
ISO 8601 datetime 形式で 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' に設定します。 |
|
|
Project Custom1
|
project_custom1 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Project Custom2
|
project_custom2 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Project Custom3
|
project_custom3 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Workspace サブクラス
|
subclass | string |
ワークスペースに含まれるドキュメントのサブクラスに基づいて、ワークスペースのサブクラスを指定します。 |
ワークスペースを更新する
指定したワークスペースの情報を更新します。 文字列フィールドの既存の値を削除するには、フィールドの値を、単一引用符または二重引用符で囲まれた空の文字列に設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークスペース 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 datetime 形式で指定します。 |
|
|
Custom24
|
custom24 | string |
iso 8601 datetime 形式で 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 の値も指定する必要があります。これは、その親子関係が原因です。 |
|
|
既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを指定します。 |
|
|
Description
|
description | string |
ワークスペースに関する追加情報を指定します。 |
|
|
通常どおり外部
|
is_external_as_normal | boolean |
ワークスペースをパブリック ワークスペースとして扱うことができるかどうかを指定します。 'true' に設定され、'default_security' が 'private' でない場合、'is_external' は 'true' に設定されます。 |
|
|
Project Custom1
|
project_custom1 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Project Custom2
|
project_custom2 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Project Custom3
|
project_custom3 | string |
ワークスペースに関する追加情報を指定します。 このフィールドは、ドキュメント、ワークスペース、フォルダーなどのコンテンツ アイテムに関連付けられているメタデータ ユーザー設定フィールドとは異なります。 これは、書式設定する必要がない説明テキストであり、検証されません。 |
|
|
Workspace サブクラス
|
subclass | string |
ワークスペースに含まれるドキュメントのサブクラスに基づいて、ワークスペースのサブクラスを指定します。 |
ワークスペースを検索する
ワークスペースを検索します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ライブラリ ID
|
libraryId | True | string |
ターゲット ワークスペースのライブラリ ID を指定します。 |
|
Title
|
name | string |
ワークスペースの name プロパティで検索する文字列を指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
オーナー
|
owner | string |
ワークスペースに関連付けられている所有者と一致する文字列を指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
Keyword
|
anywhere | string |
ワークスペース プロファイル内の任意の場所で検索するテキストを指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
Description
|
description | string |
ワークスペースの description プロパティで検索するテキストを指定します。 この検索では、大文字と小文字は区別されません。 |
|
|
亜綱
|
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
|
state | True | string |
ワークフロー実行の現在の状態を指定します。 |
|
ステータス
|
status | string |
ワークフロー実行の現在の状態を指定します。 最大文字数は 128 文字です。 |
|
|
ステータス メッセージ
|
statusMessage | string |
ワークフロー実行の現在の状態に合わせてカスタマイズされたメッセージを指定します。 最大長は 256 文字です。 |
戻り値
- response
- object
名前と値のペアを編集する
ドキュメント、フォルダー、またはワークスペースの名前と値のペアのプロパティを作成、更新、または削除します。 名前と値のペアを削除するには、キーの値を、単一引用符または二重引用符で囲まれた空の文字列に設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object Type/オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 指定できる値は、'document'、'folder'、'workspace' です。 |
|
オブジェクト ID
|
objectId | True | string |
ドキュメント、フォルダー、またはワークスペースの ID を指定します。 ドキュメント ID の例として、"ACTIVE_US!453.1" があります。 フォルダーまたはワークスペース ID の例として、"ACTIVE_US!123" があります。 |
|
名前と値のペア
|
nameValuePairs | object |
このドキュメントの自由形式の名前と値のペアを指定します。 |
既定のセキュリティを更新する
ドキュメント、フォルダー、またはワークスペースの既定のセキュリティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Object Type/オブジェクトの種類
|
objectType | True | string |
オブジェクトの種類を指定します。 |
|
オブジェクト 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 | 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' です。 |
|
|
Is 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 |
iso 8601 datetime 形式の custom21 の値を指定します。 |
|
|
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 の値も指定する必要があります。これは、その親子関係が原因です。 |
トリガー
| 複数の選択したドキュメントの場合 |
このトリガーを使用すると、iManage Work で選択した 1 つ以上のドキュメントのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。 |
| 選択したドキュメントの場合 |
このトリガーを使用すると、iManage Work ライブラリで選択したドキュメントのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。 |
| 選択したワークスペースの場合 |
このトリガーを使用すると、iManage Work ライブラリで選択したワークスペースのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。 |
複数の選択したドキュメントの場合
このトリガーを使用すると、iManage Work で選択した 1 つ以上のドキュメントのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフローの表示名
|
workflowName | True | string |
iManage Work ユーザーに表示されるワークフローの表示名を指定します。 |
|
Description
|
description | True | string |
ワークフローの説明を指定します。 |
|
ライブラリ ID
|
libraryId | True | string |
ワークフローを使用できるライブラリの ID を指定します。 |
|
フォーム ID
|
formId | True | string |
ワークフローで使用される入力を収集するためにユーザーに表示されるフォームの ID を指定します。 |
|
フォルダー ID を返す
|
inferFolderId | True | boolean |
ワークフローでドキュメントのフォルダー ID が必要かどうかを指定します。 |
|
ユーザーが使用できる
|
users | string |
ワークフローを使用できる 1 つ以上のユーザー ID をセミコロンで区切って指定します。 |
|
|
グループで使用できる
|
groups | string |
ワークフローを使用できる 1 つ以上のグループ ID をセミコロンで区切って指定します。 |
|
|
完了を待つ
|
waitForCompletion | boolean |
アプリケーションがワークフローの実行を完了するまで待機するかどうかを指定します。 [はい] に設定した場合は、[ワークフロー状態の更新] アクションを使用する必要があります。 |
戻り値
選択したドキュメントの場合
このトリガーを使用すると、iManage Work ライブラリで選択したドキュメントのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフローの表示名
|
workflowName | True | string |
iManage Work ユーザーに表示されるワークフローの表示名を指定します。 |
|
Description
|
description | True | string |
ワークフローの説明を指定します。 |
|
ライブラリ ID
|
libraryId | True | string |
ワークフローを使用できるライブラリの ID を指定します。 |
|
フォーム 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 |
アプリケーションがワークフローの実行を完了するまで待機するかどうかを指定します。 [はい] に設定した場合は、[ワークフロー状態の更新] アクションを使用する必要があります。 |
戻り値
選択したワークスペースの場合
このトリガーを使用すると、iManage Work ライブラリで選択したワークスペースのワークフローを開始できます。 iManage Work アプリケーションのユーザーに表示される表示名を指定します。 [完了待ち] が [はい] に設定されている場合は、ワークフローで "ワークフロー状態の更新" アクションを使用する必要があります。そうしないと、アプリケーションは最終的にユーザーに完了状態を示さずにタイムアウトします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフローの表示名
|
workflowName | True | string |
iManage Work ユーザーに表示されるワークフローの表示名を指定します。 |
|
Description
|
description | True | string |
ワークフローの説明を指定します。 |
|
ライブラリ ID
|
libraryId | True | string |
ワークフローを使用できるライブラリの ID を指定します。 |
|
フォーム ID
|
formId | True | string |
ワークフローで使用される入力を収集するためにユーザーに表示されるフォームの ID を指定します。 |
|
ユーザーが使用できる
|
users | string |
ワークフローを使用できる 1 つ以上のユーザー ID をセミコロンで区切って指定します。 |
|
|
グループで使用できる
|
groups | string |
ワークフローを使用できる 1 つ以上のグループ ID をセミコロンで区切って指定します。 |
|
|
完了を待つ
|
waitForCompletion | boolean |
アプリケーションがワークフローの実行を完了するまで待機するかどうかを指定します。 [はい] に設定した場合は、[ワークフロー状態の更新] アクションを使用する必要があります。 |
戻り値
定義
MinimalDocumentProfileInArray
ドキュメントの各バージョンのプロファイルを示します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Author
|
author | string |
ドキュメントを作成したユーザーの ID を示します。 たとえば、"JSMITH" などです。 |
|
作成者の説明
|
author_description | string |
ドキュメントの作成者に関する追加情報を示します。 |
|
基本的なドキュメントのプロパティ
|
basic_properties | string |
基本的なドキュメント プロパティを含む埋め込み可能な '' 要素を示します。 |
|
Document クラス
|
class | string |
ドキュメントのクラスを示します。 |
|
コメント
|
comment | string |
ドキュメントに関する追加情報を示します。 |
|
コンテンツ タイプ
|
content_type | string |
ドキュメント コンテンツ タイプを示します。 |
|
ドキュメントの作成日
|
create_date | string |
ドキュメントが iManage Work システムにインポートされた日付と時刻 (ISO 8601 形式) を示します。 この日付は 、'file_create_date' とは異なる場合があります。 |
|
Custom1
|
custom1 | string |
custom1 の値を示します。 |
|
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 Description
|
custom7_description | string |
custom7 プロパティに関する追加情報を示します。 |
|
Custom8
|
custom8 | string |
custom8 の値を示します。 |
|
Custom8 Description
|
custom8_description | string |
custom8 プロパティに関する追加情報を示します。 |
|
Custom9
|
custom9 | string |
custom9 の値を示します。 |
|
Custom9 の説明
|
custom9_description | string |
custom9 プロパティに関する追加情報を示します。 |
|
Custom10
|
custom10 | string |
custom10 の値を示します。 |
|
Custom10 Description
|
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 |
ISO 8601 datetime 形式の custom21 プロパティの値を示します。 |
|
Custom22
|
custom22 | string |
ISO 8601 datetime 形式の custom22 プロパティの値を示します。 |
|
Custom23
|
custom23 | string |
ISO 8601 datetime 形式の custom23 プロパティの値を示します。 |
|
Custom24
|
custom24 | string |
ISO 8601 datetime 形式の custom24 プロパティの値を示します。 |
|
Custom25
|
custom25 | boolean |
custom25 の値を示します。 |
|
Custom26
|
custom26 | boolean |
custom26 の値を示します。 |
|
Custom27
|
custom27 | boolean |
custom27 の値を示します。 |
|
Custom28
|
custom28 | boolean |
custom28 の値を示します。 |
|
Custom29
|
custom29 | string |
custom29 の値を示します。 |
|
Custom29 Description
|
custom29_description | string |
custom29 プロパティに関する追加情報を示します。 |
|
Custom30
|
custom30 | string |
custom30 の値を示します。 |
|
Custom30 Description
|
custom30_description | string |
custom30 プロパティに関する追加情報を示します。 |
|
データベース
|
database | string |
ドキュメントが格納されているライブラリを示します。 |
|
ドキュメントの既定のセキュリティ
|
default_security | string |
既定のセキュリティ アクセス レベルを示します。 指定できる値は、'inherit'、'private'、'view'、'public' です。 |
|
ドキュメント番号
|
document_number | integer |
ドキュメントのドキュメント番号を示します。 |
|
ドキュメント URL
|
document_url | string |
ドキュメントの共有可能なリンクを示します。 |
|
ドキュメントの編集日
|
edit_date | string |
ドキュメントに対する最新の変更の日付と時刻 (ISO 8601 形式) を示します。 |
|
プロファイルの編集日
|
edit_profile_date | string |
ドキュメント プロファイルに対する最新の変更の日付と時刻 (ISO 8601 形式) を示します。 |
|
ドキュメント拡張機能
|
extension | string |
ドキュメントのファイル名拡張子 (アプリケーション拡張子とも呼ばれます) を示します。 |
|
完全なファイル名
|
full_file_name | string |
ドキュメントの完全なファイル名を示します。 ファイル名拡張子が含まれます。 |
|
ドキュメント ID
|
id | string |
ドキュメントの ID を示します。 たとえば、'ACTIVE_US!453.1' などです。 |
|
インデックス可能
|
indexable | boolean |
ドキュメントがシステムによってインデックス付けされているかどうかを示します。 |
|
チェックアウト済み
|
is_checked_out | boolean |
ドキュメントがチェックアウトされているかどうかを示します。 |
|
Is Declared
|
is_declared | boolean |
ドキュメントがレコードとして宣言されているかどうかを示します。 レコードとして宣言されているドキュメントは、iManage Work システム管理者を除き、編集または削除できません。 |
|
外部
|
is_external | boolean |
ドキュメントが外部ユーザーと共有されているかどうかを示します。 |
|
Is 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 |
ドキュメントの種類を示します。 たとえば、Word for Microsoft 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 形式) を示します。 |
|
Email
|
string |
ユーザーの電子メール ID を示します。 |
|
|
Exchange 自動検出 URL
|
exch_autodiscover | string |
ユーザーの Exchange サーバーの詳細を示します。 |
|
Extension
|
extension | string |
ユーザーの電話番号の拡張子を示します。 |
|
失敗したログオン試行
|
failed_logins | integer |
ユーザーの現在の失敗したサインイン試行回数を示します。 |
|
ファクス
|
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 | string |
ユーザーの電話番号を示します。 |
|
優先ライブラリ
|
preferred_library | string |
優先ライブラリを示します。 優先ライブラリは、ユーザーの既定のライブラリです。 各ユーザーには、1 つの優先ライブラリが必要です。 |
|
パスワードの変更時刻
|
pwd_changed_ts | string |
ユーザーのパスワードが最後に変更された時刻 (ISO 8601 datetime 形式) を示します。 これは、仮想ユーザー (ユーザー NOS が 2) にのみ適用されます。 |
|
SSID
|
ssid | string |
ユーザーの一意のシステム生成 ID を示します。 |
|
ユーザーのドメイン
|
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 を示します。 |
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 形式) を示します。 |
|
Email
|
string |
ユーザーの電子メール ID を示します。 |
|
|
Exchange 自動検出 URL
|
exch_autodiscover | string |
ユーザーの Exchange サーバーの詳細を示します。 |
|
Extension
|
extension | string |
ユーザーの電話番号の拡張子を示します。 |
|
失敗したログオン試行
|
failed_logins | integer |
ユーザーの現在の失敗したサインイン試行回数を示します。 |
|
ファクス
|
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 | string |
ユーザーの電話番号を示します。 |
|
優先ライブラリ
|
preferred_library | string |
優先ライブラリを示します。 優先ライブラリは、ユーザーの既定のライブラリです。 各ユーザーには、1 つの優先ライブラリが必要です。 |
|
パスワードの変更時刻
|
pwd_changed_ts | string |
ユーザーのパスワードが最後に変更された時刻 (ISO 8601 datetime 形式) を示します。 これは、仮想ユーザー (ユーザー NOS が 2) にのみ適用されます。 |
|
SSID
|
ssid | string |
ユーザーの一意のシステム生成 ID を示します。 |
|
ドメイン
|
user_domain | string |
ユーザーのディレクトリ サービスの完全修飾ドメイン名を示します。 |
|
拡張ユーザー ID
|
user_id_ex | string |
Microsoft Active Directory (ADFS) などの外部ディレクトリから受信したユーザー ID の元の値を示します。 |
|
NOS
|
user_nos | integer |
ユーザーの同期元のオペレーティング システムの種類を示します。 指定できる値は、2 (仮想ユーザー) と 6 (エンタープライズ ユーザー) です。 詳細については、iManage Work システム管理者にお問い合わせください。 |
|
Number
|
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 形式) を示します。 |
|
有効
|
enabled | boolean |
ノード値が有効かどうかを示します。 |
|
ID
|
id | string |
ノード値の表示識別子を示します。 |
|
SSID
|
parent.ssid | string |
直接の親ノードの一意のシステム生成 ID を示します。 |
|
SSID
|
ssid | string |
ノード値の一意のシステム生成 ID を示します。 |
|
経路
|
path | array of object |
ノード値への完全パスを示します。 パスは、分類の最上位ノードから始まり、一致するノードの直接の親までのすべてのノードから順に並べ替えられたリストです。 |
|
各 ID
|
path.id | string |
パス内のノード値の表示識別子を示します。 |
|
各 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 (読み取り)、2 (read_write) または 3 (full_access) です。 |
|
外部
|
is_external | boolean |
ユーザーが外部ユーザーかどうか、またはグループが外部ユーザーに制限されているかどうかを示します。 |
|
ログオンを許可する
|
allow_logon | boolean |
ユーザーがログオンを許可されているかどうかを示します。 グループには適用されません。 |
|
有効
|
enabled | boolean |
グループが有効かどうかを示します。 ユーザーには適用されません。 |
|
制限付きメンバーを持つ
|
has_restricted_member | boolean |
グループに、iManage セキュリティ ポリシー マネージャーによって拒否されたこのオブジェクトへのアクセス権を持つユーザーが少なくとも 1 人存在するかどうかを示します。 |
オブジェクト
これは型 'object' です。
binary
これは基本的なデータ型 'binary' です。