用語
Fusion Applications REST APIを初めて使用する場合は、慣れていない用語に必ず従う必要があります。 これらの定義を確認して、技術用語の理解を深めます。
- Base64: バイナリ・データをテキスト文字列形式に変換し、データをHTTPヘッダーで安全に転送できるようにするエンコーディング・スキーム。 Base64は、バイトの文字列をビット・グループに分割してエンコードするため、各グループは64文字のいずれかにマップされ、生のバイナリ・データをネットワーク間で送信するリスクを回避します。
- Basic認証: 資格証明をユーザー名 / パスワードのペアとして収集する、HTTPプロトコルに組み込まれている、シンプルで一般的に使用される識別プロセス。 RESTクライアントは、認可ヘッダーを含むHTTPリクエストをBase64エンコード形式で送信 :
Basic username:password.通常、第2レベルのセキュリティで実装されます。 - 収集リソース: アカウント、従業員、購買オーダー、商談など、品目のリストを表します。
- エンドポイント: レスポンスを返すことができるサーバー上のURI。 リソースとエンドポイントという用語は、同じ意味で使用できます。
- HTTPヘッダー: 情報を伝送し、HTTPトランザクションの動作パラメータを定義するHypertext Transfer Protocol (HTTP)のリクエスト・メッセージおよびレスポンス・メッセージのコンポーネント。 例については、「RESTクライアントの操作」を参照してください。
- 値リスト(LOV)リソース: フィールドに使用できる有効な選択肢のリストを提供するリソース。 LOVリソースには、次の2つのタイプがあります:
- 検索: フィールドの選択肢を含む短い静的リスト。 たとえば、参照値(LOV)リソースは、挨拶フィールドに使用できる定義済の値(Mr.、Mrs.、Msなど)を提供します。
- 動的: リソースのコンテキストに基づいて変化する有効な選択肢のリスト。 たとえば、都市の値の動的リストは、選択した国に基づいて変化します。
- RESTリソース: タイプ、関連データ、および他のリソースとの関係を持つオブジェクト。 たとえば、単一のドキュメント、イメージ、オブジェクト、またはリソースのコレクションがあります。 一連のHTTPメソッドを使用して、リソースにアクセスできます。 詳細は、「RESTリソース・タイプ」を参照してください。
- リソース索引URI: 使用可能な最上位レベルのUniform Resource Identifier (URI)エントリ・ポイントのセットへのパスを提供する、リソースへのすべての認証済アクセスの開始点。 このパス例では、リソース索引URIは
://servername.com/Your RestApi/resources/11.13.18.05/opportunitiesです - リソース表現: サーバーのレスポンスとして提供される、現在または意図したリソース状態。 JSON形式では、データのメタデータと状態の両方が含まれます。
- レスポンス・ペイロード: HTTPリクエストの応答時にサーバーが戻すデータ。 レスポンス・ペイロードは、JSON、XMLまたはテキスト・ドキュメントです。
- ルート・リソース: 包含コンテキストを必要としない個々のリソース。 通常、パス・パラメータのない最上位レベルのコレクションであり、リソース索引にあります。
- 単数リソース: 従業員、アカウント、ジョブなど、1つのエンティティを表します。 詳細は、「RESTリソース・タイプ」を参照してください。
- サブリソース: 他のエンティティとの関係をより明確にするために使用されるリソースのタイプ。 その関係タイプは、住所や担当者などの親子にすることも、顧客へのオーダーなどの集計にすることもできます。
- Uniform Resource Identifier (URI): 相互作用に関連する特定のリソースに対処するために使用されるパスの一部またはすべて。 URIの例には、URL (Uniform Resource Locater)およびURN (Uniform Resource Name)があります。 次のURIの例では、完全なアドレス文字列はURLで、ターゲット・リソース、opportunities、はURNです :
https://servername.com/Your RestApi/resources/11.13.18.05/opportunities