Resources are identified by URIs. This topic explains how to use URIs when working with the ALM Octane REST API.
Resources are identified by URIs:
URIs are used to uniquely identify ALM Octane resources.
URIs are case sensitive, including entity and field names. For example, the field id is correct, but ID is incorrect.
URIs have the following generic syntax:
<scheme name>:<hierarchical identifier>[?<query>]
Note: For the syntax for specifying parameters in URIs, see Variables and values.
Scheme is mandatory.
The http/https schemes are the only ones supported.
The hierarchical identifier is mandatory.
The hierarchical identifier has the following generic syntax:
Begins with two slashes ("//").
Here are guidelines for using queries and other clauses in the URI.
Queries and other clauses are optional.
Queries have the following generic syntax:
?<parameter name>=<parameter value>[[&<parameter name>=<parameter value>]]
Separated from hierarchical part by a question mark (?).
Queries are organized in parameter name/value pairs.
Pairs are separated by ampersands (&).
The following clauses can also be appended to a URI: