This topic has not yet been rated - Rate this topic

RetrieveUnpublishedRequest Class

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online]

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

'Usage

Syntax

C++

[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveUnpublishedRequest : OrganizationRequest

JScript

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 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 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.