Web サービスのスキーマ

[スキーマ] タブには、Web サービスのフィールドに関する情報が表示されます。Web サービスの種類によって表示される情報は異なります。

SOAP Web サービスのスキーマ

SOAP Web サービスは、いくつかの操作で構成されます。[スキーマ] タブには、操作ごとに、その名前の付いたセクションが表示されます。操作を展開すると、2 つのスキーマ (操作の入力スキーマと出力スキーマ) にアクセスできます。

The Schema tab of a SOAP web service shows information about the parameters and return values of its operations

SOAP Web サービスの [スキーマ] タブは操作のパラメータと戻り値に関する情報を表示

操作の入力スキーマは、受け取ることができるパラメータのリストを表します。入力パラメータごとに、以下の情報が表示されます。

  • 名前

  • タイプ

  • Data Catalog に固有の 説明 (プレーンテキスト)

  • 基盤となるビューに対するクエリに使用される 演算子

そのため、SOAP 操作はエレメントの配列を返します。配列の各エレメントは、基盤となるビューのタプルに対応し、したがって複数のフィールドで構成されます。出力スキーマには、戻り値のフィールドごとに以下の情報が表示されます。

  • 名前

  • タイプ

  • Data Catalog に固有の 説明 (プレーンテキスト)

注釈

SOAP Web サービスの [スキーマ] タブには、ビューに関する情報を取得する操作に関する情報のみが表示されます。データを挿入、更新、または削除する操作は対象外です。

REST Web サービスのスキーマ

REST Web サービスは、それぞれが Virtual DataPort 内のビューを表す一連のリソースで構成されます。[リソース] タブには、リソースごとに、その名前の付いたセクションが表示されます。リソースを展開すると、そのフィールドに関する情報にアクセスできます。

The Schema tab of a REST web service shows information about the fields of its resources

REST Web サービスの [スキーマ] タブはそのリソースのフィールドに関する情報を表示

フィールドごとに、以下の情報が表示されます。

  • 名前

  • タイプ

  • Data Catalog に固有の 説明 (プレーンテキスト)

  • 状態: デフォルトでは、ビューのすべてのフィールドをリソースの入力フィールドおよび出力フィールドとして使用できます。ただし、フィールドを制約する必要がある場合、フィールドの状態が以下のいずれかに変更されることがあります。

    • 必須: すべてのリクエストでフィールドの値を指定する必要があります。フィールドが必須の場合、その名前の横に mandatory アイコンが表示されます。

    • 検索不可能: このフィールドはリクエストの入力として使用できません。[入力/出力] 列に No searchable ラベルが表示されます。

    • 出力しない: このフィールドはリクエストの出力に表示できません。[入力/出力] 列に Do not output ラベルが表示されます。


SOAP Web サービスと REST Web サービスのどちらの場合も、スキーマの各フィールドの説明が表示されます。適切な権限があれば説明の横に edit アイコンが表示されます。それをクリックして新しい説明を設定すると、Data Catalog のすべてのユーザーに公開されます。

注釈

このタブには、最後に同期したときのスキーマの状態が表示されます。したがって、その後に Virtual DataPort でスキーマが変更された場合、その変更内容は反映されません。ただし、この Web サービスが一度も同期されていない場合は、Virtual DataPort の現在のスキーマが表示されます。