InsertOptionValueRequest Class

Definition

Contains the data that is needed to insert a new option value for a global or local option set.

For the Web API use the InsertOptionValue Action.

public ref class InsertOptionValueRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class InsertOptionValueRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type InsertOptionValueRequest = class
    inherit OrganizationRequest
Public NotInheritable Class InsertOptionValueRequest
Inherits OrganizationRequest
Inheritance
InsertOptionValueRequest
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 a request.
InsertOptionValueRequest insertOptionValueRequest =
    new InsertOptionValueRequest
{
    AttributeLogicalName = "new_picklist",
    EntityLogicalName = Contact.EntityLogicalName,
    Label = new Label("New Picklist Label", _languageCode)
};

// Execute the request.
int insertOptionValue = ((InsertOptionValueResponse)svc.Execute(
    insertOptionValueRequest)).NewOptionValue;

Console.WriteLine("Created {0} with the value of {1}.",
    insertOptionValueRequest.Label.LocalizedLabels[0].Label,
    insertOptionValue);

The following example shows how to insert a new option into a global option set.

// Use InsertOptionValueRequest to insert a new option into a 
// global option set.
InsertOptionValueRequest insertOptionValueRequest =
    new InsertOptionValueRequest
    {
        OptionSetName = _globalOptionSetName,
        Label = new Label("New Picklist Label", _languageCode)
    };

// Execute the request and store the newly inserted option value 
// for cleanup, used in the later part of this sample.
_insertedOptionValue = ((InsertOptionValueResponse)svc.Execute(
    insertOptionValueRequest)).NewOptionValue;

//Publish the OptionSet
PublishXmlRequest pxReq2 = new PublishXmlRequest { ParameterXml = String.Format("<importexportxml><optionsets><optionset>{0}</optionset></optionsets></importexportxml>", _globalOptionSetName) };
svc.Execute(pxReq2);

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.

attributes#WorkWithAttributes7 attributesVB#WorkWithAttributes7

The following example shows how to insert a new option into a global option set.

optionsets#WorkwithGlobalOptionSets5 optionsetsVB#WorkwithGlobalOptionSets5

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

Privileges and Access Rights

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

Notes for Callers

Use this message to update global option sets or local option sets within picklist attributes.

When you update a global option set only Label and OptionSetName are required.

When you update a local option set only AttributeLogicalName, EntityLogicalName, and Label are required.

Constructors

InsertOptionValueRequest()

Initializes a new instance of the InsertOptionValueRequest class

Properties

AttributeLogicalName

Gets or sets the name of the attribute when updating a local option set in a picklist attribute. Optional.

Description

Gets or sets a description for the option. Optional.

EntityLogicalName

Gets or sets the logical name of the entity when updating the local option set in a picklist attribute. Optional.

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

Gets or sets the label for the option. Required.

OptionSetName

Gets or sets the name of the global option set. Optional.

Parameters

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

(Inherited from OrganizationRequest)
ParentValues
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)
SolutionUniqueName

Gets or sets the unique name of the unmanaged solution when updating a global option set. Optional.

Value

Gets or sets the value for the option. Optional.

Applies to