Global Jobs

There are several global jobs you can use.

Full Active Data Index Update 

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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-active-data-full-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if a full active data index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-content-full-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if a full content index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-product-full-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if a full product index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-active-data-incremental-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if an incremental active data index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-content-incremental-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if an incremental content index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-search-index-content-incremental-update/executions
Request DocumentSearchIndexUpdateConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400MissingSiteScopeParameterExceptionif the site scope parameter is missing
400InvalidSiteScopeParameterExceptionsiteScopeValue (String)if the site scope parameter is empty or contains an invalid site id
400JobAlreadyRunningExceptionjobId (String)if an incremental product index update job is already running for any other site scope
403UserAccessForbiddenExceptionmethod (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.

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-site-archive-export/executions
Request DocumentSiteArchiveExportConfiguration
Response DocumentJobExecution

Site Archive Import 

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

Job ValueDescription
URLPOST https://hostname:port/dw/data/v24_5/jobs/sfcc-site-archive-import/executions
Request DocumentSiteArchiveImportConfiguration
Response DocumentJobExecution

Faults

StatusTypeArgumentsDescription
400FileNotExistsExceptionfilePath (String)if the import file doesn’t exist

Attention!

The Open Commerce API (OCAPI) is now deprecated. The provisions described in our versioning and deprecation policy fully apply. For all new projects and major refactoring work, use B2C Commerce API (SCAPI) as the default REST API. For additional details, refer to Why Use SCAPI Instead of OCAPI.