CrmService.Retrieve Method
.gif) |
Retrieves an entity instance using the specified ID.
Syntax
[Visual Basic]
Public Function Retrieve(
ByVal entityName As String,
ByVal id As Guid,
ByVal columnSet As ColumnSetBase
) As BusinessEntity
[C#]
public BusinessEntity Retrieve(
string entityName,
Guid id,
ColumnSetBase columnSet
);
[JScript]
public function Retrieve(
entityName : String,
id : Guid,
columnSet : ColumnSetBase
) : BusinessEntity;
Parameters
entityName
Specifies the name of entity to retrieve. See Entity Names.
id
Specifies the ID of the entity to retrieve.
columnSet
Specifies the set of columns to retrieve. Pass null to retrieve only the primary key. To retrieve all columns, pass a new instance of the AllColumns class. See ColumnSetBase.
Return Value
Returns the BusinessEntity requested. The BusinessEntity contains only the columns specified by the columnSet parameter. The entity is of the type specified by the entityName parameter.
Remarks
Use this method to retrieve an instance of a Microsoft CRM entity.
To perform this action, the caller must have the Read privilege to the entity type being retrieved and access rights on the entity instance specified in the request class.
Example
The following example demonstrates the use of the Retrieve method.
[C#]
// Set up the CRM Service.
CrmService service = new CrmService();
service.Credentials = System.Net.CredentialCache.DefaultCredentials;
// Create the column set object that indicates the fields to be retrieved.
ColumnSet cols = new ColumnSet();
// Set the properties of the column set.
cols.Attributes = new string [] {"fullname"};
// contactGuid is the GUID of the record being retrieved.
Guid contactGuid = new Guid("4D507FFE-ED25-447B-80DE-00AE3EB18B84");
// Retrieve the contact.
// The EntityName indicates the EntityType of the object being retrieved.
contact contact = (contact)service.Retrieve(EntityName.contact.ToString(), contactGuid, cols);
[Visual Basic .NET]
' Set up the CRM Service.
Dim service As New CrmService()
service.Credentials = System.Net.CredentialCache.DefaultCredentials
' Create the column set object that indicates the fields to be retrieved.
Dim cols As New ColumnSet()
' Set the column set properties.
cols.Attributes = New String() {"fullname"}
' contactGuid is the GUID of the record being retrieved.
Guid contactGuid = new Guid("4D507FFE-ED25-447B-80DE-00AE3EB18B84");
' Retrieve the contact.
' The EntityName indicates the EntityType of the object being retrieved.
Dim contact As contact = CType(service.Retrieve(EntityName.contact.ToString(), contactGuid, cols), contact)
See Also