ExecuteByIdUserQueryRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ExecuteByIdUserQueryRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExecuteByIdUserQueryRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type ExecuteByIdUserQueryRequest = class
    inherit OrganizationRequest

Public NotInheritable Class ExecuteByIdUserQueryRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
ExecuteByIdUserQueryRequest

Attributes: DataContractAttribute

Remarks

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of ExecuteByIdUserQueryResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges and access rights on the entity specified in the EntityId property. For a list of the privileges required, see ExecuteByIdUserQuery 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 records. If no records 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

ExecuteByIdUserQueryRequest()

Initializes a new instance of the ExecuteByIdUserQueryRequest class.

Properties

EntityId	Gets or sets the ID of the user query (saved view) record to be executed.
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