StringItem

Note that in API versions prior to 2.4, the StringItem object type was called "UdfTableItem".

The StringItem type is used to represent table items in table userdefined fields. StringItems are always contained within a EnumField

Key - The Key of the StringItem used for identifying the item when setting values in a table user-defined field.
Value - A StringField containing the value of the table item.
Inactive - A BooleanField indicating whether the item is hidden or note in the table user-defined field.
SortValue - A StringField containing the custom sort value for the item used for sorting the items in a table user-defined field.

Basic Read Request

The following example illustrates the syntax for a basic request for the default value of a EnumField

{
  "Udf/$TYPEID(1234)":1
}

{
  "Udf/$TYPEID(1234)":[
    "2",
    "3",
    "4"
  ]
}

The following example illustrates the syntax for a request for all properties of a EnumField

{
  "Udf/$NAME(abtable1)":[
    {
      "Key":1,
      "Value":1,
      "Inactive":1,
      "SortValue":1
    }
  ]
}

{
  "Udf/$NAME(abtable1)":[
    {
      "Key":"4",
      "Value":"Pinot Noir",
      "Inactive":false,
      "SortValue":""
    }
  ]
}

The following example illustrates the syntax for including a EnumField

{
  "Udf/$TYPEID(1234)":[
    "2",
    "4"
  ]
}

{
  "Udf/$TYPEID(1234)":[
    "2",
    "4"
  ]
}