Skip to content
View as Markdown
View as Markdown

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

Interface: ExecuteJobScapiOptions

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/scapi-ops.ts:96

Options for executing a job.

Extends

Properties

body?

optional body: Record<string, unknown>

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run.ts:54

Raw request body (for system jobs with non-standard schemas like sfcc-search-index-*)

Inherited from

ExecuteJobOptions.body


parameters?

optional parameters: object[]

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run.ts:52

Job parameters to pass (standard jobs)

Inherited from

ExecuteJobOptions.parameters


tenantId

tenantId: string

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/scapi-ops.ts:98

Tenant ID for organization path param. Required.


waitForRunning?

optional waitForRunning: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/jobs/run.ts:56

Wait for running jobs to finish before starting (default: true)

Inherited from

ExecuteJobOptions.waitForRunning

Released under the Apache-2.0 License.