Global Jobs

Full Active Data Index Update

This job builds all active data related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-active-data-full-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a full active data index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to build active data related search indexes for all sites of the site scope

Full Content Index Update

This job builds all content related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-content-full-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a full content index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to build content related search indexes for all sites of the site scope

Full Product Index Update

This job builds all product related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-product-full-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a full product index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to build product related search indexes for all sites of the site scope

Incremental Active Data Index Update

This job updates all active data related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-active-data-incremental-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a incremental active data index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to update active data related search indexes for all given sites

Incremental Content Index Update

This job updates all content related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-content-incremental-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a incremental content index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to build content related search indexes for all sites of the site scope

Incremental Product Index Update

This job updates all product related search indexes for the given site scope

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-search-index-product-incremental-update/executions
Request Document: SearchIndexUpdateConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >MissingSiteScopeParameterException   if the site scope parameter is missing
400 >InvalidSiteScopeParameterException

siteScopeValue (String)

if the site scope parameter is empty or contains an invalid site id
400 >JobAlreadyRunningException

jobId (String)

if a incremental product index update job is already running for any other site scope
403 >UserAccessForbiddenException

method (String)

path (String)

if the user doesn't have permission to build product related search indexes for all sites of the site scope

Site Archive Export

This job is for executing a site export to an archive file based on data unit configuration in json format.

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-site-archive-export/executions
Request Document: SiteArchiveExportConfiguration
Response Document: JobExecution

Site Archive Import

This job is for importing a whole site import ZIP file. Note that the file is specified by its simple file name and must be already uploaded to the server. You may specify an import mode, where currently only 'merge' is supported.

URL: POST https://hostname:port/dw/data/v20_10/jobs/sfcc-site-archive-import/executions
Request Document: SiteArchiveImportConfiguration
Response Document: JobExecution

Faults

Status Type Arguments Description
400 >FileNotExistsException

filePath (String)

if the import file is not existent
X OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.