RetrieveOptionSetRequest Class

Definition

public ref class RetrieveOptionSetRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveOptionSetRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type RetrieveOptionSetRequest = class
 inherit OrganizationRequest

Public NotInheritable Class RetrieveOptionSetRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

RetrieveOptionSetRequest

Attributes

DataContractAttribute

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

/// <summary>
/// Retrieves a global choice column by name
/// </summary>
/// <param name="service">Authenticated IOrganizationService instance</param>
static void RetrieveGlobalOptionSetExample(IOrganizationService service)
{

 string globalChoiceName = "componentstate";

 // A boolean global choice: "cardtype_isenabled"; 

 // Use the RetrieveOptionSetRequest message to retrieve 
 // a global option set by it's name.
 RetrieveOptionSetRequest request = new()
 {
 Name = globalChoiceName,
 // MetadataId not used in this example
 };

 // Execute the request.
 var response = (RetrieveOptionSetResponse)service.Execute(request);

 //Write the options:
 switch (response.OptionSetMetadata.OptionSetType)
 {
 case OptionSetType.Picklist:

 var options = (OptionSetMetadata)response.OptionSetMetadata;
 foreach (var item in options.Options)
 {
 Console.WriteLine($"{item.Value}:{item.Label.UserLocalizedLabel.Label}");
 }

 break;
 case OptionSetType.Boolean:
 var booleanOptions = (BooleanOptionSetMetadata)response.OptionSetMetadata;

 Console.WriteLine($"{booleanOptions.TrueOption.Value}:" +
 $"{booleanOptions.TrueOption.Label.UserLocalizedLabel.Label}");
 Console.WriteLine($"{booleanOptions.FalseOption.Value}:" +
 $"{booleanOptions.FalseOption.Label.UserLocalizedLabel.Label}");

 break;
 default:
 // This shouldn't occur
 break;
 }
}

Output:

0:Published
1:Unpublished
2:Deleted
3:Deleted Unpublished 

Sample code on GitHub

Work with choice columns

Remarks

You cannot retrieve choice data for local choice columns using this message. This message only returns data for global ('re-usable') choice columns. Learn more about choice columns

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of RetrieveOptionSetResponse.

Privileges and Access Rights

Choice definition information is available for all users.