Knowledge Base - API
Breadcrumbs

ReplaceSeriesModelParameters

An instance of ReplaceSeriesModelParameters is passed into the ReplaceSeriesModel method.

Constructors

ReplaceSeriesModelParameters()

ReplaceSeriesModelParameters(ConfigHeader header, int lineItemId, string seriesId, string modelId)

Properties

Data Type

Property

Description

int

LineItemId

Returns or sets the configuration number to replace.

bool

ValidateIdentifiers

Returns or sets whether the Series/Model IDs passed in are validated.

bool

AutoDraftMode

Returns or sets whether the configuration is automatically placed into draft mode.

string

SeriesId

Returns or sets the Series ID to assign. If NULL, the Series ID will not be replaced.

string

ModelId

Returns or sets the Model ID to assign. If NULL, the Model ID will not be replaced.

Inheritance

ConfigParameters

The ConfigParameters class represents contextual information needed by the integration libraries for the Web Configurator Service.

Constructors

ConfigParameters()

ConfigParameters(ConfigHeader header)

Properties

Data Type

Property

Description

ConfigHeader

Header

Returns or sets the header (type and id) of the record in the host system being configured.

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.