GetMetadata (Stateless)

Method

GetMetadata(ClientConnectInfo connectInfo, ConfigHeader header)

The GetMetadata method retrieves metadata information regarding the configuration for the given header record.

Parameters

ClientConnectInfo

The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.

Properties

The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.

Data Type	Property	Description
string	AuthUserName	Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string	AuthPassword	Returns or sets the password to authenticate the caller to the service.

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.