---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/jobs](../index.md) / SystemJobSpec

# Interface: SystemJobSpec

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L77)

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?

> `optional` **deprecatedScopes**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L94)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L100)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L79)

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](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L86)

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

> **parameters**: `object`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:92](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L92)

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?

> `optional` **wait**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:96](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L96)

Whether to wait for completion (default `true`).

***

### waitOptions?

> `optional` **waitOptions**: [`WaitForJobOptions`](WaitForJobOptions.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts:98](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/jobs/run-system-job.ts#L98)

Wait options forwarded to the poll loop.