@salesforce/b2c-tooling-sdk / operations/jobs

operations/jobs

Job execution operations for B2C Commerce.

SDK consumers should call SCAPI ops directly via the free functions exported from ./scapi-ops (or, for legacy code, the OCAPI free functions exported from ./run). The CLI's BackendDispatcher arbitrates between them based on the user's apiBackend preference; that policy lives in the CLI layer.

Ordered import sets are exported from ./import-set and continue to use the site-archive/WebDAV workflow.

Classes

• CanonicalJobExecutionError
• ImportSetStateError
• ScapiJobStartError

Interfaces

• ExecuteJobOptions
• ExecuteJobScapiOptions
• ExportableUnits
• ExportDataUnitsConfiguration
• ExportGlobalDataConfiguration
• ExportSitesConfiguration
• ImportSetItem
• ImportSetItemResult
• ImportSetLockOwner
• ImportSetReceipt
• ImportSetResult
• JobExecutionInfo
• JobExecutionSearchResult
• JobExecutionSearchResults
• JobStepExecutionResult
• SearchJobExecutionsOptions
• SearchJobExecutionsScapiOptions
• SiteArchiveExportOptions
• SiteArchiveExportResult
• SiteArchiveImportOptions
• SiteArchiveImportResult
• SiteArchiveImportSetOptions
• SiteArchiveImportSplitOptions
• SplitImportPartInfo
• SplitImportPlanInfo
• SystemJobSpec
• WaitForJobOptions
• WaitForJobPollInfo

Type Aliases

• ImportSetEvent
• JobExecution
• JobExecutionParameter
• JobExecutionStatus
• JobStepExecution

Functions

• discoverExportableUnits
• discoverImportSet
• executeJob
• findRunningJobExecution
• getJobErrorMessage
• getJobExecution
• getJobLog
• mapCanonicalToOcapiExecution
• mapOcapiExecution
• mapOcapiSearchResult
• runSystemJob
• scapiDeleteJobExecution
• scapiExecuteJob
• scapiGetJobExecution
• scapiGetJobLog
• scapiSearchJobExecutions
• searchJobExecutions
• siteArchiveExport
• siteArchiveExportToBuffer
• siteArchiveExportToPath
• siteArchiveImport
• siteArchiveImportSet
• siteArchiveImportSplit
• waitForJob
• waitForJobExecution

References

JobExecutionError

Re-exports JobExecutionError