RetrieveMultipleRequest Class

Artikkeli
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data that is needed to retrieve a collection of records that satisfy the specified query criteria.

Namespace: Microsoft.Xrm.Sdk.Messages
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveMultipleRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")]
public ref class RetrieveMultipleRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts")>]
type RetrieveMultipleRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class RetrieveMultipleRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveMultipleRequest()	Initializes a new instance of the RetrieveMultipleRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Query	Gets or sets the query criteria for the retrieval. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities later in this topic.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveMultipleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entities in the Query property and read access rights on the records that are returned from the query. For a list of the required privileges, see RetrieveMultiple message privileges.

Notes for Callers

This message supports queries that use Query Expression and FetchXML. For more information, see Retrieve data with queries. You can also use the RetrieveMultiple method.

The collection of returned records from this message contains only the records for which the caller has read access. The returned records contain values for specified properties in the ColumnSet parameter that are valid for retrieval and for which the calling user has access rights. Any other property values are not returned. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics CRM.

Supported Entities

You can use this method to retrieve any records for entities that support the RetrieveMultiple message, including custom entities.

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.

Entity	Availability
Account	2 (Both)
AccountLeads	2 (Both)
ActivityMimeAttachment	2 (Both)
ActivityParty	2 (Both)
ActivityPointer	2 (Both)
Annotation	2 (Both)
AnnualFiscalCalendar	2 (Both)
Appointment	2 (Both)
AsyncOperation	2 (Both)
AttributeMap	2 (Both)
Audit	2 (Both)
BulkDeleteFailure	2 (Both)
BulkDeleteOperation	2 (Both)
BulkOperation	2 (Both)
BulkOperationLog	2 (Both)
BusinessUnit	2 (Both)
BusinessUnitNewsArticle	2 (Both)
Calendar	2 (Both)
Campaign	2 (Both)
CampaignActivity	2 (Both)
CampaignActivityItem	2 (Both)
CampaignItem	2 (Both)
CampaignResponse	2 (Both)
ColumnMapping	2 (Both)
Competitor	2 (Both)
CompetitorProduct	2 (Both)
CompetitorSalesLiterature	2 (Both)
Connection	2 (Both)
ConnectionRole	2 (Both)
ConnectionRoleAssociation	2 (Both)
ConnectionRoleObjectTypeCode	2 (Both)
ConstraintBasedGroup	2 (Both)
Contact	2 (Both)
ContactInvoices	2 (Both)
ContactLeads	2 (Both)
ContactOrders	2 (Both)
ContactQuotes	2 (Both)
Contract	2 (Both)
ContractDetail	2 (Both)
ContractTemplate	2 (Both)
ConvertRule	2 (Both)
ConvertRuleItem	2 (Both)
CustomerAddress	2 (Both)
CustomerOpportunityRole	2 (Both)
CustomerRelationship	2 (Both)
Dependency	2 (Both)
Discount	2 (Both)
DiscountType	2 (Both)
DisplayString	2 (Both)
DuplicateRecord	2 (Both)
DuplicateRule	2 (Both)
DuplicateRuleCondition	2 (Both)
DynamicProperty	2 (Both)
DynamicPropertyAssociation	2 (Both)
DynamicPropertyInstance	2 (Both)
DynamicPropertyOptionSetItem	2 (Both)
Email	2 (Both)
EmailServerProfile	2 (Both)
Entitlement	2 (Both)
EntitlementChannel	2 (Both)
EntitlementContacts	2 (Both)
EntitlementProducts	2 (Both)
EntitlementTemplate	2 (Both)
EntitlementTemplateChannel	2 (Both)
EntitlementTemplateProducts	2 (Both)
EntityMap	2 (Both)
Equipment	2 (Both)
ExchangeSyncIdMapping	2 (Both)
Fax	2 (Both)
FieldPermission	2 (Both)
FieldSecurityProfile	2 (Both)
FixedMonthlyFiscalCalendar	2 (Both)
Goal	2 (Both)
GoalRollupQuery	2 (Both)
HierarchyRule	2 (Both)
HierarchySecurityConfiguration	2 (Both)
Import	2 (Both)
ImportEntityMapping	2 (Both)
ImportFile	2 (Both)
ImportJob	2 (Both)
ImportLog	2 (Both)
ImportMap	2 (Both)
Incident	2 (Both)
IncidentResolution	2 (Both)
InvalidDependency	2 (Both)
Invoice	2 (Both)
InvoiceDetail	2 (Both)
IsvConfig	2 (Both)
KbArticle	2 (Both)
KbArticleComment	2 (Both)
KbArticleTemplate	2 (Both)
Lead	2 (Both)
LeadAddress	2 (Both)
LeadCompetitors	2 (Both)
LeadProduct	2 (Both)
Letter	2 (Both)
License	2 (Both)
List	2 (Both)
ListMember	2 (Both)
LookUpMapping	2 (Both)
Mailbox	2 (Both)
MailMergeTemplate	2 (Both)
Metric	2 (Both)
MonthlyFiscalCalendar	2 (Both)
msdyn_PostAlbum	2 (Both)
msdyn_PostConfig	2 (Both)
msdyn_PostRuleConfig	2 (Both)
msdyn_wallsavedquery	2 (Both)
msdyn_wallsavedqueryusersettings	2 (Both)
Opportunity	2 (Both)
OpportunityClose	2 (Both)
OpportunityCompetitors	2 (Both)
OpportunityProduct	2 (Both)
OrderClose	2 (Both)
Organization	2 (Both)
OrganizationUI	2 (Both)
OwnerMapping	2 (Both)
PhoneCall	2 (Both)
PickListMapping	2 (Both)
PluginAssembly	2 (Both)
PluginType	2 (Both)
PluginTypeStatistic	2 (Both)
Position	2 (Both)
Post	2 (Both)
PostComment	2 (Both)
PostFollow	2 (Both)
PostLike	2 (Both)
PriceLevel	2 (Both)
PrincipalObjectAttributeAccess	2 (Both)
Privilege	2 (Both)
ProcessSession	2 (Both)
ProcessStage	2 (Both)
ProcessTrigger	2 (Both)
Product	2 (Both)
ProductAssociation	2 (Both)
ProductPriceLevel	2 (Both)
ProductSalesLiterature	2 (Both)
ProductSubstitute	2 (Both)
Publisher	2 (Both)
PublisherAddress	2 (Both)
QuarterlyFiscalCalendar	2 (Both)
Queue	2 (Both)
QueueItem	2 (Both)
QueueMembership	2 (Both)
Quote	2 (Both)
QuoteClose	2 (Both)
QuoteDetail	2 (Both)
RecurrenceRule	2 (Both)
RecurringAppointmentMaster	2 (Both)
RelationshipRole	2 (Both)
RelationshipRoleMap	2 (Both)
Report	2 (Both)
ReportCategory	2 (Both)
ReportEntity	2 (Both)
ReportLink	2 (Both)
ReportVisibility	2 (Both)
Resource	2 (Both)
ResourceGroup	2 (Both)
ResourceSpec	2 (Both)
Role	2 (Both)
RolePrivileges	2 (Both)
RollupField	2 (Both)
RoutingRule	2 (Both)
RoutingRuleItem	2 (Both)
SalesLiterature	2 (Both)
SalesLiteratureItem	2 (Both)
SalesOrder	2 (Both)
SalesOrderDetail	2 (Both)
SavedQuery	2 (Both)
SavedQueryVisualization	2 (Both)
SdkMessage	2 (Both)
SdkMessageFilter	2 (Both)
SdkMessagePair	2 (Both)
SdkMessageProcessingStep	2 (Both)
SdkMessageProcessingStepImage	2 (Both)
SdkMessageProcessingStepSecureConfig	2 (Both)
SdkMessageRequest	2 (Both)
SdkMessageRequestField	2 (Both)
SdkMessageResponse	2 (Both)
SdkMessageResponseField	2 (Both)
SemiAnnualFiscalCalendar	2 (Both)
Service	2 (Both)
ServiceAppointment	2 (Both)
ServiceContractContacts	2 (Both)
ServiceEndpoint	2 (Both)
SharePointData	2 (Both)
SharePointDocument	2 (Both)
SharePointDocumentLocation	2 (Both)
SharePointSite	2 (Both)
Site	2 (Both)
SiteMap	2 (Both)
SLA	2 (Both)
SLAItem	2 (Both)
SLAKPIInstance	2 (Both)
SocialActivity	2 (Both)
SocialInsightsConfiguration	2 (Both)
SocialProfile	2 (Both)
Solution	2 (Both)
SolutionComponent	2 (Both)
Subject	2 (Both)
SubscriptionTrackingDeletedObject	2 (Both)
SystemForm	2 (Both)
SystemUser	2 (Both)
SystemUserLicenses	2 (Both)
SystemUserProfiles	2 (Both)
SystemUserRoles	2 (Both)
Task	2 (Both)
Team	2 (Both)
TeamMembership	2 (Both)
TeamProfiles	2 (Both)
TeamRoles	2 (Both)
TeamTemplate	2 (Both)
Template	2 (Both)
Territory	2 (Both)
TimeZoneDefinition	2 (Both)
TimeZoneLocalizedName	2 (Both)
TimeZoneRule	2 (Both)
TraceLog	2 (Both)
TransactionCurrency	2 (Both)
TransformationMapping	2 (Both)
TransformationParameterMapping	2 (Both)
UoM	2 (Both)
UoMSchedule	2 (Both)
UserEntityInstanceData	2 (Both)
UserEntityUISettings	2 (Both)
UserForm	2 (Both)
UserQuery	2 (Both)
UserQueryVisualization	2 (Both)
UserSettings	2 (Both)
WebResource	2 (Both)
Workflow	2 (Both)
WorkflowDependency	2 (Both)
WorkflowLog	2 (Both)

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


#region Retrieve records from an intersect table via QueryExpression

//Create Query Expression.
QueryExpression query = new QueryExpression()
{
    EntityName = "role",
    ColumnSet = new ColumnSet("name"),
    LinkEntities = 
    {
        new LinkEntity
        {
            LinkFromEntityName = Role.EntityLogicalName,
            LinkFromAttributeName = "roleid",
            LinkToEntityName = SystemUserRoles.EntityLogicalName,
            LinkToAttributeName = "roleid",
            LinkCriteria = new FilterExpression
            {
                FilterOperator = LogicalOperator.And,
                Conditions = 
                {
                    new ConditionExpression
                    {
                        AttributeName = "systemuserid",
                        Operator = ConditionOperator.Equal,
                        Values = { _userId }
                    }
                }
            }
        }
    }
};

// Obtain results from the query expression.
EntityCollection ec = _serviceProxy.RetrieveMultiple(query);

// Display results.
for (int i = 0; i < ec.Entities.Count; i++)
{
    Console.WriteLine("Query Expression Retrieved: {0}", ((Role)ec.Entities[i]).Name);
}

#endregion


'                   #Region "Retrieve records from an intersect table via QueryExpression"

'Create Query Expression.
Dim query As New QueryExpression() With
    {
        .EntityName = "role",
        .ColumnSet = New ColumnSet("name")
    }

Dim queryLinkEntity As New LinkEntity With
    {
        .LinkToEntityName = SystemUserRoles.EntityLogicalName,
        .LinkFromAttributeName = "roleid",
        .LinkToAttributeName = "roleid"
    }
queryLinkEntity.LinkCriteria().AddCondition(
    "systemuserid",
    ConditionOperator.Equal,
    _userId)
queryLinkEntity.LinkCriteria().FilterOperator = LogicalOperator.And
query.LinkEntities().Add(queryLinkEntity)

' Obtain results from the query expression.
Dim ec As EntityCollection = _serviceProxy.RetrieveMultiple(query)

' Display results.
For i As Integer = 0 To ec.Entities.Count - 1
    Console.WriteLine("Query Expression Retrieved: {0}",
                      (CType(ec.Entities(i), Role)).Name)
Next i

'                   #End Region

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Jaa