{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "BackgroundOperation - Data API",
  "description": "Represents a background operation in an asynchronous job queue. This object is available in API version 35.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "Error": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The error message for the operation. Applies only if the operation has an error status."
    },
    "ExecutionGroup": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Identifies the execution group."
    },
    "ExpiresAt": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "After this time, the operation is removed from the asynchronous job queue. Applies only if the operation has a status of complete, canceled, error, or merged."
    },
    "FinishedAt": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "When the operation reached the status of completed or error."
    },
    "GroupLeaderId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Identifies the operation that’s selected as the leader of the execution group. This field is a relationship field.",
      "relationship_name": "GroupLeader",
      "relationship_type": "Lookup",
      "refers_to": "BackgroundOperation"
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "Identifies the background operation."
    },
    "NumFollowers": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Number of other operations that are in the execution group."
    },
    "ParentKey": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable, Sort",
      "description": "Tag that identifies related sets of operations, if any."
    },
    "ProcessAfter": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The operation is scheduled to be processed after this time."
    },
    "RetryBackoff": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Applies only if the operation has an error status. The first retry is attempted immediately. Each subsequent retry is increasingly delayed according to an exponential expression that’s multiplied by the RetryBackoff, in milliseconds.Specifically, the delay time is (2n-1)×R, where n is the RetryCount, and R is the RetryBackoff. The default value for RetryBackoff depends on the type of operation. For example, the RetryBackoff default for write operations on external objects is 1,000 milliseconds. For write operations, retries are attempted immediately, after 3 seconds, after 7 seconds, after 15 seconds, and so on."
    },
    "RetryCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Number of attempted retries. Applies only if the operation has an error status."
    },
    "RetryLimit": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Maximum number of retries to attempt. Applies only if the operation has an error status."
    },
    "SequenceGroup": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Identifies the sequence group. Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Within an execution group, operations can be placed into a sequence group to be executed in a specific order."
    },
    "SequenceNumber": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Order position within the sequence group. Applies only if the operation is merged with other operations into an execution group to be processed in bulk. Within an execution group, operations can be placed into a sequence group to be run in a specific order."
    },
    "StartedAt": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "When the operation started running."
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Status of the background operation. The options are: New Scheduled Canceled Merged Waiting Running Error Complete"
    },
    "SubmittedAt": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "When the operation was added to the job queue."
    },
    "Timeout": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Maximum time in milliseconds to wait for results after the operation started running."
    },
    "Type": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Type of the background operation. The options are: ApiCatalogPoller BlockchainEventPoller CdpMetadataDeploy ExternalChangeDataCapture ExternalConnectivityPoller ExternalObject ExternalObjectSync ExternalServiceCallback MetadataChangesetOperation MfgBulkUpdate PrivateConnectMigration SingularityAutoSync SingularityMDSSync SingularitySchemaEvolutionTrigger SiteTaskCreate SiteTaskPublish Sweeper WebCart XClean"
    },
    "WorkerUri": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable, Sort",
      "description": "URI of the worker that performed the operation.Example for a Salesforce Connect OData operation: services/data/v35.0/xds/upsert"
    }
  },
  "usage": "Use the BackgroundOperation object to:",
  "wsdl_segment": "```xml\n<complexType name=\"BackgroundOperation\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Error\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ExecutionGroup\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ExpiresAt\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"FinishedAt\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"GroupLeader\" nillable=\"true\" minOccurs=\"0\" type=\"ens:BackgroundOperation\"/>\n        <element name=\"GroupLeaderId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MergedOperations\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NumFollowers\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"ParentKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ProcessAfter\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"RetryBackoff\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"RetryCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"RetryLimit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"SequenceGroup\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SequenceNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"StartedAt\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SubmittedAt\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Timeout\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n        <element name=\"WorkerUri\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Error": {
      "field_label": "Error Message",
      "type": "string",
      "length": "255"
    },
    "ExecutionGroup": {
      "field_label": "Execution Group",
      "type": "string",
      "length": "255"
    },
    "ExpiresAt": {
      "field_label": "Expires",
      "type": "datetime"
    },
    "FinishedAt": {
      "field_label": "Finished",
      "type": "datetime"
    },
    "GroupLeaderId": {
      "field_label": "Background Operation ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Background Operation ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "NumFollowers": {
      "field_label": "Num Followers",
      "type": "int",
      "digits": "9"
    },
    "ParentKey": {
      "field_label": "Parent Key",
      "type": "string",
      "length": "255"
    },
    "ProcessAfter": {
      "field_label": "Process After",
      "type": "datetime"
    },
    "RetryBackoff": {
      "field_label": "Retry Backoff",
      "type": "int",
      "digits": "9"
    },
    "RetryCount": {
      "field_label": "Retry Count",
      "type": "int",
      "digits": "9"
    },
    "RetryLimit": {
      "field_label": "Retry Limit",
      "type": "int",
      "digits": "9"
    },
    "SequenceGroup": {
      "field_label": "Sequence Group",
      "type": "string",
      "length": "255"
    },
    "SequenceNumber": {
      "field_label": "Sequence Number",
      "type": "int",
      "digits": "9"
    },
    "StartedAt": {
      "field_label": "Started",
      "type": "datetime"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SubmittedAt": {
      "field_label": "Submitted",
      "type": "datetime"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Timeout": {
      "field_label": "Timeout",
      "type": "int",
      "digits": "9"
    },
    "Type": {
      "field_label": "Type",
      "type": "picklist",
      "length": "255"
    },
    "WorkerUri": {
      "field_label": "Worker URI",
      "type": "string",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}