RetrieveAbsoluteAndSiteCollectionUrlRequest RetrieveAbsoluteAndSiteCollectionUrlRequest RetrieveAbsoluteAndSiteCollectionUrlRequest RetrieveAbsoluteAndSiteCollectionUrlRequest Class

Definition

Contains the data that is needed to retrieve the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365.

For the Web API use the RetrieveAbsoluteAndSiteCollectionUrl Function.

public ref class RetrieveAbsoluteAndSiteCollectionUrlRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveAbsoluteAndSiteCollectionUrlRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveAbsoluteAndSiteCollectionUrlRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveAbsoluteAndSiteCollectionUrlRequest
Inherits OrganizationRequest
Inheritance
RetrieveAbsoluteAndSiteCollectionUrlRequestRetrieveAbsoluteAndSiteCollectionUrlRequestRetrieveAbsoluteAndSiteCollectionUrlRequestRetrieveAbsoluteAndSiteCollectionUrlRequest
Attributes

Examples


// Retrieve the absolute URL and the Site Collection URL
// of the SharePoint document location record.

var retrieveRequest = new RetrieveAbsoluteAndSiteCollectionUrlRequest
{
    Target = new EntityReference(SharePointDocumentLocation.EntityLogicalName, _spDocLocId)
};

var retriveResponse = (RetrieveAbsoluteAndSiteCollectionUrlResponse)svc.Execute(retrieveRequest);
Console.WriteLine("Absolute URL of document location record is '{0}'.", retriveResponse.AbsoluteUrl.ToString());
Console.WriteLine("Site Collection URL of document location record is '{0}'.", retriveResponse.SiteCollectionUrl.ToString());

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.

SharePointIntegration#RetrieveAbsoluteAndSiteCollectionURLs2 SharePointIntegrationVB#RetrieveAbsoluteAndSiteCollectionURLs2

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(OrganizationRequest) method, which returns an instance of the RetrieveAbsoluteAndSiteCollectionUrlResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the SharepointDocumentLocation and SharepointSite entities and access rights on the specified record in the Target parameter. For a list of the required privileges, see RetrieveAbsoluteAndSiteCollectionUrl message privileges.

Notes for Callers

This message works only if your target server is SharePoint Server 2010 or 2013, and both the following conditions are true:

  • The Microsoft Dynamics CRM List Component for SharePoint Server is installed on the SharePoint site collection on the target SharePoint Server. For more information, see 00e5e847-d64c-46c8-92a2-19bcf17b9a76#CRMListComponent.

  • The location record for the parent SharePoint site collection exists in Microsoft Dynamics 365. In addition, the SharePointSite.IsGridPresent attribute must be set to true when you create the parent location record.

Otherwise, a blank value is returned for the SiteCollectionUrl property.

Constructors

RetrieveAbsoluteAndSiteCollectionUrlRequest() RetrieveAbsoluteAndSiteCollectionUrlRequest() RetrieveAbsoluteAndSiteCollectionUrlRequest() RetrieveAbsoluteAndSiteCollectionUrlRequest()

Initializes a new instance of the RetrieveAbsoluteAndSiteCollectionUrlRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Target Target Target Target

Gets or sets the target for which the data is to be retrieved. Required.

Applies to

See also