Veeva Vault Connector 1.2 リファレンス - Mule 4
設定する操作に応じて、Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) は Veeva Vault REST API、Bulk API、ストリーミング API と連動します。
接続設定
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Name (名前) |
String (文字列) |
この設定の名前。コネクタはこの名前の設定を参照します。 |
X |
|
Vault URL |
String (文字列) |
接続に必要な Veeva Vault インスタンスの URL。 |
X |
|
Username (ユーザー名) |
String (文字列) |
セッションの初期化に使用するユーザー名。 |
X |
|
Password (パスワード) |
String (文字列) |
ユーザーの認証に使用するパスワード。 |
X |
|
Version (バージョン) |
String (文字列) |
Veeva Vault API バージョン。 |
v20.1 |
|
Client Id (クライアント ID) |
String (文字列) |
追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID。形式は |
X |
応答タイムアウト ([Advanced (詳細)] タブ)
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Response Timeout (応答タイムアウト) |
Integer (整数) |
コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この時間が経過すると、 |
|
X |
Burst API Limit Profile (バースト API 制限プロファイル) ([Advanced (詳細)] タブ)
<veevavault:burst-api-limit-profile/>
[Burst API Limit Profile (バースト API 制限プロファイル)] 設定は、Veeva Vault API の指定されたバースト API 制限が、設定されたしきい値に達するか、超えた場合に機能します。
[Burst API limit config (バースト API 制限の設定)] が有効になっている場合 (デフォルト)、コネクタは、指定された API 制限しきい値に対して Veeva Vault API のレスポンスヘッダー (X-VaultAPI-BurstLimitRemaining) 値を評価します。残りのバースト API 制限がこのしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機して [Burst Limit Remaining (残りのバースト制限)] の計数を再開します。
詳細は、 「API Rate Limit Headers (API レート制限ヘッダー)」を参照してください。
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
API Limit Threshold (API 制限しきい値) |
Integer (整数) |
Veeva Vault API しきい値制限を入力します。このしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機します。 |
|
X |
Wait Time (待機時間) |
Integer (整数) |
しきい値に達したか、しきい値が残りの API コール数を超えた場合にコネクタが待機する時間。 |
|
X |
Time Unit (時間単位) |
|
|
X |
Daily API Limit Profile (1 日の API 制限プロファイル) ([Advanced (詳細)] タブ)
<veevavault:daily-api-limit-profile/>
[Daily API Limit Profile (1 日の API 制限プロファイル)] では、1 日の残りの API 制限コール数を評価するための API 制限しきい値を設定します。1 日の API 制限コール数が、指定されたしきい値制限に達するかしきい値制限を超えた場合、例外がスローされます。デフォルトでは、これは無効になっています。詳細は、「API Rate Limit Headers (API レート制限ヘッダー)」を参照してください。
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
API Limit Threshold (API 制限しきい値) |
Integer (整数) |
[API Limit Threshold (API 制限しきい値)] では、許容される 1 日の API コール数の制限を設定します。しきい値に達すると、コネクタは、API コールを呼び出す要求ごとに |
|
X |
操作
Create Documents
<veevavault:create-documents>
この操作では、CSV または JSON 形式で提供されたドキュメントメタデータを使用して Veeva Vault でドキュメントを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列):
|
メタデータ形式 (CSV または JSON)。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Create Document Renditions
<veevavault:create-document-renditions>
CSV または JSON 形式で提供されたメタデータを使用して Vault でドキュメントレンディションを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列)
|
メタデータ形式 (CSV または JSON)。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Create Object Records
<veevavault:create-object-records>
Create Object Records では、CSV または JSON 形式のオブジェクトメタデータを使用して、Vault でオブジェクトレコードを一括で作成します。
パラメーター
名前 |
型 |
説明 |
デフォルト値 |
必須 |
Object Name (オブジェクト名) |
String (文字列) |
リストから選択可能なすべての Vault オブジェクトのリスト。次に例を示します。 
|
X |
|
Metadata Format (メタデータ形式) |
String (文字列) |
メタデータ形式 (CSV または JSON)。 |
X |
|
Object Metadata (オブジェクトメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。次の画像でメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Delete Document Renditions
<veevavault:delete-document-renditions>
CSV または JSON 形式で提供されたドキュメントレンディションメタデータに基づいて Vault からドキュメントレンディションを削除します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列)
|
CSV または JSON のメタデータ形式。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。 |
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Delete Documents
<veevavault:delete-documents>
この操作では、CSV または JSON 形式で提供されたメタデータドキュメント ID に基づいて Vault からドキュメントを削除します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列)
|
CSV または JSON のメタデータ形式。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Delete Object Records
<veevavault:delete-object-records>
この操作では、CSV または JSON 形式のオブジェクト ID メタデータを使用して、Vault でオブジェクトレコードを一括で削除します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Object Name (オブジェクト名) |
String (文字列) |
リストから選択可能なすべての Vault オブジェクトのリスト。次に例を示します。
|
X |
|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列) CSV JSON |
CSV または JSON のメタデータ形式。 |
X |
|
Object Metadata (オブジェクトメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。 |
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Export Documents
<veevavault:export-documents>
この操作を使用すると、Vault の FTP ステージングサーバーにエクスポートするための一連のドキュメントを照会できます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列)
|
CSV または JSON のメタデータ形式。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ (ドキュメント ID)。次の画像でメタデータを示します。 
|
#[payload] |
X |
Source (ソース) |
Boolean (ブール) |
ソースファイルを除外します。 |
|
|
Renditions (レンディション) |
Boolean (ブール) |
レンディションを含めます。 |
|
|
All Versions (すべてのバージョン) |
Boolean (ブール) |
すべてのバージョンまたは最新バージョンを含めます。 |
|
|
Polling Interval (ポーリング間隔) |
Integer (整数) |
ジョブが正常に終了するまで、指定した間隔 (秒単位) で Vault をポーリングします。 |
|
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Audit Type (監査種別) |
String (文字列) |
Vault での選択可能な監査種別のリスト。次に例を示します。 
|
X |
|
Start Date (開始日) |
String (文字列) |
監査情報の取得を開始する日付。日付は |
||
End Date (終了日) |
String (文字列) |
監査情報の取得を停止する日付。日付は |
||
Fetch Size (フェッチサイズ) |
Integer (整数) |
1 ページあたりのレコード数をこのフェッチサイズに制限します。 |
|
|
Batch Size (バッチサイズ) |
Integer (整数) |
指定されたバッチ数でのページ数に対応するバッチサイズ。 |
|
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Get Document Renditions Types
<veevavault:get-document-renditions>
Get Document Renditions Types では、ドキュメントレンディションの詳細を取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
ドキュメントメタデータには、CSV または JSON 形式の documentID のみが入力ストリームとして含まれます。次にメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Get Documents
<veevavault:get-documents>
Get Documents では、選択したドキュメント種別、サブタイプ、分類の各オプションに基づいて Vault からドキュメントの詳細を取得します。VQL クエリのビルドの基盤となるドキュメントプロパティを提供するオプションがありますが、提供しない場合、ドキュメントプロパティは種別、サブタイプ、分類に基づいてフェッチされます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
型 |
String (文字列) |
選択可能なすべてのドキュメント種別のリスト。 |
||
Subtype (サブタイプ) |
String (文字列) |
Vault での選択可能なすべてのドキュメントサブタイプのリスト。 |
||
Classification (分類) |
String (文字列) |
Vault での選択可能なすべてのドキュメント分類のリスト。 |
||
Document Properties (ドキュメントプロパティ) |
List<String> |
ビジネス要件に基づいてドキュメントプロパティをリストに挿入します。提供されていない場合、すべてのクエリ可能なドキュメントプロパティが選択されて VQL クエリがビルドされ、内部的に呼び出されてドキュメントの詳細が取得されます。 |
||
WHERE Clause (Where 句) |
String (文字列) |
WHERE 句を VQL クエリに追加して VQL クエリを動的にビルドできます。 |
||
Fetch Size (フェッチサイズ) |
Integer (整数) |
1 ページあたりのレコード数をこのフェッチサイズに制限します。 |
|
|
Batch Size (バッチサイズ) |
Integer (整数) |
指定されたバッチ数でのページ数に対応するバッチサイズ。 |
|
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Get Object Records
<veevavault:get-object-records>
Get Object Records では、CSV または JSON 形式のオブジェクト ID メタデータを使用して、Vault でオブジェクトレコードを一括で取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Object Name (オブジェクト名) |
String (文字列) |
選択可能なすべての Vault オブジェクトのリスト。次に例を示します。
|
X |
|
Object Fields (オブジェクト項目) |
List<String> |
ビジネス要件に基づいてオブジェクト項目をリストに挿入できます。提供されていない場合、使用可能なすべてのアクティブなオブジェクト項目が選択されて VQL クエリがビルドされ、内部的に呼び出されてオブジェクトレコードの詳細が取得されます。 |
||
WHERE Clause (Where 句) |
String (文字列) |
WHERE 句を VQL クエリに追加して VQL クエリを動的にビルドします。 |
||
Fetch Size (フェッチサイズ) |
Integer (整数) |
1 ページあたりのレコード数のフェッチサイズ制限。 |
100 |
|
Batch Size (バッチサイズ) |
Integer (整数) |
指定したバッチ数でのページ数に対応するバッチサイズ。 |
10 |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Invoke REST API
<veevavault:invoke-rest-api>
Invoke REST API 操作は、 Veeva Vault Rest API を呼び出し、ヘッダーで指定されている Accept 値に応じて JSON (デフォルト) または XML 形式で応答を返します。 API レート制限を超過しないように、REST API を個別に使用するのではなく、可能な限り一括で使用することが重要です。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Method (メソッド) |
String (文字列) |
REST API を呼び出すメソッドのリスト。
|
|
X |
Path (パス) |
String (文字列) |
要求を送信する URL パス
|
X |
|
Body (本文) |
Input Stream (入力ストリーム) |
要求 (GET メソッド要求以外) と一緒に送信される要求メッセージの本文。デフォルトはペイロードです。 |
#[payload] |
|
ヘッダー |
Map (マップ) |
要求と一緒に送信するキー-値形式のヘッダー。要求でヘッダーが必要ない場合は空白 (デフォルト) にしてください。
|
||
URI パラメーター |
Map (マップ) |
パスの値を解決するためのキー-値形式の URI パラメーター。パスに URI パラメーターがない場合は空白 (デフォルト) にしてください。
|
||
クエリパラメーター |
Map (マップ) |
要求と一緒に送信するキー-値形式のクエリパラメーター。要求でクエリパラメーターが必要ない場合は空白 (デフォルト) にしてください。
|
||
Request Streaming Mode (要求ストリーミングモード) |
Stream (ストリーム) |
ストリーミングモードで送信する要求。デフォルトでは、ペイロードの種別がストリームの場合、ストリーミングを使用して要求が送信されます。ドロップダウンリストから次のいずれかを選択します。
|
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Query
<veevavault:query>
Query 操作を使用して、指定した VQL クエリを Vault で実行し、ページネーション形式で結果を取得します。ページネーションは Veeva Vault の API に基づきます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
VQL Query (VQL クエリ) |
String (文字列) |
Veeva Vault の VQL 仕様に従って、実行する VQL クエリを定義します。詳細は、 VQL クエリのドキュメントを参照してください。次に例を示します。
|
X |
|
Input parameters (入力パラメーター) |
Map<String, Object> |
文字列とオブジェクトのマップ。この中の各項目が、挿入される行を表します。マップにはパラメーター名がキーとして含まれ、値はバインド先のパラメーターです。次に例を示します。 {
'table': 'site__v'
}
|
#[{}] |
|
Fetch Size (フェッチサイズ) |
Integer (整数) |
1 ページあたりのレコード数のフェッチサイズ制限。 |
100 |
|
Batch Size (バッチサイズ) |
Integer (整数) |
指定されたバッチ数でのページ数に対応するバッチサイズ。 |
10 |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Spark Validator
<veevavault:spark-message-validator>
Spark Validator 操作では、署名と、Vault から取得した公開キーを使用して Spark メッセージの検証と確認を行います。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Include Spark Headers (Spark ヘッダーを含める) |
Boolean (ブール) |
Spark ヘッダーを Spark メッセージ検証機能の出力に含めるためのフラグ。 |
FALSE |
|
Public Key Path (公開キーのパス) |
String (文字列) |
公開キー (00001.pem) ファイルを保存するディレクトリパス。指定しない場合、Vault から取得します。 |
|
|
Spark Headers (Spark ヘッダー) |
Object (オブジェクト) |
Vault から受信し、Spark メッセージに埋め込まれる属性ヘッダー。 |
#[attributes.headers] |
|
Spark Message (Spark メッセージ) |
Input Stream (入力ストリーム) |
Vault から受信した Spark 本文メッセージ。 |
#[payload] |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
-
VEEVAVAULT:INVALID_SPARK_MESSAGE
-
VEEVAVAULT:INVALID_KEY_FORMAT
Update Documents
<veevavault:update-documents>
Update Documents 操作では、CSV または JSON 形式で提供された編集可能なドキュメントメタデータを使用して Vault でドキュメントを更新します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列)
|
CSV または JSON のメタデータ形式。 |
X |
|
Document Metadata (ドキュメントメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしての編集可能なドキュメントメタデータ。次にメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED
Update Object Records
<veevavault:update-object-records>
Update Object Records では、CSV または JSON 形式の編集可能なオブジェクトメタデータを使用して、Vault でオブジェクトレコードを一括で更新します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Object Name (オブジェクト名) |
String (文字列) |
選択可能なすべての Vault オブジェクトのリスト。次に例を示します。
|
X |
|
Metadata Format (メタデータ形式) |
Enum (列挙) (文字列):
|
メタデータ形式 (CSV または JSON)。 |
X |
|
Object Metadata (オブジェクトメタデータ) |
Input Stream (入力ストリーム) |
選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。次にメタデータを示します。 
|
X |
スロー
-
VEEVAVAULT:API_LIMIT_EXCEEDED
-
VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED
-
VEEVAVAULT:INACTIVE_USER
-
VEEVAVAULT:INVALID_DATA
-
VEEVAVAULT:INVALID_DOCUMENT
-
VEEVAVAULT:INSUFFICIENT_ACCESS
-
VEEVAVAULT:MALFORMED_URL
-
VEEVAVAULT:METHOD_NOT_SUPPORTED
-
VEEVAVAULT:NO_PERMISSION
-
VEEVAVAULT:OPERATION_NOT_ALLOWED
-
VEEVAVAULT:PARAMETER_REQUIRED