CRMProcess.GetEntityByAttributeId Method

  • Article

The GetEntityByAttributeId method retrieves the XML data for an object by the specified attribute ID. See Remarks.

Syntax

[Visual Basic .NET]
Public Function GetEntityByAttributeId(
  ByVal Caller As CUserAuth,
  ByVal AttributeId As String
) As String
[C#]
public string GetEntityByAttributeId(
  CUserAuth  Caller,
  string  AttributeId
);
[C++]
public: String* GetEntityByAttributeId(
  CUserAuth*  Caller,
  String*  AttributeId
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadWorkflowProcess privilege to perform this action. See CUserAuth.

AttributeId

Specifies the ID of the attribute to find.

Return Value

Returns a String type that specifies the XML data containing the entity.

Remarks

Every object and field in Microsoft CRM is specified by a GUID. The object XML data that is returned by the GetEntityByAttributeId method contains the GUID for both the object (entityid) and each of its fields (attributeid). You can determine the attributeid for a particular field from this XML data for the object. The attributeid is a required field for WFPM_PROPERTY, WFPM_PROCESS, and WFPM_ACTION in the WORKFLOW_PARAMETER_TYPE class.

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMProcess proxy object
Microsoft.CRM.Proxy.CRMProcess  process = new Microsoft.CRM.Proxy.CRMProcess();
process.Credentials = System.Net.CredentialCache.DefaultCredentials;
process.Url = strDir + "CRMProcess.srf";

string strErrorMsg;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strAtributeId = "{E10A1960-6EEE-4A90-8348-9147FD923FC4}";

   // Get the entity
   string strEntity = process.GetEntityByAttributeId(userAuth, strAtributeId);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.CRM.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.