Skip to main content

valuesetItemCreate

Create a new item within an existing value set.

Adds a new selectable option to a value set with localized descriptions and optional metadata. The item will be immediately available for use in dropdown lists and validation throughout the system.

Requirements: • Parent value set must exist and be accessible • Value must be unique within the parent value set (maximum 512 characters) • At least one description is required for proper internationalization • Only CUSTOM type value sets can have items added via API

Use this mutation to: • Add new options to existing dropdown lists • Expand configuration choices for business needs • Create localized selection options for international users • Populate value sets with additional metadata

Possible errors:

  • VALUESET_ITEM_CREATE_ERROR: Failed to create the value set item due to system error
  • VALUESET_NOT_FOUND_ERROR: Parent value set with specified ID does not exist
  • VALUESET_ALREADY_EXISTS_ERROR: Item with the specified value already exists in the value set
  • VALUESET_NOT_ALLOWED_TO_MODIFY_ERROR: Attempt to add item to SYSTEM type value set

AUTH: Role=[configuration.OWNER]

valuesetItemCreate(
input: ValuesetItemCreateInput!
): ValuesetItem!

Arguments

valuesetItemCreate.input ● ValuesetItemCreateInput! non-null input

Value set item creation data including parent value set, value, descriptions, and optional metadata.

Contains all necessary information to create a functional value set item. Value must be unique within the parent value set and descriptions should include at least one language.

Validation constraints: • valuesetId: Must reference an existing CUSTOM type value set • value: 1-512 characters, unique within parent value set • descriptions: At least one entry with valid language code • extra: Optional metadata up to 512 characters

Type

ValuesetItem object