The Request type contains one or more states describing the records to be selected and one or more content element configurations to describe what summarizations are to be performed. A State is associated with a ContentElementConfig via StateName. Typically, a Request is constructed from the Results returned by a previous invocation by modifying the State. The Language string indicates a language code for any error messages generated during parsing of EQL statements. The State type contains inputs that determine the set of records to operate on. A selected refinement filter selects the refinement with value Spec in the property or dimension named Name. The presence of the AppliedFilterRule indicates that the filter was implicitly created and supplies relevant information. The AppliedFilterRule information includes the Source as well as the TargetPropertyKey. The TargetPropertyKey is the key that is derived from the rule. The FilterIdentifier identifies a particular filter from a named State. If a filter is implicitly created via a filter rule, the StateName and FilterId indicate its origin. The ContentElementConfig is the base class for Configs. A Config is a logical representation of a chunk of data. A Config can provide a "projection" of data that is determined by its State. Dimension values contain the dimension name and the spec of the dimension value. These two things together uniquely define a dimension value. The string contents of this type is not required, but allowed so that someone could plug in an element of type DimensionValueWithName. DimensionValueWithName is basically a DimensionValue type with a required string contents. The string contents is the dimension value name. A path to a refinement dimension value from the root of a dimension. A collection of paths from dimensions of interest. A list of refinements, used to represent paths, for a breadcrumb. Details of search for a breadcrumb. The RecordListConfig type contains inputs needed to define what is returned in the record list. A RecordList will be returned for each RecordListConfig provided. Column - defines a field to be returned in the RecordList of the Results. RecordsPerPage - defines the maximum number of Record elements to return in the ContentElement of the result; default is 10. A RecordSelector selects a record based on some Key/Value pair that is unique to that record. It's like a SelectedRefinementFilter without being subject to multi-select or hierarchy. The RecordDetailsConfig type contains inputs needed to define what is returned for record details. A RecordDetails will be returned for each RecordDetailsConfig provided. Column - defines a field to be returned in the RecordDetails of the Results. If none are specified, the default set (which may not be all) is returned. A content element that allows arbitrary EQL statements to be evaluated. These statements are submitted either as string or as XML. A very simple content element for counting the records in the state. No configuration is needed. The NavigationMenuConfig type contains inputs needed to define what is returned in the navigation menu. If ReturnFullPath is set to true, each set of refinements will be accompanied with the path to root for that set of refinements. If ExposeAllRefinements is set to true, it is equivalent to sending a RefinementConfig with Expose="true" for each property and dimension. Controls the behavior of a single value search. Searches all properties if RestrictToProperties is not specified, otherwise just searches values within the properties given. If MaxPerProperty is specified it limits the number of matches returned per property. Note that, if record search is used in the filter, that search cannot use Boolean match mode. There is no such restriction on the match mode for the value search. A simple content element for obtaining descriptive information regarding attribute groups. A group will be returned if and only if the corresponding GDR (that is, a record with spec system-group_Key) is in the given State. List of properties to restrict value search by. If provided only matching values within the given properties will be returned. Controls the behavior of an individual group of refinements in a NavigationMenu. @Name - the name of the refinement group to control @Expose - whether to expose refinements, or just show the head of the group @MaximumCount - if specified, limit the number of refinements returned @OrderByRecordCount - if true, order by record count, otherwise use natural order @IncludeExplicitSelections - whether to return explicitly selected refinements @IncludeImplicitSelections - whether to return implicitly selected refinements The BreadcrumbConfig type contains the inputs needed to generate a Breadcrumb result component. If ReturnFullPath is set to true, each selected dimension value will be accompanied by a list of dimension values that represents its path to root. The SearchAdjustmentConfig type contains the inputs needed to generate a SearchAdjustment result component. A simple content element for obtaining all properties and information about them. No configuration is required. The behavior is independent of the state. A simple content element for obtaining all searchable attributes and search interfaces. No configuration is required. The behavior is independent of the state. The Results type contains the components that were requested after the possibly modified states were applied. The applicable state is returned as well. The ContentElement type is the base class of all content elements. Types that extend ContentElement are the results that correspond to a ContentElementConfig from a request. A ContentElement contains a "projection" of data. List of attribute groups selected by the current State and their constituent attributes. Note that a group is included if and only if its GDR is in the State; it is neither necessary nor sufficient for records with assignments from the attribute to be in the State. Pertinent information about an attribute including its key, display name and other options. The PDR (and DDR, if present) is included for clients that prefer to read descriptor records directly; note that records do not have a fixed schema. List of all available properties in the system. This includes dimensional properties as well as primordial properties. A key used to identify a searchable property. Also packaged with a user friendly display name. The searchable properties and search interfaces available. Presented in a single alphabetically ordered list. This information is independent of the state. A group of NavigationMenuItems, collected by property group. A menu of NavigationMenuItems or NavigationMenuItemGroups. The results of a value search. The HasMore attribute specifies whether any results were cut off because of a limit specified in the request. A PropertynMatches element appears only for those properties and dimensions in which matches were found, and contains values for those matches. Details of all the values within a particular property that matched a value search. Details of a single value within a particular property that matched a value search. The FullPath will be present when the matched value is dimension value. Property or dimension value resulting from a value search. A collection of refinements of a particular kind. Defaults to hidden. Has a name, and an indication of whether there are more refinements than are currently shown, and an indication of what kind of multi-select is supported, if any. The multi-select status of a dimension. A path to a refinement dimension value from the root of a dimension. A refinement is an indication of the resulting State, optionally with some indication of the number of records that match the resulting State. The result data corresponding to a BreadcrumbsConfig request. Breadcrumbs for refinement and search are presented separately. Corresponds to a SearchAdujstmentConfig request. Includes both suggested and auto-applied adjustments. This type contains column data that includes the display name and column key. The result data corresponding to a RecordListConfig request. It contains information about the overall set of result records submitted to this summarization (NumRecords and TotalPages), the page of records presented (Record and RecordRange) and controls for sorting and pagination. Note that the total number of records is NOT informed by the attributes presented, so a record will be counted even if it appears empty in the results because it has no assignments for the attributes in question. The result data corresponding to a RecordDetailsConfig request. It contains information about the individual record requested from this summarization. This type contains information about an attribute--name, type, hierarchy, stateName, and corpusAttribute. A block of records corresponding to a single EQL statement. It has the name given to it in the EQL statement, and is annotated with the number of records returned. The result data corresponding to an EQLConfig request. The result data corresponding to a RecordCountConfig request. It contains the result of counting records. An indication of where the current page of a record list falls in the ordinal enumeration of the records returned by the filter. A pagination control, used for presenting a possible page to be displayed in a record list. It contains a friendly label and an indication of whether this page is "active" meaning that it makes sense for the control to be "clicked." Current exposure status of a dimension. The sort status for an attribute in a record list. The Active attribute specifies whether this particular sort is active. Part of a record list response, RecordListEntry includes the Record and any computed properties, like geocode distance or snippets. A subset of assignments to a particular MDEX record, with each assignment corresponding to a cs:attribute element. A list of assignments, used to represent MDEX records. A representation of an individual assignment to a property on an MDEX record. Its name, type, and if applicable, its display name are all attributes on the XML element, while its value is the value of the XML element. A set of properties computed during a query for a particular record. A list of search snippets associated with an attribute. Most of the time this list will only have one snippet in it, but in some cases will return more. For example the user searches for multiple terms and has the two terms match in the same attribute. A substring from an assignment which gives context around a search term match. @deprecated A score reflecting the computed relevance of this record to one of the searches in the State. If more than one search is in the State, and arbitrary but consistent search will be used to rank results. This score is comparable only within the same security filter, filter state, text search, and specific records in the corpus. If any of these differs, the scores are not comparable. Sort type paralleling the structure of a MAX Sort element. Key is the property or dimension value to sort by and Direction is an enumeration of "Ascending" or "Descending". A SortDirection should be "Ascending" or "Descending". Used when specifying a Sort on records. Specification of a reference point for range filtering of geocode properties. An MDEX record kind restriction A filter expressed in EQL. The AppliedFilterRule indicates if the filter was implicitly created and provides relevant information. It applies only to SelectionFilters. A TextSearchFilter type that parallels the structure of a MAX Search element. Key is the search interface to use and the text contents of the element is the search term(s). An applied search adjustment used for AutoCorrect. The TextSearchFilter is the original query, the AdjustedTerms are the corrected terms. A suggested search adjustment used for DidYouMean. The TextSearchFilter associates this suggestion with a particular search from the query. Enumerates the search modes available when performing a text search. Used to force string inputs to be non-empty.

Conversation-style web service for building applications