構成Webサービスの操作

ここでは、構成Webサービスで使用できる操作をリストします。

構成Webサービスへのリクエストは、configTransaction要素で構成されます。

PDRの操作

Property Description Record (PDR)に対する操作は次のとおりです。
操作 説明
exportProperties 指定されたEndecaデータ・ドメインのすべてのProperty Description Record (PDR)を返します。
listProperties Endecaデータ・ドメインのスキーマに存在する標準属性のPDRのキーを返します。
getProperties 指定した属性キーのPDRを返します。属性キーはlistPropertiesから取得されます。
putProperties Endecaデータ・ドメインのスキーマに(引数として指定された)PDRを追加します。同じキーを持つ属性が存在する場合は置換されます。
updateProperties PDRに対して指定された割当てを追加または変更します。

引数として、既存のPDRに関連付けられている属性キーまたはゼロ個以上の割当てを指定します。

この操作では、新しい割当てが指定されている場合に、PDRに対する割当てがその割当てで置換されます。

この操作にPDR全体を指定する必要はありません(標準属性キーを指定する必要があります)。

注意: 既存のレコードが大量にあるデータセットでPDRに対する割当てを更新する場合、この操作により処理時間が増す可能性があり、パフォーマンスに影響を与えます。
setPropertyDefaultLanguage データ・インジェストWebサービス(DIWS)またはバルク・ロード・インタフェースで自動的に作成される新しい標準属性(PDR)のデフォルトの言語を設定します。デフォルトの言語は、DIWSまたはバルク・ロード・インタフェースによるPDRの作成時にmdex-property_Languageプロパティが明示的に設定されていない場合も使用されます。(構成WebサービスのputProperties操作とimport操作で作成されるPDRは、完全かつ明示的に指定する必要があることに注意してください。

デフォルトの言語は、「サポートされる言語」にリストされる言語IDのいずれかで指定されます。言語IDが指定されない場合、デフォルトのPDR言語はunknownに設定されます。

getPropertyDefaultLanguage PDRに使用されるデフォルトの言語IDを返します。言語IDはunknown (デフォルト)、または以前のsetPropertyDefaultLanguage操作で設定された言語IDのいずれかになります。

DDRの操作

管理属性のDimension Description Record (DDR)に対する操作は次のようになります。
操作 説明
exportDimensions すべてのDimension Description Recordを返します。
listDimensions Oracle Endeca Serverデータ・ドメインに存在する各管理属性のキーを返します。
getDimensions 指定した管理属性キーのDDRを返します。管理属性キーはlistDimensionsから取得されます。
putDimensions Oracle Endeca Serverデータ・ドメインに(引数として指定された)DDRを追加します。同じキーを持つ管理属性が存在する場合は置換されます。
updateDimensions DDRに対して1つ以上の指定された割当て(管理属性)を追加または変更します。

引数として、既存のDDRに関連付けられている管理属性キーまたはゼロ個以上の割当てを指定します。

この操作では、新しい割当てが指定されている場合に、DDRに対する割当てがその割当てで置換されます。

この操作にDDR全体を指定する必要はありません(管理属性キーを指定する必要があります)。

注意: 既存のレコードが大量にあるデータセットでDDRに対する割当てを更新する場合、この操作により処理時間が増す可能性があり、パフォーマンスに影響を与えます。

管理属性値の操作

管理属性値に対する操作は次のとおりです。
操作 説明
listManagedAttributeValues 管理属性が指定された場合は、指定された管理属性のすべての管理属性値(各管理属性レコードの仕様、親管理属性値、関連付けられている管理属性、(指定した場合は)名前、ランク、シノニムなど)を含むmanagedAttributeValues要素を返します。これらの値は、管理属性によって順序付けされます。

管理属性が指定されなかった場合は、Endecaデータ・ドメインの索引に存在するすべての管理属性値を返します。

putManagedAttributeValues 管理属性値を追加または更新します。指定された管理属性に、指定された仕様の管理属性値がすでに存在する場合は、その値が更新されます。それ以外の場合は、新しい管理属性値レコードが追加されます。ルート管理属性値の場合は、親仕様として"/"を指定します。

属性グループの操作

属性グループに対する操作は次のとおりです。
操作 説明
importGroups 既存のグループを削除し、指定した属性を含むグループを追加します。
exportGroups 各グループの完全な表現を返します。
listGroups 各グループのサマリーを返します。
getGroups 指定したグループを返します。

この操作では、グループが各グループ・キーの指定順に返されます。この操作では、グループ・キー、表示名(存在する場合)、グループのカーディナリティなど、既存の各グループのサマリーが作成されます。

この操作は、すべてのユーザー指定グループの属性およびユーザー指定グループに属さない属性を返します。どのユーザー指定グループにも属さないすべての属性をリクエストするには、キーsystem-navigation_InternalGroupを指定します。

putGroups 指定した各グループを追加または置換します。
deleteGroups 指定した各グループを削除します。
updateGroupConfigs グループ記述レコードに対して指定された割当てを追加または変更します。引数として、更新するグループを示すsystem-group_Key、およびグループ記述レコード内のゼロ個以上の割当てを指定します。この操作では、新しい割当てが指定されている場合に、グループ記述レコードに対する割当てがその割当てで置換されます。

この操作にグループ記述レコード全体を指定する必要はありません(グループに関連付けられるsystem-group_Keyを指定する必要があります)。

グループ用の構成Webサービス・リクエストの例、および対話Webサービスでのグループ構成情報の取得方法については、「APIを使用した属性グループの操作」を参照してください。

グローバル構成レコードの操作

グローバル構成レコードに対する操作は次のとおりです。
操作 説明
getGlobalConfigRecord データ・ドメインからグローバル構成レコードを取得します。
putGlobalConfigRecord データ・ドメインのグローバル構成レコードを置き換えます。

Dgraph構成ドキュメントの操作

Dgraph構成ドキュメントの管理の操作は次のとおりです。
操作 説明
listConfigDocuments Dgraphプロセス構成ドキュメントの名前を返します。
getConfigDocuments リクエストされたDgraphプロセス構成ドキュメントを返します。
putConfigDocuments 指定した各Dgraphプロセス構成ドキュメントを追加または置換します。

優先順位ルールの操作

優先順位ルール・レコードの管理の操作は次のとおりです。
操作 説明
listPrecedenceRules データ・ドメインに対して構成された優先順位ルールの名前を返します。
putPrecedenceRules 指定した各優先順位ルールを追加または置換します。
deletePrecedenceRules 優先順位ルール・キーのリストを取得し、各ルールを完全に削除します。
exportPrecedenceRules 各優先順位ルールの完全な表現を返します。
importPrecedenceRules 既存の優先順位ルールを削除し、指定したルールを追加します。

グローバル操作

構成Webサービスには、次のグローバル操作があります。
操作 説明
export すべての属性、グループ、構成ドキュメントおよびグローバル構成レコードをエクスポートします。
import すべての属性、グループ、構成ドキュメントおよびグローバル構成レコードをインポートします。