変数と値

このトピックでは、REST APIで変数と値を指定するための構文を提供します。

ブラケットタイプ

使用構文と例

<変数名>

山かっこは変数を囲みます。

構文: <ホスト名>

:

Octane.mycompany.com

先のとがった括弧内のホスト名を、ホスト名を表す文字列に置き換えます

[オプションの値]

角括弧はオプションの値を囲みます。

構文: <ホスト名>[:<ポート名>]

:  

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

先のとがった括弧内のホスト名を、ホスト名を表す文字列に置き換えます

ポート番号が存在する場合は、コロン ( ":") を追加し、ポート番号を表す番号に置き換えます。

[[繰り返しオプション値]]

二重角かっこは、繰り返しのオプション値を囲みます。

構文: [[/<パスセグメント>]]

:  

http[s]://<server>:<port>/api/shared_spaces/1/workspaces/2/defects/10

セグメントごとにパスを作成し、各パスセグメントの前にスラッシュ ( "/") を追加し、パスセグメント変数をパスセグメントに置き換えます。

参照情報: