RetrieveBusinessHierarchyBusinessUnitRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to retrieve all business units (including the specified business unit) from the business unit hierarchy.

For the Web API use the RetrieveBusinessHierarchyBusinessUnit Function.

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.RetrieveBusinessHierarchyBusinessUnitRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveBusinessHierarchyBusinessUnitRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveBusinessHierarchyBusinessUnitRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveBusinessHierarchyBusinessUnitRequest()

Initializes a new instance of the RetrieveBusinessHierarchyBusinessUnitRequest class.

Properties

Name Description
System_CAPS_pubproperty ColumnSet

Gets or sets the set of attributes to retrieve. Required.

System_CAPS_pubproperty EntityId

Gets or sets the ID of the business unit. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod 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 RetrieveBusinessHierarchyBusinessUnitResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the BusinessUnit entity and access rights on the specified record in the EntityId property. For a complete list of the required privileges, see RetrieveBusinessHierarchyBusinessUnit message privileges.

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

RetrieveBusinessHierarchyBusinessUnitResponse
Microsoft.Crm.Sdk.Messages Namespace
BusinessUnit entity

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright