Add getChoicesetValue API [PLT-93574] #140

Sarath1018 · 2025-12-10T07:06:02Z

Add getById method to ChoiceSetService for retrieving choice set values
Add POST method support to pagination system (first service to use POST for pagination)
Add parseItemsFn to handle API responses that return items as JSON strings

API call: datafabric_/api/EntityService/entity//query_expansion
SDK method: sdk.entities.choicesets.getById()

refer this page for API response and SDK response: https://uipath.atlassian.net/wiki/spaces/~61b7366691c049006fa31d3c/pages/89979912726/getChoicesetValue+-+gets+the+value+of+a+single+CS

Sarath1018 · 2025-12-10T14:29:41Z

src/models/data-fabric/choicesets.types.ts

+  /** Human-readable display name */
+  displayName: string;
+  /** Numeric identifier */
+  numberId: number;


what about ordinal/index instead of numberId

check this name in entity get records response, where a field is choiceset

swati354 · 2025-12-11T02:24:55Z

src/models/data-fabric/choicesets.internal-types.ts

+  CreatedBy: string;
+  UpdatedBy: string;
+  RecordOwner: string;
+}


some if these fields are optional right? for eg RecordOwner

Made them optional, previously they are optional only in SDK response

src/models/data-fabric/entities.constants.ts

swati354 · 2025-12-15T12:22:07Z

src/models/data-fabric/choicesets.types.ts

+/**
+ * Represents a single choice set value/record
+ */
+export interface ChoiceSetValue {


ChoiceSetGetResponse ?

Changed to ChoiceSetValueGetResponse

swati354 · 2025-12-15T12:25:47Z

src/models/data-fabric/choicesets.types.ts

+export type ChoiceSetGetByIdOptions = {
+  /** Level of entity expansion (default: 0) */
+  expansionLevel?: number;
+} & PaginationOptions;


Does the underlying query_expansion api provide other options as well?

swati354 · 2025-12-15T12:31:21Z

src/services/data-fabric/choicesets.ts

+      serviceAccess: this.createPaginationServiceAccess(),
+      getEndpoint: () => DATA_FABRIC_ENDPOINTS.CHOICESETS.GET_BY_ID(choicesetId),
+      transformFn: transformChoiceSetValue,
+      parseItemsFn: parseJsonArray<RawChoiceSetValue>,


can the parseItemsFn method be part of the transformFn itself?

swati354 · 2025-12-15T14:20:35Z

Is it going to be choicesetId or choiceSetId?
In entity files, it is choiceSet, in choiceset files it is choiceset

swati354 · 2025-12-15T14:29:50Z

src/services/data-fabric/choicesets.ts

+    const transformChoiceSetValue = (item: RawChoiceSetValue): ChoiceSetValue => {
+      // First convert PascalCase to camelCase, then rename time fields
+      const camelCased = pascalToCamelCaseKeys(item);
+      return transformData(camelCased, EntityMap) as unknown as ChoiceSetValue;
+    };


can we avoid the as unknown as

Raina451 · 2025-12-16T07:54:42Z

src/models/data-fabric/choicesets.models.ts

+   * @example
+   * ```typescript
+   * // Get all values (non-paginated)
+   * const values = await sdk.entities.choicesets.getById('choiceset-uuid');


use <choicesetId> conventionfor params

Raina451 · 2025-12-16T07:55:12Z

src/models/data-fabric/choicesets.models.ts

+   * const values = await sdk.entities.choicesets.getById('choiceset-uuid', {
+   *   expansionLevel: 1
+   * });


please add what happen with expansionLevel

Raina451 · 2025-12-16T07:56:03Z

src/models/data-fabric/choicesets.internal-types.ts

+/**
+ * Raw ChoiceSet Value API Response (PascalCase from API)
+ */
+export interface RawChoiceSetValue {


RawChoiceSetValueGetResponse ?

Raina451 · 2025-12-16T07:58:02Z

src/models/data-fabric/choicesets.types.ts

+  /** Name of the choice set value */
+  name: string;
+  /** Human-readable display name */
+  displayName: string;


diff between displayName and name? do we need both?

Raina451 · 2025-12-16T07:58:43Z

src/models/data-fabric/choicesets.types.ts

+  /** Human-readable display name */
+  displayName: string;
+  /** Numeric identifier */
+  numberId: number;


check this name in entity get records response, where a field is choiceset

Raina451 · 2025-12-16T08:02:38Z

src/models/data-fabric/entities.constants.ts

  updateTime: 'updatedTime',
  sqlType: 'fieldDataType',
-  fieldDefinition: 'fieldMetaData' 
+  fieldDefinition: 'fieldMetaData'


forwhich sdk method this is intended?

Raina451 · 2025-12-16T08:06:20Z

src/utils/constants/common.ts

+ * Choice Set values endpoint pagination constants
+ * Note: The API returns items as a JSON string in 'jsonValue' field
+ */
+export const CHOICESET_VALUES_PAGINATION = {


should we reuse ENTITY_PAGINATION ?

Raina451 · 2025-12-16T08:07:56Z

src/utils/pagination/helpers.ts

      additionalParams,
      transformFn,
+      parseItemsFn,
+      method = 'GET',


have constant for 'GET'

Raina451 · 2025-12-16T08:08:16Z

src/utils/pagination/helpers.ts

-    const items = response.data?.[itemsField] || [];
+    // Make the API call based on method
+    let response: { data: any };
+    if (method === 'POST') {


const for post

Raina451 · 2025-12-16T08:09:40Z

src/utils/pagination/internal-types.ts

  excludeFromPrefix?: string[];
+
+  /** HTTP method to use for the request (default: 'GET') */
+  method?: 'GET' | 'POST';


should we have enum?

Raina451 · 2025-12-16T08:30:08Z

check if we need an update here

Raina451 · 2025-12-18T03:47:24Z

@Sarath1018 we need add scopes for new sdk methods you are adding in docs: https://uipath.github.io/uipath-typescript/oauth-scopes

JReames · 2026-01-07T19:30:28Z

Summary

The root cause was a mismatch between the entity's data format (Integer) and the Choice Set's primary key format (GUID). By identifying the NumberId property in the choice set definition and mapping it alongside the GUID, we created a robust solution that handles both data types seamlessly. The "Status Unknown" error is resolved, and the solution is fully dynamic, requiring no hardcoded values.

SDK Improvement Proposal

To streamline this in future versions of the UiPath Apps SDK, we recommend the following changes to the uipath-typescript library.

1. Add `ChoiceSetOption` Interface

File: src/models/data-fabric/entities.types.ts

Define the interface to formalize the structure of choice set options, specifically exposing the previously hidden NumberId.

/**
 * Represents a single option within a Choice Set
 */
export interface ChoiceSetOption {
  /** Unqiue GUID identifier */
  id: string;
  /** Display name shown in UI */
  displayName: string;
  /** Internal system name */
  name: string;
  /** Numeric status code (Critical for legacy/integer based choice sets) */
  numberId?: number;
  /** Alternate value field */
  value?: string;
}

2. Implement `getChoiceSet` Method

File: src/services/data-fabric/entities.ts

Add a method to EntityService that fetches choice set options directly by ID or Name, handling the NumberId mapping logic internally.

  /**
   * Gets choice set options by ID
   * 
   * @param id - UUID of the choice set
   * @returns Promise resolving to an array of ChoiceSetOption
   */
  @track('Entities.GetChoiceSet')
  async getChoiceSet(id: string): Promise<ChoiceSetOption[]> {
    const response = await this.getRecordsById(id);
    const items = (response as any).items || (Array.isArray(response) ? response : []);
    
    // Map raw items to typed ChoiceSetOption
    return items.map((item: any) => ({
      id: item.id || item.Id,
      displayName: item.displayName || item.DisplayName || item.name || item.Name,
      name: item.name || item.Name,
      numberId: item.NumberId ?? item.numberId,
      value: item.value || item.Value
    }));
  }

3. Implement `resolveDisplayValue` Helper

File: src/services/data-fabric/entities.ts

Add a helper that takes an entity record and a field name, inspects the metadata to find the choice set, fetches it, and resolves the value.

  /**
   * Resolves the display value for a Choice Set field on a record
   * 
   * @param record - The entity record containing the value
   * @param fieldName - The name of the field to resolve (e.g., 'Status')
   * @param entityMetadata - The entity schema (required to find the ChoiceSet ID)
   */
  async resolveDisplayValue(record: EntityRecord, fieldName: string, entityMetadata: RawEntityGetResponse): Promise<string> {
    const value = record[fieldName];
    if (value === undefined || value === null) return '';

    // Find the field definition
    const field = entityMetadata.fields.find(f => f.name === fieldName);
    if (!field) return String(value);

    // Get Choice Set ID
    const choiceSetId = field.choiceSetId || field.referenceChoiceSet?.id;
    if (!choiceSetId) return String(value);

    // Fetch Options
    // optimization: cache this call
    const options = await this.getChoiceSet(choiceSetId);

    // Try to match by String ID (GUID) or Number ID
    const match = options.find(opt => 
      String(opt.id) === String(value) || 
      (opt.numberId !== undefined && opt.numberId === Number(value))
    );

    return match ? match.displayName : String(value);
  }

4. Expose Methods on Entity Model

File: src/models/data-fabric/entities.models.ts

Update createEntityMethods to expose resolveDisplayValue directly on the entity object for developer convenience.

// In createEntityMethods function:

    async resolveDisplayValue(record: EntityRecord, fieldName: string): Promise<string> {
      return service.resolveDisplayValue(record, fieldName, entityData);
    }

Sarath1018 force-pushed the sarath/getChoicesetValue branch from fe14606 to d063a89 Compare December 10, 2025 07:06

Add getChoicesetValue API

0c862a6

Sarath1018 force-pushed the sarath/getChoicesetValue branch from d063a89 to 0c862a6 Compare December 10, 2025 07:23

Sarath1018 added 2 commits December 10, 2025 13:27

Add fields

0f160f8

Make fields optional

fb59d7f

Sarath1018 requested review from Raina451 and swati354 December 10, 2025 14:00

Sarath1018 commented Dec 10, 2025

View reviewed changes

Update comments

0d007ad

Sarath1018 force-pushed the sarath/getChoicesetValue branch from a01eb00 to 0d007ad Compare December 10, 2025 14:41

Add post method to pagination

8338e62

swati354 reviewed Dec 11, 2025

View reviewed changes

src/models/data-fabric/entities.constants.ts Outdated Show resolved Hide resolved

Review comments

7398957

Sarath1018 requested a review from swati354 December 13, 2025 17:49

swati354 reviewed Dec 15, 2025

View reviewed changes

Sarath1018 changed the title ~~Add getChoicesetValue API~~ Add getChoicesetValue API [PLT-93574] Dec 16, 2025

Raina451 reviewed Dec 16, 2025

View reviewed changes

Nit

94ce698

Sarath1018 force-pushed the sarath/getChoicesetValue branch from 927503d to 94ce698 Compare January 9, 2026 05:49

Add getChoicesetValue API [PLT-93574] #140

Are you sure you want to change the base?

Add getChoicesetValue API [PLT-93574] #140

Uh oh!

Conversation

Sarath1018 commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sarath1018 Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swati354 commented Dec 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Raina451 commented Dec 16, 2025

Uh oh!

Raina451 commented Dec 18, 2025

Uh oh!

JReames commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

SDK Improvement Proposal

1. Add ChoiceSetOption Interface

2. Implement getChoiceSet Method

3. Implement resolveDisplayValue Helper

4. Expose Methods on Entity Model

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Sarath1018 commented Dec 10, 2025 •

edited

Loading

Sarath1018 Dec 10, 2025 •

edited

Loading

JReames commented Jan 7, 2026 •

edited

Loading

1. Add `ChoiceSetOption` Interface

2. Implement `getChoiceSet` Method

3. Implement `resolveDisplayValue` Helper