RetrieveFilteredFormsRequest Class

Definition

Contains the data that is needed to retrieve the entity forms that are available for a specified user.

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

Remarks

For the Web API use the RetrieveFilteredForms function.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in RetrieveFilteredForms message privileges.

Constructors

RetrieveFilteredFormsRequest()

Initializes a new instance of the RetrieveFilteredFormsRequest class.

Properties

EntityLogicalName

Gets or sets the logical name for the entity. Required.

ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
FormType

Gets or sets the type of form. Required.

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)
SystemUserId

Gets or sets the ID of the user. Required.

Applies to