Method
GetMetadata2(GetMetaDataParameters parameters)
This method retrieves metadata information regarding the configuration for the given header record. Calling this method does not impact the contextual state/session that may be active from having called CreateConfigurationFromModel, CreateConfigurationFromXML, or LoadConfiguration methods.
Parameters
The GetMetadata method requires the parameters parameter of type GetMetadataParameters.
GetMetadataParameters
An instance of GetMetadataParameters is passed into the GetMetadata2 method. It contains the contextual information needed to retrieve configuration information.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
int? |
LineItemId |
Returns or sets the ID of the configured line item XML to retrieve. A value of null or -1 will return all configuration XML. |
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 |
|---|---|---|
|
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 |
Specifies the type of diagnostic information that should be returned as a result of the service call. Available values include:
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. |
Returns
ConfigurationMetadata
The ConfigurationMetadata object is returned by the GetMetadata method and contains the following properties.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
Header |
Returns the Config Header (ID + entity type). |
|
|
int[] |
LineItemIds |
Returns an array consisting of configured line identifiers. |
|
string |
ConfigurationXml |
Returns the Configuration XML. |
|
bool |
IsReadOnly |
Returns true if the specified configuration is read only. |
|
bool |
IsConfigured |
Returns whether or not the provided header record has any configured lines. |