RetrieveFilteredFormsRequest RetrieveFilteredFormsRequest RetrieveFilteredFormsRequest RetrieveFilteredFormsRequest Class

Definition

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

For the Web API use the RetrieveFilteredForms Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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
type RetrieveFilteredFormsRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveFilteredFormsRequest
Inherits OrganizationRequest
Inheritance
RetrieveFilteredFormsRequestRetrieveFilteredFormsRequestRetrieveFilteredFormsRequestRetrieveFilteredFormsRequest
Attributes

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 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() RetrieveFilteredFormsRequest() RetrieveFilteredFormsRequest() RetrieveFilteredFormsRequest()

Initializes a new instance of the RetrieveFilteredFormsRequest class.

Properties

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

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

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
FormType FormType FormType FormType

Gets or sets the type of form. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

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

(Inherited from OrganizationRequest)
SystemUserId SystemUserId SystemUserId SystemUserId

Gets or sets the ID of the user. Required.

Applies to