Skip to main content

Valueset

No description

type Valueset {
  id: Int!
  name: String!
  type: ValuesetType!
  descriptions: [LocalizedString!]!
  lastModifiedBy: Int
  lastModifiedAt: DateTime!
  createdBy: Int
  createdAt: DateTime!
  valuesetItems(
    input: ValuesetItemSearchInput
  ): ValuesetItemResponse!
}

Fields​

Valueset.id ● Int! non-null scalar​

Valueset primary identifier

Valueset.name ● String! non-null scalar​

Unique identifier name for the value set used throughout the system for referencing and configuration purposes

Valueset.type ● ValuesetType! non-null enum​

Classification indicating whether this value set is system-managed or user-customizable

Valueset.descriptions ● [LocalizedString!]! non-null object​

Human-readable descriptions of the value set purpose and usage in multiple languages for internationalization support

Valueset.lastModifiedBy ● Int scalar​

Identifier of the user who last modified this value set for audit trail purposes

Valueset.lastModifiedAt ● DateTime! non-null scalar​

Timestamp indicating when this value set was last modified for tracking changes and audit purposes

Valueset.createdBy ● Int scalar​

Identifier of the user who originally created this value set for audit trail purposes

Valueset.createdAt ● DateTime! non-null scalar​

Timestamp indicating when this value set was originally created for audit trail and historical tracking

Valueset.valuesetItems ● ValuesetItemResponse! non-null object​

Retrieve items belonging to this value set with filtering and pagination.

Returns all items associated with the value set including their values, localized descriptions, and additional metadata. Used for populating dropdown lists, validation options, and configuration interfaces.

This field resolver automatically filters items to only those belonging to the current value set, providing a convenient way to access related data in GraphQL queries.

Use this field to: • Populate dropdown lists with value set options • Display all available choices for configuration • Implement search and filtering within value set items • Access localized labels for internationalization

Possible errors:

  • VALUESET_ITEM_LIST_ERROR: Failed to retrieve value set items due to system error
Valueset.valuesetItems.input ● ValuesetItemSearchInput input​

Search criteria and pagination parameters for filtering value set items.

All search parameters are optional. When provided, they filter the items within this specific value set. Pagination controls help manage large item collections efficiently.

The valuesetIds parameter is automatically set to the current value set, so it should not be provided in the input.

Returned By​

valueset query ● valuesetCreate mutation ● valuesetUpdate mutation

Member Of​

ValuesetResponse object