@salesforce/b2c-tooling-sdk / operations/jobs / SystemJobSpec
Interface: SystemJobSpec
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:77
Declarative description of a system job to run. The operation supplies its job ID and the two request-body forms; this module drives the rest.
Properties
deprecatedScopes?
optionaldeprecatedScopes:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:94
Scopes named in the OCAPI-deprecation error (the rw jobs scope).
failVerb
failVerb:
string
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:100
Human-readable verb for error messages, e.g. 'execute import job'.
jobId
jobId:
string
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:79
System job ID, e.g. sfcc-site-archive-import.
ocapiBody
ocapiBody:
Record<string,unknown>
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:86
OCAPI "shorthand" request body tried first on the OCAPI path (e.g. {file_name}, {export_file, data_units}, or the CAP {app_name, ...} shape). When the instance rejects it with UnknownPropertyException, the OCAPI path retries with parameters.
parameters
parameters:
object[]
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:92
Job parameters ([{name, value}]). Used as the OCAPI internal-user retry body and as the SCAPI request body (SCAPI's JobExecutionRequest accepts exactly this shape).
name
name:
string
value
value:
string
wait?
optionalwait:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:96
Whether to wait for completion (default true).
waitOptions?
optionalwaitOptions:WaitForJobOptions
Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:98
Wait options forwarded to the poll loop.