Edit

Share via

FieldValueSet resource

  • Article

Represents the column values in a listItem resource.

JSON representation

Here is a JSON representation of a fieldValueSet resource.

{
    "Author": "Brad Cleaver",
    "AuthorLookupId": "13",
    "Name": "Kangaroos and Wallabies: A Deep Dive",
    "Color": "Red",
    "Quantity": 350,
}

Properties

Each user-visible field in the listItem is returned as a name-value pair in the fieldValueSet. The example above is for a list that contains four columns, Author, Name, Color, and Quantity.

Lookup fields (like Author above) are not returned by default. Instead, the server returns a 'LookupId' field (like AuthorLookupId above) referencing the listItem targeted in the lookup. The name of the 'LookupId' field is the original field name followed by LookupId.

Up to 12 lookup fields may be requested in a single query. The server will return lookup values if your request includes a select statement with the fields you need. Example:

GET /sites/{site-id}/lists/{list-id}/items?expand=fields(select=Author,BookTitle,PageCount)

You may request up to 12 lookup fields in a single query, plus any number of regular fields.