DeleteOptionValueRequest DeleteOptionValueRequest DeleteOptionValueRequest DeleteOptionValueRequest Class

Definition

Contains the data that is needed to delete an option value in a global or local option set.

For the Web API use the DeleteOptionValue Action.

public ref class DeleteOptionValueRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DeleteOptionValueRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type DeleteOptionValueRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeleteOptionValueRequest
Inherits OrganizationRequest
Inheritance
DeleteOptionValueRequestDeleteOptionValueRequestDeleteOptionValueRequestDeleteOptionValueRequest
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.

// Use the DeleteOptionValueRequest message 
// to remove the newly inserted label.
DeleteOptionValueRequest deleteOptionValueRequest =
    new DeleteOptionValueRequest
{
    OptionSetName = _globalOptionSetName,
    Value = _insertedOptionValue
};

// Execute the request. svc.Execute(deleteOptionValueRequest);

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

Privileges and Access Rights

To perform this action, the caller must have privileges listed in DeleteOptionValue message privileges.

Notes for Callers

Use the OptionSetName property when working with global option sets. For local option sets in a picklist attribute, use the EntityLogicalName and AttributeLogicalName properties.

Constructors

DeleteOptionValueRequest() DeleteOptionValueRequest() DeleteOptionValueRequest() DeleteOptionValueRequest()

Initializes a new instance of the DeleteOptionValueRequest class

Properties

AttributeLogicalName AttributeLogicalName AttributeLogicalName AttributeLogicalName

Gets or sets the logical name of the attribute from which to delete the option value. Optional.

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

Gets or sets the logical name of the entity that contains the attribute. Optional.

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)
OptionSetName OptionSetName OptionSetName OptionSetName

Gets or sets the name of the option set that contains the value. Optional.

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)
SolutionUniqueName SolutionUniqueName SolutionUniqueName SolutionUniqueName

Gets or sets the solution name associated with this option value. Optional.

Value Value Value Value

Gets or sets the value of the option to delete. Required.

Applies to