JobExecutionParameter document (Data API 23.2)

Specification of a parameter for a job execution.

Request example to execute the job in all storefront sites:
 POST /dw/data/v19_10/jobs/CustomerImportJob/executions
 Host: example.com
 Authorization: Bearer af7f5c90-ffc1-4ea4-9613-f5b375b7dc19
 Content-Type: application/json; charset=UTF-8
 {
    "parameters": [
       {
           "name": "SiteScope",
           "value": "{\"all_storefront_sites\":true}"
       }
    ]
 }
 
Request example to execute the job in specified sites only:
 POST /dw/data/v19_10/jobs/CustomerImportJob/executions
 Host: example.com
 Authorization: Bearer af7f5c90-ffc1-4ea4-9613-f5b375b7dc19
 Content-Type: application/json; charset=UTF-8
 {
    "parameters": [
       {
           "name": "SiteScope",
           "value": "{\"named_sites\":[\"SiteGenesis\", \"SiteGenesisGlobal\"]}"
       }
    ]
 }
 
Property Type Constraints Description
name String mandatory=true, maxLength=256, minLength=1, nullable=false, regex=\S|(\S(.*)\S) The name of the parameter.
value String mandatory=true, maxLength=1000, minLength=0, nullable=false, regex=\S|(\S(.*)\S) The value of the parameter.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
Notifications pending to read 9