URI

リソースはURIによって識別されます。このトピックでは、ALM Octane REST APIを使用するときにURIを使用する方法について説明します。

URI構文

リソースはURIによって識別されます。

  • URIは、ALM Octaneリソースを一意に識別するために使用されます。

  • URIはSTD 66/RFC 3986に従います。

  • URIは、エンティティ名やフィールド名など、大文字と小文字が区別されます。たとえば、フィールドidは正しいが、IDは正しくない。

  • URIの一般的な構文は次のとおりです。 

    <スキーム名>:<階層識別子> [？<クエリ>]

注: URIでパラメーターを指定するための構文については、変数と値を参照してください。

トップに戻る

スキーム名

  • スキームは必須です。

  • http/httpsスキームのみがサポートされています。

トップに戻る

階層識別子

  • 階層識別子は必須です。

  • 階層識別子の一般的な構文は次のとおりです。 

    //<権限><パス>

  • 2つのスラッシュ ( "//") で始まります。

権限

  • 権限は必須です。

  • Authorityの一般的な構文は次のとおりです。 

    <ホスト名>[:<ポート番号>]

  • ホスト名は、コロン (:) でポート番号と区切られます。)。
ホスト名

  • ホスト名は必須です。

  • ホスト名はドメイン名 (DNSドメイン) で定義できます。

  • ホスト名はIPで定義できます。
ポート番号

  • ポート番号はオプションです。

  • ポート番号は16ビット整数です。

  • ポート番号は、コロン (:) でホスト名から区切られています。

パス

  • パスは必須です。

  • パスの一般的な構文は次のとおりです。 

    [[/<セグメント名>]]

  • パスは一連のセグメントを表します。

  • セグメントはスラッシュ (/) で区切られます。

トップに戻る

クエリおよびその他のURI句

URIでクエリやその他の句を使用するためのガイドラインは次のとおりです。

  • クエリやその他の句はオプションです。

  • クエリの一般的な構文は次のとおりです。 

    ?<パラメーター名>=<パラメーター値>[[&<パラメーター名>=<パラメーター値>]]

  • 疑問符 (？) で階層部分と区切られています。

  • クエリは、パラメーター名と値のペアで構成されています。

  • ペアはアンパサンド (&) で区切られます。

パラメーター

  • パラメーターには、名前と値が含まれます。

  • パラメーター名とパラメーター値は等号で区切られます (=)

  • パラメーター名では大文字と小文字が区別されます。

  • 通常、パラメーター値では大文字と小文字は区別されません。

次の句をURIに追加することもできます。

トップに戻る

参照情報: