CanBeReferenced Message (MetadataService)
.gif "banner art") |
[Applies to: Microsoft Dynamics CRM 4.0]
Find the latest SDK documentation: CRM 2015 SDK
| Works for all deployment types | Works online only |
Checks to see if the specified entity can be the primary entity (one) in a one-to-many relationship.
The relevant classes are specified in the following table.
| Type | Class |
| Request | CanBeReferencedRequest |
| Response | CanBeReferencedResponse |
Remarks
To perform this action, the caller must be a user in the organization for which metadata is requested and must have Read Attribute, Read Entity and Read Relationship privileges.
Example
The following example shows how to use the CanBeReferenced message.
[C#]
// Create an authentication token.
CrmAuthenticationToken token = new CrmAuthenticationToken();
token.OrganizationName = "AdventureWorksCycle";
// You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0;
// Create the metadata Web service.
MetadataService metadataService = new MetadataService();
metadataService.Url = "http://<servername>:<port>/MSCRMServices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials;
metadataService.PreAuthenticate = true;
// Create the request.
CanBeReferencedRequest validPrimaryEntityRequest = new CanBeReferencedRequest();
validPrimaryEntityRequest.EntityName = EntityName.account.ToString();
// Execute the request.
CanBeReferencedResponse validPrimaryEntityResponse = (CanBeReferencedResponse)metadataService.Execute(validPrimaryEntityRequest);
// Determine if the Account entity can be the primary entity (one) in a one-to-many relationship.
bool bAccountIsValid = validPrimaryEntityResponse.CanBeReferenced;
[Visual Basic .NET]
' Set up the CRM service.
Dim token As New CrmAuthenticationToken()
' You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0
token.OrganizationName = "AdventureWorksCycle";
// Create the metadata Web service.
Dim metadataService As New MetadataService ()
metadataService.Url = "http://<servername>:<port>/mscrmservices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials
metadataService.PreAuthenticate = true;
' Create the request.
Dim validPrimaryEntityRequest As New CanBeReferencedRequest()
validPrimaryEntityRequest.EntityName = EntityName.account.ToString()
' Execute the request.
Dim validPrimaryEntityResponse As CanBeReferencedResponse = CType(metadataService.Execute(validPrimaryEntityRequest), CanBeReferencedResponse)
' Determine if the Account entity can be the primary entity (one) in a one-to-many relationship.
Dim bAccountIsValid As Boolean = validPrimaryEntityResponse.CanBeReferenced
See Also
Concepts
Reference