InsertOptionValueRequest Class

 

Updated: November 29, 2016

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

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.

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

SystemObject
  Microsoft.Xrm.SdkOrganizationRequest
    Microsoft.Xrm.Sdk.MessagesInsertOptionValueRequest

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodInsertOptionValueRequest

Initializes a new instance of the InsertOptionValueRequest class

NameDescription
System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets a description for the option. Optional.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the label for the option. Required.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets or sets the value for the option. Optional.

NameDescription
System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_pubmethodToString

(Inherited from Object.)

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

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.

No code example is currently available or this language may not be supported.

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

No code example is currently available or this language may not be supported.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: