このページを共有

# 一般的な基準とガイドライン

このセクションでは、ALM OctaneでREST API仕様を操作するための標準とガイドラインを提供します。

このトピックの内容:

## 標準

仕様を導く原則は、Roy Fieldingによって導入された基本的なRESTガイドラインに従います。詳細については、Representational State Transfer (REST)を参照してください。

これらは、REST overHTTPを実装するために必要なガイドラインです。これらのガイドラインは、ALM Octaneに適合しています。ただし、ガイドラインは標準に従っていることに注意してください。

トップに戻る

## ガイドライン

プラットフォームと言語 | アプリケーションは、RESTをサポートする任意の言語および任意のプラットフォームで作成できます。RESTの詳細については、Representational State Transferを参照してください。
データ形式 | APIは、要求と応答の両方でアプリケーション/json表現のみをサポートします。 リソースのリファレンスで特に指定されていない限り、データはJSON形式で送信および返されます。このAPIは、ECMA 404仕様を使用します。
コミュニケーションとセキュリティ | APIはHTTPSを介して通信します。 REST APIは、プロキシサーバーがRESTリソースへのアクセスを許可する前に基本認証を必要とする構成では実行できません。 Accept-Encodingヘッダーでサポートされている唯一の値はgzipです。他の値が指定されている場合、応答はエンコードされません。 セキュリティガイドラインに準拠するために、REST APIは、POSTおよびPUTリクエストに許可される最大入力を定義するポリシーを適用します。最大入力サイズのグローバル標準設定値は100MBです。サイト管理者は、MAX_REQUEST_LENGTHパラメーターを設定することでこの値を変更できます。一部のリソースでは、グローバル値を上書きするカスタム制限を設定できます。これにより、ログ、カバレッジ、脆弱性、共有スペースのインポート、添付ファイルなど、機能ごとに微妙な調整を行うことができます。
URLエンコード | アプリケーションによって送信されるリクエストURIは、 URL-encodedれている必要があります。URLエンコードの詳細については、IETF: を参照してください。ユニフォームリソース識別子 (URI): 一般的な構文。 詳細については、URIsを参照してください。
ヘッダー | データを送信するときは、常にContent-Typeヘッダーを送信して、クライアントからサーバーに送信されるデータのタイプを指定します。 Content-Typeヘッダーは、認証時を含め、application/jsonである必要があります。 コンテンツが送信されない限りContent-Typeヘッダーを送信しないでください。 サーバーから受信するデータの形式を指定するには、常にAcceptヘッダーを送信します。 詳細については、リクエストの実行を参照してください。
クッキーを再送する | "Set-Cookie" ヘッダーを使用して、前の応答でサーバーから送信されたすべてのCookieを返します。http://tools.ietf.org/html/rfc6265を参照してください。Cookieの再送信に失敗すると、ユーザーがREST APIサービスを操作しているときに認証が期限切れになる可能性があります。 詳細については、セッションの管理と有効期限を参照してください。
時間データ | 時間データはUTC形式でデータベースに保存されます。REST APIは、UTC時刻を現地時間に変換できません。したがって、UIクライアントはUTC形式をグローバルユーザーの現地時間に変換します。 REST APIコンシューマーは、時間データでも同じことを行う必要があります。

トップに戻る

次のステップ

- REST APIの変更点
- REST APIの基本
- REST APIの操作方法
- 一般的なフローとERダイアグラム

https://admhelp.microfocus.com ALM Octane 8942
検索結果を改善するためのヒント... ALM Octaneヘルプセンター ALM Octaneヘルプ 15.1.90 すべて ローカルヘルプセンターを表示 オンラインヘルプセンターを表示 戻る ブラウザーの履歴内を戻る 進む ブラウザーの履歴内を進む 検索のハイライトを削除する 次のトピック 次のトピックに進む 前のトピック 前のトピックに戻る 現在のトピックを印刷 バージョン: