Share this page

# Variables and values

This topic provides the syntax for specifying variables and values in the REST API.

Bracket type | Usage syntax and example
--- | ---
<variable name> | Angle brackets surround variables. Syntax: <host name> Example: `octane.mycompany.com` Replace the host name within the pointy brackets with a string representing the host name
[optional value] | Square brackets surround optional values. Syntax: <host name>[:<port number>] Example: `http[s]://octane.mycompany.com:8080` Replace the host name within the pointy brackets with a string representing the host name If a port number exists, add a colon (":") and replace the port number with a number representing the port number
[[repetitive optional value]] | Double square brackets surround repetitive, optional values. Syntax: [[/<path segment>]] Example: `http[s]://<server>:<port>/api/shared_spaces/1/workspaces/2/defects/10` Build a path by segments, adding a slash ("/") before each path segment, replacing the path segment variable with path segments

See also:

- Entry points
- Instances (Entities)
- Collections

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 23.4-24.3 All View Local Help Center View Online Help Center Version: