ExecuteByIdSavedQueryRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to execute a saved query (view) that has the specified ID.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ExecuteByIdSavedQueryRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExecuteByIdSavedQueryRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ExecuteByIdSavedQueryRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
ExecuteByIdSavedQueryRequest() | Initializes a new instance of the ExecuteByIdSavedQueryRequest class. |
Properties
Name | Description | |
---|---|---|
EntityId | Gets or sets the ID of the saved query (view) to execute. |
|
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.) |
|
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.
Usage
Pass an instance of this class to theExecute method, which returns an instance ofExecuteByIdSavedQueryResponse.
Privileges and Access Rights
To perform this action, the caller must have privileges on the SavedQuery entity access rights on the record specified by the EntityIdproperty. For a complete list of the privileges required, see ExecuteByIdSavedQuery message privileges.
Notes for Callers
This message returns a String type that specifies the XML data containing the results of the query. This XML string is in the following format:
<resultset> + <result>result1</result><result>result2</result> + ... + </resultset>
The XML string returned from this method may contain multiple entity instances. If no instances are returned, the method simply returns an XML document for the entity type, with no data.
The XML string returned from this method does not contain elements for attributes where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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.
See Also
ExecuteByIdSavedQueryResponse
Microsoft.Crm.Sdk.Messages Namespace
SavedQuery (view) entity messages and methods
Sample: Work with views
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright