Configuration Web Service operations

This topic lists the operations available in the Configuration Web Service.

A request to the Configuration Web Service consists of a configTransaction element.

Operations for PDRs

The operations on PDRs are the following:
Operation Description
exportProperties Return all Property Description Records (PDRs) for the data store.
listProperties Return the key of the PDRs for the standard attributes present in the schema of the Oracle Endeca Server data store.
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 Oracle Endeca Server data store. 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.

Operations for DDRs

The operations on DDRs are the following:
Operation Description
exportDimensions Return all Dimension Description Records.
listDimensions Return the key of each managed attribute present in the Oracle Endeca Server data store.
getDimensions Return DDRs for specified managed attribute keys. Managed attribute keys are obtained from listDimensions.
putDimensions Add the DDRs (specified as arguments) to the Oracle Endeca Server data store. If a managed attribute with the same key exists, it is replaced.
updateDimensions Lets you add or modify specified assignments 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.

Operations for Attribute Groups

The operations on attribute groups are the following:
Operation Description
importGroups Remove any existing groups and add the specified ones.
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 example, the group system-navigation_InternalGroup is a group that contains all attributes that do not belong to any user-specified groups. This group is created automatically and does not have a display name initially. To provide a display name "Other attributes" for this group, send the following request to the Configuration Web Service running on the particular data store: 
<config-service:updateGroupConfigs>
<mdex:record>
  <system-group_DisplayName>Other Attributes</system-group_DisplayName>
  <system-group_Key>system-navigation_InternalGroup</system-group_Key>
</mdex:record>
</config-service:updateGroupConfigs>

Operations for Global Configuration Record

The operations for Global Configuration Record are the following:
Operation Description
getGlobalConfigRecord Obtain the Global Configuration Record from the data store (created with the Oracle Endeca Server).
putGlobalConfigRecord Add the Global Configuration Record to the data store. If the GCR already exists, it is replaced.

Operations for XML configuration documents

The operations for managing the XML configuration documents are the following:
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.

Operations for precedence rules

The operations for managing precedence rule records are the following:
Operation Description
listPrecedenceRules Return the names of the precedence rules configured for the data store.
putPrecedenceRules Add or replace each of the specified precedence rules.
deletePrecedenceRules Take a list of precedence rule keys and completely delete each rule.

Global operations

The Configuration Web Service has the following global operations:
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.