リファレンス
参照トピックは、REST APIを初めて使用する場合に特に役立ちます。 最初に、一般的に使用されるREST API 「条件」、単一および収集リソースなどの様々なタイプの「RESTリソース」、およびリソース「URLパス」を確認できます。 次のトピックを確認します:
| トピック | 摘要 |
|---|---|
| 値リスト | 頻繁に使用される静的データの取得に使用できる値リスト。 |
| 必須属性およびパス・パラメータ | リソースとそのサブリソースのペイロード属性およびパス・パラメータをリクエストします。 |
| RESTリソース・タイプ | 2つのタイプのリソースのパラメータおよびプロパティ: 単数形とコレクション。 |
| ステータス・コード | 標準HTTPレスポンス・コードのリスト。 |
| サポートされるデータ型 | JavaScript Object Notation (JSON)リソース属性タイプのリスト。 |
| サポートされているHTTPメソッド | GET, POST, PATCH,およびDELETEメソッドで、各データ型を処理します。 |
| サポートされるメディア・タイプ | HTTPペイロードのデータ形式のリスト。 |
| 用語 | 一般的に使用される用語のリスト。 |
| REST APIのバージョンとURLパス | 製品バージョン間のリソース・パスのバリエーション。 |
| 認可にJSON Webトークンを使用 | JSON Web Token (JWT)は、自分を認可できるコンパクトなトークン形式です。 |
| 添付の処理 | このトピックは、RESTリソースに関連付けられた添付の操作に使用できる情報に役立ちます。 |