URIs

Resources are identified by URIs. This topic explains how to use URIs when working with the ALM Octane REST API.

URI syntax

Resources are identified by URIs:

URIs are used to uniquely identify ALM Octane resources.
URIs follow STD66 / RFC 3986.
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:

//<authority><path>

Begins with two slashes ("//").

Authority	Authority is mandatory. Authority has the following generic syntax: <host name>[:<port number>] Host name is separated from the port number with a colon ( : ).
Host name	Host name is mandatory. Host name can be defined by the domain name (DNS domain). Host name can be defined by an IP.
Port number	Port number is optional. Port number is a 16-bit integer. Port number is separated from host name by a colon (:).
Path	Path is mandatory. Path has the following generic syntax: [[/<Segment Name>]] Path represents a sequence of segments. Segments are separated by a slash (/).

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 (&).

Parameters

The following clauses can also be appended to a URI: