Compartilhar via


ExecuteByIdSavedQueryRequest Class

Definition

Contains the data that is needed to execute a saved query (view) that has the specified ID.

public ref class ExecuteByIdSavedQueryRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExecuteByIdSavedQueryRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type ExecuteByIdSavedQueryRequest = class
    inherit OrganizationRequest
Public NotInheritable Class ExecuteByIdSavedQueryRequest
Inherits OrganizationRequest
Inheritance
ExecuteByIdSavedQueryRequest
Attributes

Remarks

Usage

Pass an instance of this class to theExecute(OrganizationRequest) 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.

Constructors

ExecuteByIdSavedQueryRequest()

Initializes a new instance of the ExecuteByIdSavedQueryRequest class.

Properties

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 the request. Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also