An optimized Oracle Commerce Guided Search URL is made up of four configurable sections.
When referring to URLs in general, the API documentation may use the terms "base URL" and "URL query parameters." The "base URL" is the part of the URL that precedes the question mark.
For example, in the URL:
http://www.example.com/pathparam1/pathparam2/pathparam3/results?queryparam=123
the base URL is the string that appears before the question mark:
http://www.example.com/pathparam1/pathparam2/pathparam3/results
For reference purposes, the documentation identifies four distinct sections of optimized URLs:
For example, the following URL is broken down into subsections:
http://localhost:8888/controller[/Wine-Red-Merlot/Napa/Pine-Ridge/_/N-12ZafZfd?Ne=123]
The sections of the URL encased in square brackets can be broken down into the following components:
[/<misc-path>][/<path-param-separator>][/<path-params>][?<query-string>]
The components correspond to the following strings:
|
Section |
String |
|---|---|
|
misc-path |
Wine-Red-Merlot/Napa/Pine-Ridge |
|
path-param-separator |
_ |
|
path-params |
N-12ZafZfd |
|
query string |
Ne=123 |
This section of the URL incorporates keywords into the URL in order to create user-friendly and search engine-optimized URLs. The misc-path section of the optimized URL can be generated based on dimension names, dimension values, ancestor names, and record properties. The misc-path component is largely ignored by the application.
The path-param-separator component is used to identify the end of the misc-path and the starting point for path parameters. This string is configurable.
Together with the query string, the path-params segment of the URL
represents the current state of the application. This may include the numerical
representation of the navigation state or a specific record, as well as any
other parameter key-value pairs that have an effect on the displayed content.
This component can be configured to contain several parameters that would
typically be included as part of the query string in traditional URLs, such as
the
N,
Ne,
Ntt, and
R parameters.
The query string component of the URL follows the question mark
character. The combination of the path-params and query string represents the
current state of the application. parameters that are not configured to appear
in the path-params section of the URL – such as
N,
Ne,
Ntt, and
R – appear in the query string.
