CreateJob
Add a Salesforce object entry.
Input
Name | Type | Description |
ObjectName | String | Name of the object to be used for the job (i.e., Account, Campaign, Event, etc.) |
Action | String | Type of action to use in the job. For example, insert, update, upsert, delete or query. |
ConcurrencyMode | String | The concurrency mode for the job. The valid values are Parallel or Serial. Parallel: Process batches in parallel mode. This is the default value. Serial: Process batches in serial mode. Processing in parallel can cause database contention. When this is severe, the job may fail. If you experience this issue, submit the job with serial concurrency mode. This guarantees that batches are processed one at a time. Note that using this option may significantly increase the processing time for a job.
The allowed values are Parallel, Serial. The default value is Parallel. |
ContentType | String | The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
The default value is XML. |
ExternalIdColumn | String | Specifies the external Id column to use if performing an upsert. |
ChunkSize | String | Salesforce recommends that you enable chunking when querying tables with more than 10 million records or when a bulk query consistently times out. If chunksize is specified the query is split into multiple batches. Use this paramter only if action value is query. |
Result Set Columns
Name | Type | Description |
ID | String | The Id of the job created. |
JobID | String | The Id of the job. |
ObjectName | String | The name of the object to be used with the job. |
Operation | String | The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete. |
ApiVersion | String | The API version of the job set in the URI when the job was created. The earliest supported version is 17.0. |
ApexProcessingTime | String | The number of milliseconds taken to process triggers and other processes related to the job data. This is the sum of the equivalent times in all batches in the job. This does not include the time used for processing asynchronous and batch Apex operations. If there are no triggers, the value is 0. This field is available in API version 19.0 and later. |
ApiActiveProcessingTime | String | The number of milliseconds taken to actively process the job. This value includes ApexProcessingTime but not the time the job waited in the queue to be processed or the time required for serialization and deserialization. This is the sum of the equivalent times in all batches in the job. This field is available in API version 19.0 and later. |
AssignmentRuleId | String | The Id of a specific assignment rule to run for a case or a lead. The assignment rule can be active or inactive. |
ConcurrencyMode | String | The concurrency mode for the job. The valid values are: parallel and serial. |
ContentType | String | The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML. |
CreatedById | String | Id of the user who created the job. |
CreatedDate | String | Date the job was created. |
ExternalIdFieldName | String | The name of the external Id field for an upsert. |
NumberBatchesCompleted | String | The number of batches that have been completed for this job. |
NumberBatchesQueued | String | The number of batches queued for this job. |
NumberBatchesFailed | String | The number of batches that have failed for this job. |
NumberBatchesInProgress | String | The number of batches that are in progress for this job. |
NumberBatchesTotal | String | The number of total batches currently in the job. This value increases as more batches are added to the job. When the jobstate is Closed or Failed, this number represents the final total. The job is complete when NumberBatchesTotal equals the sum of NumberBatchesCompleted and NumberBatchesFailed. |
NumberRecordsFailed | String | The number of records that were not processed successfully in this job. This field is available in API version 19.0 and later. |
NumberRecordsProcessed | String | The number of records already processed. This number increases as more batches are processed. |
NumberRetries | String | The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention. |
State | String | The state of the job. For example, Open, Closed, Aborted, or Failed. |
SystemModStamp | String | Date and time in the UTC time zone when the job finished. |
TotalProcessingTime | String | The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later. |