Collection operations

This section describes the operations used to create and manage collections.

All of the collection operations have optional outerTransactionId and language elements, as in this syntax for the listCollections operation:

<listCollections>
   <!--Optional:-->
   <outerTransactionId>?</outerTransactionId>
   <!--Optional:-->
   <language>en</language>
</listCollections>

Because their functionality is identical across all the collection operations, the two elements are described here instead of in the descriptions for each operation.

outerTransactionId element

The optional outerTransactionId element specifies the ID of an outer transaction (if it has been started by the Transaction Web Service). It is incorrect to specify an outer transaction ID when an outer transaction is not in progress. All configuration requests with incorrectly specified outer transaction IDs fail with a SOAP fault.

Some of the operations (such as updateCollections) can work on multiple collections with the same request. These operations, however, are atomic, which means that either the operation is successful (i.e., all collections are successfully affected), or the entire operation fails if at least one of the collections cannot be modified). To prevent leaving the collection records in a undeterministic state, you can first open an outer transaction, run the operation with the outerTransactionId element, and then roll back the transaction if the operation fails.

language element

The optional language element sets the language for error messages that result from EQL parsing. The default language for error messages is en (English). 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.