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: `product.mycompany.com` Replace <host name> within the angle brackets, with a string representing the host name.
[optional value]	Square brackets surround optional values. Syntax: <host name>[:<port number>] Example: `http[s]://product.mycompany.com:8080` Replace <host name> with a string representing the host name. If a port number exists, add a colon (":") and replace <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. Replace the path segment variable with path segments.

Bracket type

Usage syntax and example

<variable name>

Angle brackets surround variables.

Syntax: <host name>

Example:

product.mycompany.com

Replace <host name> within the angle brackets, with a string representing the host name.

[optional value]

Square brackets surround optional values.

Syntax: <host name>[:<port number>]

Example:

http[s]://product.mycompany.com:8080

Replace <host name> with a string representing the host name.

If a port number exists, add a colon (":") and replace <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. Replace the path segment variable with path segments.