RetrieveUnpublishedRequest RetrieveUnpublishedRequest RetrieveUnpublishedRequest RetrieveUnpublishedRequest Class


Contains the data that is needed to retrieve an unpublished record.

public ref class RetrieveUnpublishedRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class RetrieveUnpublishedRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveUnpublishedRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveUnpublishedRequest
Inherits OrganizationRequest


Message Availability

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


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

Privileges and Access Rights

To perform this action, the caller must have read access rights on the record specified in the Target property and the privileges that are listed in RetrieveUnpublished 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 RetrieveRequest class except that it returns the current unpublished version of the record. When the record is published, this method and RetrieveRequest return the same data.

Because these records are automatically published when they are created or deleted, this message and RetrieveRequest only retrieve different data when a record has been updated but not published.

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.












RetrieveUnpublishedRequest() RetrieveUnpublishedRequest() RetrieveUnpublishedRequest() RetrieveUnpublishedRequest()

Initializes a new instance of the RetrieveUnpublishedRequest class.


ColumnSet ColumnSet ColumnSet ColumnSet

Gets or sets the collection of attributes for which non-null values are returned from a query. Required.

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

Gets or sets the target record for the operation. Required.

Applies to

See also