CreateBatch
Salesforce バッチを作成します。
テーブル固有の情報
バッチを作成するには、バッチの追加先のジョブID と、バッチ自体のXML 集計を指定します。例えば、XML 集計は次のようになります。
<?xml version="1.0" encoding="UTF-8"?>
<sObjects xmlns="http://www.force.com/2009/06/asyncapi/dataload" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<sObject>
<FirstName>Bill</FirstName>
<LastName>White</LastName>
</sObject>
<sObject>
<FirstName>Bob</FirstName>
<LastName>Black</LastName>
</sObject>
</sObjects>
Note：XML 集計に含まれるオブジェクトはすべて、使用されているジョブに関連付けられたオブジェクトに対応している必要があります。
Input
| Name | Type | Description |
| JobId | String | バッチの追加先のジョブのID。 |
| Aggregate | String | 追加されるオブジェクトの集計。バッチクエリを実行する場合に使用するクエリを指定します。 |
| ContentType | String | ジョブのコンテンツタイプ。有効な値は：CSV、XML、ZIP_CSV、およびZIP_XML です。バッチクエリを実行する場合には、値をCSV に設定します。
The default value is XML. |
Result Set Columns
| Name | Type | Description |
| ID | String | バッチのID。 |
| JobID | String | ジョブのID。 |
| ApexProcessingTime | String | バッチデータに関連するトリガやその他のプロセスの処理にかかったミリ秒数。トリガがない場合、この値は0です。これには、非同期およびバッチのApex 操作を処理する時間は含まれません。ApiActiveProcessingTime およびTotalProcessingTime も参照してください。このフィールドは、API バージョン19.0以降で使用できます。 |
| ApiActiveProcessingTime | String | バッチの処理にかかったミリ秒数。これには、apexProcessingTime が含まれます。バッチがキューで処理を待機した時間や、シリアライズおよびデシリアライズに必要な時間は含まれません。TotalProcessingTime も参照してください。このフィールドは、API バージョン19.0以降で使用できます。 |
| CreatedDate | String | バッチが作成されたときのUTC タイムゾーンでの日時。これは、処理が開始された時刻ではなく、バッチがジョブに追加された時刻です。 |
| NumberRecordsFailed | String | このバッチに関連付けられたジョブを表す18文字の一意のID。 |
| NumberRecordsProcessed | String | 要求が送信されたときに、このバッチで処理済みのレコードの数。この数は、バッチの処理が進むにつれて増加します。 |
| State | String | バッチの処理の現在の状態。例えば、Queued、InProgress、Completed、Failed、Not Processed などです。 |
| StateMessage | String | 状態に関する詳細が含まれます。例えば、状態値がFailed の場合、このフィールドには失敗の理由が含まれます。失敗が複数ある場合は、メッセージが切り捨てられることがあります。その場合は、判明したエラーを修正し、バッチを再送信してください。バッチが失敗しても、一部のレコードは正常に完了します。 |
| SystemModstamp | String | 処理が終了したUTC タイムゾーンでの日時。これは、状態がCompleted の場合にのみ有効です。 |
| TotalProcessingTime | String | バッチの処理にかかったミリ秒数。これには、バッチがキューで処理を待機した時間は含まれません。ApexProcessingTime およびApiActiveProcessingTime も参照してください。このフィールドは、API バージョン19.0以降で使用できます。 |