RetrieveUnpublishedMultipleRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

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

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

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 a collection of unpublished organization-owned records that satisfy the specified query criteria.

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

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

Public NotInheritable Class RetrieveUnpublishedMultipleRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RetrieveUnpublishedMultipleRequest

Attributes: DataContractAttribute

Remarks

For the Web API use the RetrieveUnpublishedMultiple function.

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.

Notes for Callers

Use this message when 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 Tables

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

Constructors

RetrieveUnpublishedMultipleRequest()

Initializes a new instance of the RetrieveUnpublishedMultipleRequest class.

Properties

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)
Query	Gets or sets the query criteria defining the records to retrieve.Required.
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)

Applies to