JobExecutionParameter document (Data API 20.10)

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 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.