This topic lists the operations of the Entity Configuration Web Service.
Operation | Description |
---|---|
listEntities | List the Base entity and the custom
(non-Base) entities that exist in the data domain. Note that even if you have
not created any custom entities, this operation lists the Base entity created
automatically on top of PDRs for your record attributes.
You can use this operation to export the existing entities, for example during an upgrade procedure, in order to later import them to the Endeca data domain with the putEntities operation. |
validateEntity | Validate an entity (either active or inactive) with the specified key and definition. |
validateEntities | Validate multiple entities (either active or inactive) with specified definitions. |
putEntity | Add an entity with the specified key and
definition to the data domain.
The key must be valid according to the NCName format. The NCName format is defined in the W3C document Namespaces in XML 1.0 (Second Edition), located at this URL: http://www.w3.org/TR/REC-xml-names/#NT-NCName For an entity to be created, its building blocks — the physical records and attributes — must already exist in the data domain. If an entity with the specified key already exists in the corpus, it is replaced by the new entity with the same key (if the EQL statements defining the entity are valid). If an entity does not exist, and if its EQL definition is valid, the entity is created. You cannot modify or create the Base entity using this command. The Base entity is created by the Oracle Endeca Server on top of PDRs for existing physical attributes on your records. |
putEntities | Add multiple entities with the specified
keys and definitions to the data domain. The keys must be valid according to
the NCName format.
You cannot use this command to create or replace the Base entity. |
deleteEntities | Delete multiple entities for which keys are specified. You cannot delete the Base entity. |
deleteAllEntities | Delete all custom entities that exist in the corpus without specifying any of their keys. You cannot delete the Base entity. |
<putEntity> <outerTransactionId>?</outerTransactionId> <language>en</language> <semanticEntity key="?" displayName="?" isActive="?"> ... </semanticEntity> </putEntity>
For details on this element and its supported language codes, see the description of the Language element for the Conversation Web Service in EQL filter syntax.