GetMetadata

Method

GetMetadata(ConfigHeader header)

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.

This method has been superseded by GetMetadata2.

Parameters

The GetMetadata method requires the header parameter of type ConfigHeader.

ConfigHeader

The ConfigHeader class represents a container for header-related fields.

Constructor

ConfigHeader()

Creates a new 'Empty' ConfigHeader instance.

ConfigHeader(string type, string id)

Creates a new ConfigHeader instance with the specified type and id.

Properties

Data Type	Property	Description
string	Type	Returns or sets the type of header record. For Microsoft CRM, this value maps to the entity logical name (e.g., quote, salesorder, etc.). For Microsoft AX, this value maps to the entity type name (e.g., SalesOrder, SalesQuotation etc.). For Microsoft NAV, this value maps to the entity type name (e.g., SalesOrder, SalesQuote).
string	Id	Returns or sets the identifier of the header record. For Microsoft CRM, this value is a GUID in string form. For Microsoft NAV and AX, it is a number.

Data Type

Property

Description

string

Type

Returns or sets the type of header record.

For Microsoft CRM, this value maps to the entity logical name (e.g., quote, salesorder, etc.).
For Microsoft AX, this value maps to the entity type name (e.g., SalesOrder, SalesQuotation etc.).
For Microsoft NAV, this value maps to the entity type name (e.g., SalesOrder, SalesQuote).

string

Returns or sets the identifier of the header record. For Microsoft CRM, this value is a GUID in string form. For Microsoft NAV and AX, it is a number.

Returns

ConfigurationMetadata

The ConfigurationMetadata object is returned by the GetMetadata method and contains the following properties.

Properties

Data Type	Property	Description
ConfigHeader	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.