エンティティ構成Webサービスの操作

ここでは、エンティティ構成Webサービスの操作をリストします。

エンティティ構成Webサービスへのリクエストは、次のいずれかの操作にすることができます。
操作 説明
listEntities データ・ドメインに存在するベース・エンティティとカスタム(ベース以外の)エンティティをリストします。カスタム・エンティティを作成していない場合でも、この操作ではレコード属性のPDRの上に自動的に作成されたベース・エンティティがリストされます。

この操作を使用して、たとえば後でputEntities操作を使用してEndeca Serverにインポートするために、アップグレード手順中に既存のエンティティをエクスポートできます。

validateEntity 指定されたキーと定義のエンティティ(アクティブまたは非アクティブのいずれか)を検証します。
validateEntities 指定された定義の複数のエンティティ(アクティブまたは非アクティブのいずれか)を検証します。
putEntity 指定されたキーと定義を持つエンティティをデータ・ドメインに追加します。

キーはNCName書式に従って有効である必要があります。NCName書式は、次のURLにあるW3Cのドキュメント「Namespaces in XML 1.0 (Second Edition)」に定義されています。http://www.w3.org/TR/REC-xml-names/#NT-NCName

エンティティを作成するには、その構成要素(物理レコードと属性)がデータ・ドメインにすでに存在する必要があります。

指定されたキーを持つエンティティが集成にすでに存在する場合は、同じキーを持つ新しいエンティティで置換されます(エンティティを定義するEQL文が有効な場合)。

エンティティが存在せず、そのEQL定義が有効な場合は、エンティティが作成されます。

このコマンドを使用してベース・エンティティを変更または作成することはできません。ベース・エンティティは、Oracle Endeca Serverによってレコードの既存の物理属性のPDRの上に作成されます。

putEntities 指定されたキーと定義を持つ複数のエンティティをデータ・ドメインに追加します。キーはNCName書式に従って有効である必要があります。

このコマンドを使用してベース・エンティティを作成または置換することはできません。

deleteEntities キーが指定されている複数のエンティティを削除します。ベース・エンティティは削除できません。
deleteAllEntities キーを指定せずに、コーパスに存在するすべてのカスタム・エンティティを削除します。ベース・エンティティは削除できません。

EQL解析エラー・メッセージの言語ID

操作には、EQL解析で生じるエラー・メッセージの言語を設定する、オプションのLanguage要素があります。たとえば、putEntity操作の一般的な構文は次のようになります。
<putEntity>
   <outerTransactionId>?</outerTransactionId>
   <language>en</language>
   <semanticEntity key="?" displayName="?" isActive="?">
    ...
   </semanticEntity>
</putEntity>

この要素とそのサポートされる言語コードの詳細は、「EQLフィルタの構文」の対話WebサービスのLanguage要素に関する説明を参照してください。