StringItem

• Available Since API Version – 2.0\

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 object. StringItem objects contain the following properties:

• 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 in a Read method call.

Request

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

Response

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

Detailed Read Request

The following example illustrates the syntax for a request for all properties of a EnumField, including the properties of the StringItems in a Read method call.

Request

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

Response

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

Create/Update Request

The following example illustrates the syntax for including a EnumField in a Create or Update method call.

Request

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

Response

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