RetrieveRequest Class
Definition
Contains the data that is needed to retrieve a record.
public ref class RetrieveRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type RetrieveRequest = class
inherit OrganizationRequest
Public NotInheritable Class RetrieveRequest
Inherits OrganizationRequest
- Inheritance
- Attributes
Examples
The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface.
//Create the request
RetrieveRequest request = new RetrieveRequest();
request.ColumnSet = new ColumnSet(new string[] { "birthdate" });
request.Target = new EntityReference(EntityName.Contact, contactId);
//Retrieve the entity to determine what the birthdate is set at
Entity entity = (Entity)((RetrieveResponse)svc.Execute(request)).Entity;
The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.
Remarks
Message Availability
This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities
later in this topic.
Usage
Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RetrieveResponse class.
Privileges and Access Rights
To perform this action, the caller must have access rights on the specified records in the Target property. For a list of the required privileges, see Retrieve message privileges.
Notes for Callers
The returned record contains the values for the properties that are specified in the ColumnSet property for which the calling user has access rights. No other property values are returned. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365.
Supported Entities
You can use this method to retrieve any records for entities (includes custom entities) that support the Retrieve
message.
The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.
Entity
Availability
Account |
2 (Both) |
ActivityMimeAttachment |
2 (Both) |
ActivityPointer |
2 (Both) |
Annotation |
2 (Both) |
AnnualFiscalCalendar |
2 (Both) |
Appointment |
2 (Both) |
AsyncOperation |
2 (Both) |
AttributeMap |
2 (Both) |
Audit |
2 (Both) |
BulkDeleteFailure |
2 (Both) |
BulkDeleteOperation |
2 (Both) |
BulkOperation |
2 (Both) |
BulkOperationLog |
2 (Both) |
BusinessUnit |
2 (Both) |
BusinessUnitNewsArticle |
2 (Both) |
Calendar |
2 (Both) |
Campaign |
2 (Both) |
CampaignActivity |
2 (Both) |
CampaignResponse |
2 (Both) |
ColumnMapping |
2 (Both) |
Competitor |
2 (Both) |
Connection |
2 (Both) |
ConnectionRole |
2 (Both) |
ConnectionRoleObjectTypeCode |
2 (Both) |
ConstraintBasedGroup |
2 (Both) |
Contact |
2 (Both) |
Contract |
2 (Both) |
ContractDetail |
2 (Both) |
ContractTemplate |
2 (Both) |
ConvertRule |
2 (Both) |
ConvertRuleItem |
2 (Both) |
CustomerAddress |
2 (Both) |
CustomerOpportunityRole |
2 (Both) |
CustomerRelationship |
2 (Both) |
Dependency |
2 (Both) |
Discount |
2 (Both) |
DiscountType |
2 (Both) |
DisplayString |
2 (Both) |
DuplicateRecord |
2 (Both) |
DuplicateRule |
2 (Both) |
DuplicateRuleCondition |
2 (Both) |
DynamicProperty |
2 (Both) |
DynamicPropertyAssociation |
2 (Both) |
DynamicPropertyInstance |
2 (Both) |
DynamicPropertyOptionSetItem |
2 (Both) |
|
2 (Both) |
EmailServerProfile |
2 (Both) |
Entitlement |
2 (Both) |
EntitlementChannel |
2 (Both) |
EntitlementTemplate |
2 (Both) |
EntitlementTemplateChannel |
2 (Both) |
EntityMap |
2 (Both) |
Equipment |
2 (Both) |
ExchangeSyncIdMapping |
2 (Both) |
Fax |
2 (Both) |
FieldPermission |
2 (Both) |
FieldSecurityProfile |
2 (Both) |
FixedMonthlyFiscalCalendar |
2 (Both) |
Goal |
2 (Both) |
GoalRollupQuery |
2 (Both) |
HierarchyRule |
2 (Both) |
Import |
2 (Both) |
ImportEntityMapping |
2 (Both) |
ImportFile |
2 (Both) |
ImportJob |
2 (Both) |
ImportLog |
2 (Both) |
ImportMap |
2 (Both) |
Incident |
2 (Both) |
IncidentResolution |
2 (Both) |
InvalidDependency |
2 (Both) |
Invoice |
2 (Both) |
InvoiceDetail |
2 (Both) |
IsvConfig |
2 (Both) |
KbArticle |
2 (Both) |
KbArticleComment |
2 (Both) |
KbArticleTemplate |
2 (Both) |
Lead |
2 (Both) |
LeadAddress |
2 (Both) |
Letter |
2 (Both) |
List |
2 (Both) |
LookUpMapping |
2 (Both) |
Mailbox |
2 (Both) |
MailMergeTemplate |
2 (Both) |
Metric |
2 (Both) |
MonthlyFiscalCalendar |
2 (Both) |
msdyn_PostAlbum |
2 (Both) |
msdyn_PostConfig |
2 (Both) |
msdyn_PostRuleConfig |
2 (Both) |
msdyn_wallsavedquery |
2 (Both) |
msdyn_wallsavedqueryusersettings |
2 (Both) |
Opportunity |
2 (Both) |
OpportunityClose |
2 (Both) |
OpportunityProduct |
2 (Both) |
OrderClose |
2 (Both) |
Organization |
2 (Both) |
OrganizationUI |
2 (Both) |
OwnerMapping |
2 (Both) |
PhoneCall |
2 (Both) |
PickListMapping |
2 (Both) |
PluginAssembly |
2 (Both) |
PluginType |
2 (Both) |
PluginTypeStatistic |
2 (Both) |
Position |
2 (Both) |
Post |
2 (Both) |
PostComment |
2 (Both) |
PostFollow |
2 (Both) |
PostLike |
2 (Both) |
PriceLevel |
2 (Both) |
PrincipalObjectAttributeAccess |
2 (Both) |
Privilege |
2 (Both) |
ProcessSession |
2 (Both) |
ProcessStage |
2 (Both) |
ProcessTrigger |
2 (Both) |
Product |
2 (Both) |
ProductAssociation |
2 (Both) |
ProductPriceLevel |
2 (Both) |
ProductSubstitute |
2 (Both) |
Publisher |
2 (Both) |
PublisherAddress |
2 (Both) |
QuarterlyFiscalCalendar |
2 (Both) |
Queue |
2 (Both) |
QueueItem |
2 (Both) |
Quote |
2 (Both) |
QuoteClose |
2 (Both) |
QuoteDetail |
2 (Both) |
RecurrenceRule |
2 (Both) |
RecurringAppointmentMaster |
2 (Both) |
RelationshipRole |
2 (Both) |
RelationshipRoleMap |
2 (Both) |
Report |
2 (Both) |
ReportCategory |
2 (Both) |
ReportEntity |
2 (Both) |
ReportLink |
2 (Both) |
ReportVisibility |
2 (Both) |
Resource |
2 (Both) |
ResourceGroup |
2 (Both) |
ResourceSpec |
2 (Both) |
Role |
2 (Both) |
RollupField |
2 (Both) |
RoutingRule |
2 (Both) |
RoutingRuleItem |
2 (Both) |
SalesLiterature |
2 (Both) |
SalesLiteratureItem |
2 (Both) |
SalesOrder |
2 (Both) |
SalesOrderDetail |
2 (Both) |
SavedQuery |
2 (Both) |
SavedQueryVisualization |
2 (Both) |
SdkMessage |
2 (Both) |
SdkMessageFilter |
2 (Both) |
SdkMessagePair |
2 (Both) |
SdkMessageProcessingStep |
2 (Both) |
SdkMessageProcessingStepImage |
2 (Both) |
SdkMessageProcessingStepSecureConfig |
2 (Both) |
SdkMessageRequest |
2 (Both) |
SdkMessageRequestField |
2 (Both) |
SdkMessageResponse |
2 (Both) |
SdkMessageResponseField |
2 (Both) |
SemiAnnualFiscalCalendar |
2 (Both) |
Service |
2 (Both) |
ServiceAppointment |
2 (Both) |
ServiceEndpoint |
2 (Both) |
SharePointData |
2 (Both) |
SharePointDocument |
2 (Both) |
SharePointDocumentLocation |
2 (Both) |
SharePointSite |
2 (Both) |
Site |
2 (Both) |
SiteMap |
2 (Both) |
SLA |
2 (Both) |
SLAItem |
2 (Both) |
SLAKPIInstance |
2 (Both) |
SocialActivity |
2 (Both) |
SocialInsightsConfiguration |
2 (Both) |
SocialProfile |
2 (Both) |
Solution |
2 (Both) |
SolutionComponent |
2 (Both) |
Subject |
2 (Both) |
SystemForm |
2 (Both) |
SystemUser |
2 (Both) |
Task |
2 (Both) |
Team |
2 (Both) |
TeamTemplate |
2 (Both) |
Template |
2 (Both) |
Territory |
2 (Both) |
TimeZoneDefinition |
2 (Both) |
TimeZoneLocalizedName |
2 (Both) |
TimeZoneRule |
2 (Both) |
TraceLog |
2 (Both) |
TransactionCurrency |
2 (Both) |
TransformationMapping |
2 (Both) |
TransformationParameterMapping |
2 (Both) |
UoM |
2 (Both) |
UoMSchedule |
2 (Both) |
UserEntityInstanceData |
2 (Both) |
UserEntityUISettings |
2 (Both) |
UserForm |
2 (Both) |
UserQuery |
2 (Both) |
UserQueryVisualization |
2 (Both) |
UserSettings |
2 (Both) |
WebResource |
2 (Both) |
Workflow |
2 (Both) |
WorkflowDependency |
2 (Both) |
WorkflowLog |
2 (Both) |
Constructors
RetrieveRequest() |
Initializes a new instance of the RetrieveRequest 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 |
Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest) |
RelatedEntitiesQuery |
Gets or sets the query that describes the related records to be retrieved. Optional. |
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) |
ReturnNotifications |
For internal use only. |
Target |
Gets or sets the target, which is the record to be retrieved. Required. |