Salesforce · JSON Structure

Salesforce Bulk 2 Ingest Job Info Structure

Detailed information about a Bulk API 2.0 ingest job, including its current state and processing statistics.

Type: object Properties: 17
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

IngestJobInfo is a JSON Structure definition published by Salesforce, describing 17 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

id operation object state createdDate systemModstamp numberRecordsProcessed numberRecordsFailed totalProcessingTime errorMessage contentType lineEnding columnDelimiter externalIdFieldName jobType createdById apiVersion

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "Detailed information about a Bulk API 2.0 ingest job, including its current state and processing statistics.\n",
  "name": "IngestJobInfo",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the ingest job."
    },
    "operation": {
      "type": "string",
      "description": "The DML operation being performed by this job.",
      "enum": [
        "insert",
        "update",
        "upsert",
        "delete",
        "hardDelete"
      ]
    },
    "object": {
      "type": "string",
      "description": "The API name of the SObject type being processed."
    },
    "state": {
      "type": "string",
      "description": "The current state of a Bulk API 2.0 job, indicating where it is in its lifecycle.\n",
      "enum": [
        "Open",
        "UploadComplete",
        "InProgress",
        "JobComplete",
        "Failed",
        "Aborted"
      ]
    },
    "createdDate": {
      "type": "datetime",
      "description": "The date and time the job was created, in ISO 8601 format."
    },
    "systemModstamp": {
      "type": "datetime",
      "description": "The date and time the job was last modified, in ISO 8601 format.\n"
    },
    "numberRecordsProcessed": {
      "type": "integer",
      "description": "The number of records processed so far. Updated after processing completes.\n"
    },
    "numberRecordsFailed": {
      "type": "integer",
      "description": "The number of records that failed during processing."
    },
    "totalProcessingTime": {
      "type": "integer",
      "description": "Total processing time in milliseconds."
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message if the job reached the Failed state. Describes the reason for failure.\n"
    },
    "contentType": {
      "type": "string",
      "description": "The content type of the data uploaded to this job.",
      "enum": [
        "CSV"
      ]
    },
    "lineEnding": {
      "type": "string",
      "description": "The line ending used in the uploaded data.",
      "enum": [
        "LF",
        "CRLF"
      ]
    },
    "columnDelimiter": {
      "type": "string",
      "description": "The column delimiter used in the uploaded data.",
      "enum": [
        "COMMA",
        "TAB",
        "PIPE",
        "SEMICOLON",
        "CARET",
        "BACKQUOTE"
      ]
    },
    "externalIdFieldName": {
      "type": "string",
      "description": "The external ID field name used for upsert operations. Only present for upsert jobs.\n"
    },
    "jobType": {
      "type": "string",
      "description": "The job type (V2Ingest for Bulk API 2.0 ingest jobs)."
    },
    "createdById": {
      "type": "string",
      "description": "The Salesforce user ID of the user who created the job."
    },
    "apiVersion": {
      "type": "number",
      "description": "The API version used to create the job."
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}