GuideReference
TrainingSupportCommunity

ecms_​dataset


Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the ecms​_database behavior to specify a default database for requests.

OptionTypeDescriptionRequires
datasetstring

Specifies a default data set for this property. If you don't configure a default database in the ecms​_database behavior, requests to objects in this data set follow the pattern: <hostname>/datastore/<database_name>/<object_key>.

{"displayType":"string","tag":"input","type":"text"}
extract_​locationenum

Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.

{"displayType":"enum","options":["CLIENT_REQUEST_HEADER","QUERY_STRING","REGEX"],"tag":"select"}
CLIENT_​REQUEST_​HEADER

Name is a request header.

QUERY_​STRING

Name is a query parameter.

REGEX

Name matches the URL.

header_​namestring

Specifies the request header that passed the data set name. By default, it points to X-KV-Dataset.

extract_​location is CLIENT_​REQUEST_​HEADER
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"extractLocation","op":"eq","value":"CLIENT_REQUEST_HEADER"}}
query_​parameter_​namestring

Specifies the query string parameter that passed the data set name. By default, it points to dataset.

extract_​location is QUERY_​STRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"extractLocation","op":"eq","value":"QUERY_STRING"}}
regex_​patternstring

Specifies the regular expression that matches the data set name in the URL.

extract_​location is REGEX
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"extractLocation","op":"eq","value":"REGEX"}}