Entity operations

The following table lists the entity-related operations in the Entity and Collection Configuration Web Service.

Operation Description
listEntities List the entities that exist in the data domain. One use for this operation is 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. Note that the EQL statements defining the entity must be valid if the entity is active.

If an entity does not exist, the entity is created. Note that the entity is not created if its isActive flag is set to true and its EQL definition is not valid.

putEntities Add multiple entities with the specified keys and definitions to the data domain. The keys must be valid according to the NCName format.
deleteEntities Delete multiple entities for which keys are specified.
deleteAllEntities Delete all entities that exist in the corpus without specifying any of their keys.