RetrieveUnpublishedRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class RetrieveUnpublishedRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveUnpublishedRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveUnpublishedRequest = class
    inherit OrganizationRequest

Public NotInheritable Class RetrieveUnpublishedRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RetrieveUnpublishedRequest

Attributes: DataContractAttribute

Remarks

For the Web API use the RetrieveUnpublished function.

Usage

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 Tables

See Message support for tables for an example query you can use to get the list of tables you can use with the RetrieveUnpublished message.

Constructors

RetrieveUnpublishedRequest()

Initializes a new instance of the RetrieveUnpublishedRequest class.

Properties

ColumnSet	Gets or sets the collection of attributes for which non-null values are returned from a query. Required.
ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
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)
Target	Gets or sets the target record for the operation. Required.

Applies to

Freigeben über