リクエストの送信
REST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。
URL構造
次のURL構造を使用して、RESTリソースにアクセスします:
https://<subdomain>.<domain>.com:<port>/data/api<resource-path>
説明:
-
<subdomain.domain>.com:<port>=サービスが実行されているエンドポイント・ホストおよびポート -
<resource-path>=リソースを定義する相対パス
ノート:
java.net.URLEncoderなどの適切なライブラリを使用してREST APIをコールする場合は、常にURLパラメータをエンコードすることが重要です。
サポートされているメソッド
残りのエンドポイントは、次の表で説明する1つ以上のHTTPメソッドをサポートしています:
| HTTPメソッド | 説明 |
GET |
Request-URIで識別される情報を取得します。 |
POST |
リクエストで囲まれたエンティティを、リクエスト行のRequest-URIで識別されるリソースの新しい部下として受け入れます。 |
PUT |
指定されたRequest-URIで囲まれたエンティティを格納/更新するようリクエストします。 |
DELETE |
Request-URIで識別されるリソースを削除します。 |
メディア・タイプ
REST APIでは、次のメディア・タイプがサポートされています:
-
application/json -
application/xml
サポートされているヘッダー
REST APIは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡すことができる次のヘッダーをサポートしています。
| ヘッダー | 説明 | 例 |
Content-Type |
リクエストの本文のメディア・タイプ。 POSTおよびPUTリクエストに必要です。 |
Content-Type: application/json |