Operations in the Entity and Collection Configuration Web Service

Entity operations

Entity operation	Description
putEntity	Add an entity with the specified entity key and definition to the data domain.
putEntities	Add multiple entities with the specified entity keys and definitions to the data domain.
validateEntity	Validate an entity (either active or inactive) with the specified entity key and definition.
validateEntities	Validate multiple entities (either active or inactive) with specified definitions.
listEntities	List the entities that exist in the data domain.
deleteEntities	Delete multiple entities for which entity keys are specified.
deleteAllEntities	Delete all entities that exist in the data domain without specifying any of their entity keys.

For details on using the entity operations, see Working with Entities.

Collection operations

Collection operation	Description
putCollection	Add a collection with the specified collection key and unique property key to the data domain.
putCollections	Add multiple collections with the specified collection keys and unique property keys to the data domain.
updateCollections	Update the configuration of an existing collection.
listCollections	List the collections that exist in the data domain.
deleteCollections	Delete one or more collections, as specified by their collection keys.
deleteAllCollections	Delete all collections that exist in the data domain without specifying any of their collection keys.

For details on using the collection operations, see Collections.

Filter rule operations

Filter rule operation	Description
putFilterRule	Add a filter rule with the specified filter rule key and rules to the data domain.
putFilterRules	Add multiple filter rules with the specified filter rule keys and rules to the data domain.
listFilterRules	List the filter rules that exist in the data domain.
deleteFilterRules	Delete one or more filter rules, as specified by their filter rule keys.
deleteAllFilterRules	Delete all filter rules that exist in the data domain without specifying any of their filter rule keys.

For details on using the filter rule operations, see Filter Rules.

Language ID for EQL parsing error messages

The operations have an optional Language element that sets the language for error messages that result from EQL parsing. For example, the general syntax of the putEntity operation is:

<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 in EQL Language codes for EQL error messages.