RetrieveUnpublishedRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveUnpublishedRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveUnpublishedRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveUnpublishedRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RetrieveUnpublishedRequest() | Initializes a new instance of the RetrieveUnpublishedRequest class. |
Properties
Name | Description | |
---|---|---|
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 an asynchronous operation (system job). 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. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 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.
Entity |
Availability |
---|---|
savedquery |
Server |
savedqueryvisualization |
Server |
systemform |
Server |
webresource |
Server |
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
RetrieveRequest
RetrieveUnpublishedMultipleRequest
Microsoft.Crm.Sdk.Messages Namespace
Publish customizations
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright