This topic lists the operations available in the Configuration Web Service.
A request to the Configuration Web Service consists of a configTransaction element.
Operation | Description |
---|---|
exportProperties | Return all Property Description Records (PDRs) for the specified Endeca data domain. |
listProperties | Return the key of the PDRs for the standard attributes present in the schema of the Endeca data domain. |
getProperties | Return PDRs for the specified attribute keys. Attribute keys are obtained from listProperties. |
putProperties | Add the PDRs (specified as an argument) to the schema of the Endeca data domain. If an attribute with the same key exists, it is replaced. |
updateProperties | Lets you add or modify specified
assignments on the PDR.
As an argument, specify an attribute key associated with an existing PDR and zero or more assignments. The operation replaces the assignment on the PDR with a new assignment if it is provided as an argument. There is no requirement to specify the entire PDR to this operation; there is a requirement to specify the standard attribute key. Note: If you update an assignment on the PDR in a data set with
a large number of existing records, this operation can increase the processing
time and affects performance.
|
setPropertyDefaultLanguage | Sets the default language for new standard
attributes (PDRs) that are created automatically by the Data Ingest Web Service
(DIWS) or the Bulk Load Interface. The default language is also used if the
mdex-property_Language property is not
explicitly set during the creation of a PDR by DIWS or the Bulk Load Interface.
(Note that PDRs created by the Configuration Web Service's
putProperties and
import operations must be fully and explicitly
specified.)
The default language is specified with one of the language IDs listed in Supported languages. If a language ID is not specified, then the default PDR language will be set to unknown. |
getPropertyDefaultLanguage | Returns the default language ID that is used for PDRs. The language ID will be either unknown (the default) or the language ID that was set by a previous setPropertyDefaultLanguage operation. |
Operation | Description |
---|---|
exportDimensions | Return all Dimension Description Records. |
listDimensions | Return the key of each managed attribute present in an Oracle Endeca Server data domain. |
getDimensions | Return DDRs for specified managed attribute keys. Managed attribute keys are obtained from listDimensions. |
putDimensions | Add the DDRs (specified as arguments) to an Oracle Endeca Server data domain. If a managed attribute with the same key exists, it is replaced. |
updateDimensions | Lets you add or modify one or more
specified assignments (managed attributes) on the DDR.
As an argument, specify a managed attribute key associated with an existing DDR and zero or more assignments. The operation replaces the assignment on the DDR with a new assignment if it is provided as an argument. There is no requirement to specify the entire DDR to this operation; there is a requirement to specify the managed attribute key. Note: If you update an assignment on the DDR in a data set with
a large number of existing records, this operation can increase the processing
time and affects performance.
|
Operation | Description |
---|---|
listManagedAttributeValues | If a managed attribute is specified,
return a
managedAttributeValues element containing all
managed attribute values for the specified managed attribute, including each
managed attribute record's spec, parent managed attribute value, associated
managed attribute, and, if specified, the name, rank and synonyms. The values
are ordered by managed attribute.
If no managed attribute is specified, return all managed attribute values present in the index of the Endeca data domain. |
putManagedAttributeValues | Add or update managed attribute values. If a managed attribute value already exists with the given spec for the given managed attribute, it is updated. Otherwise, a new managed attribute value record is added. For the root managed attribute value, specify "/" as the parent spec. |
Operation | Description |
---|---|
importGroups | Remove any existing groups and add the groups with specified attributes. |
exportGroups | Return the full representation of each group. |
listGroups | Return a summary of each group. |
getGroups | Return the specified groups.
This operation returns groups in the order in which you specify the keys for each group. This operation creates a summary of each existing group which includes the group key, the display name (if it exists), and the cardinality of the group. This operation returns attributes for all user-specified groups and attributes that do not belong to any user-specified groups. To request all attributes that do not belong to any user-specified groups, specify the key system-navigation_InternalGroup. |
putGroups | Add or replace each of the specified groups. |
deleteGroups | Delete each of the specified groups. |
updateGroupConfigs | Lets you add or modify specified
assignments on the group description record. As an argument, specify a
system-group_Key indicating which group to
update, and zero or more assignments in the group description record. The
operation replaces the assignment on the group description record with a new
assignment if it is provided as an argument.
There is no requirement to specify the entire group description record to this operation; there is a requirement to specify the system-group_Key associated with the group. |
For examples of Configuration Web Service requests for groups and for information on how to retrieve group configuration information with the Conversation Web Service, see Working with attribute groups using the API.
Operation | Description |
---|---|
getGlobalConfigRecord | Obtain the Global Configuration Record from the data domain. |
putGlobalConfigRecord | Replace the Global Configuration Record in the data domain. |
Operation | Description |
---|---|
listConfigDocuments | Return the names of the Dgraph process configuration documents. |
getConfigDocuments | Return the requested Dgraph process configuration documents. |
putConfigDocuments | Add or replace each of the specified Dgraph process configuration documents. |
Operation | Description |
---|---|
listPrecedenceRules | Return the names of the precedence rules configured for the data domain. |
putPrecedenceRules | Add or replace each of the specified precedence rules. |
deletePrecedenceRules | Take a list of precedence rule keys and completely delete each rule. |
exportPrecedenceRules | Return the full representation of each precedence rule. |
importPrecedenceRules | Remove any existing precedence rules and add the specified ones. |
Operation | Description |
---|---|
export | Export all attributes, groups, configuration documents, and the Global Configuration Record. |
import | Import all attributes, groups, configuration documents, and the Global Configuration Record. |