Knowledge Base - API
Breadcrumbs

FixConfigParameters

An instance of FixConfigParameters is passed into the FixConfiguration2 method. It includes the necessary properties to specify how errors should be fixed and for which Categories.

Constructor

FixConfigParameters()

FixConfigParameters(List<string>catIds, FixConfigBehavior behavior = FixConfigBehavior.Exclusive)

Properties

Data Type

Property

Description

FixConfigParameters

CategoryIds

Returns or sets the list of Categories that will either be excluded or included when fixing the configuration, depending on the value of the Behavior property.

FixConfigBehavior

Behavior

Determines how the Categories specified by the CategoryIds property will be processed. If Exclusive (default), the Categories identified will NOT be processed. If Inclusive, only those Categories specified will be processed.

Inheritance

ParametersBase

The ParametersBase class is the base class for the parameters types that are passed in to various methods on the service. All parameters-derived types have the parameters listed below.

Properties

Data Type

Property

Description

bool

OmitConfigurationXmlFromResult

Returns or sets whether or not the configuration xml should be omitted from the result object.

In general, the various methods that interact with the service will cause the configuration XML to be returned to the caller each time. It can be bandwidth and processing intensive to recreate the XML for each call. By setting this property to True, those steps will be skipped resulting in less data being transmitted and less server-side processing.

OperationsBehaviors

OperationBehaviors

This property is used to provide additional contextual behaviors to the service call. Provide an instance of the OperationBehaviors class with properties set to identify whether the configuration should be saved (via the Stateless services) or whether a StateGraph should be returned with the result of the web service call.

DiagnosticOutput

DiagnosticOutput

Specifies the type of diagnostic information that should be returned as a result of the service call.

Available values include:

  • None

  • RulesExecuted

  • RulesMessages

  • RulesChanges

This provides access to the rules that were executed along with their associated messages and changes. If set to a value other than None, the DiagnosticData property of the various Result objects will be populated.

bool

ValidateRequiredProperties

Returns or sets a value indicating whether the configuration should be validated for required Property values. The default value is true.