REST APIのバージョンとURLパス
URL (Uniform Resource Locator)パスは、呼び出すRESTリソースを識別します。 完全なURLパスは、サーバー名とリソース・パスで構成されます:
https://<server>/<resource-path>
<server>
は、Oracle Cloudサービス管理者に送信されるようこそ電子メールに記載されているREST APIサーバーURLです。 たとえば:
https://servername.fa.us2.oraclecloud.com
<resource-path>
は、作業中のリソースの相対パスまたは「エンドポイント」です。 たとえば、商談の場合、リソース・パスは次のようになります:
/crmRestApi/resources/11.13.18.05/opportunities
したがって、商談リソースの結合されたリクエストURLは次のようになります:
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities
リソース・パスには、通常、REST API webモジュールの「コンテキスト・ルート」とリソースのAPIバージョンが含まれていることに注意してください。 たとえば、accountsリソースの場合、REST API webモジュールのコンテキスト・ルートはcrmRestApi
で、バージョンは11.13.18.05
です。
同じリソースにv1バージョンもある場合、URLパスの形式は若干異なります:
https://<servername>/api/boss/data/objects/<module segments>/v1/<service name>
これらのAPIバージョンの1つをリソース・パスで使用することをお薦めします: 11.13.18.05
またはv1
(最新バージョン)。 リソース・パスにバージョン番号が含まれていない場合は、404エラーが発生します。
ノート:
URLはASCII文字セットに準拠している必要があります。 URLにASCII以外の文字が含まれている場合、URLはHTTPと互換性のある形式に自動的に変換されます。 HTML URLエンコーディングの詳細は、www.w3schools.comのHTML Uniform Resource Locatorsを参照してください。