RetrieveUnpublishedMultipleRequest RetrieveUnpublishedMultipleRequest RetrieveUnpublishedMultipleRequest RetrieveUnpublishedMultipleRequest Class

Definition

Contains the data that is needed to retrieve a collection of unpublished organization-owned records that satisfy the specified query criteria.

For the Web API use the RetrieveUnpublishedMultiple Function.

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

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entities in the Query property and read access rights on the records that are returned from the query. For a list of the required privileges, see RetrieveUnpublishedMultiple message privileges.

Notes for Callers

This message is included to support scenarios where you are creating a program to edit these types of entity records.

These organization-owned entities can be published. This message corresponds to the RetrieveMultipleRequest message except that it returns the current unpublished version of the records. As soon as the records are published, this message and RetrieveMultipleRequest return the same data.

Because these records are automatically published when they are created or deleted, this message and RetrieveMultipleRequest always return the same number of records.

Supported Entities

The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available.

Entity

Availability

SavedQuery

Server

SavedQueryVisualization

Server

SiteMap

Server

SystemForm

Server

WebResource

Server

Constructors

RetrieveUnpublishedMultipleRequest() RetrieveUnpublishedMultipleRequest() RetrieveUnpublishedMultipleRequest() RetrieveUnpublishedMultipleRequest()

Initializes a new instance of the RetrieveUnpublishedMultipleRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
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)
Query Query Query Query

Gets or sets the query criteria defining the records to retrieve.Required.

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)

Applies to

See also