获取列表的元数据
返回列表的元数据。
权限
调用此 API 需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限。
权限类型 | 权限(从最低特权到最高特权) |
---|---|
委派(工作或学校帐户) | Sites.Read.All、Sites.ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 |
应用程序 | Sites.Read.All、Sites.ReadWrite.All |
HTTP 请求
GET /sites/{site-id}/lists/{list-id}
GET /sites/{site-id}/lists/{list-id}?expand=columns,items(expand=fields)
请求正文
请勿为此方法提供请求正文。
示例
请求
GET /sites/{site-id}/lists/{list-id}
响应
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "1234-112-112-4",
"name": "MicroFeed",
"createdDateTime": "2016-08-30T08:32:00Z",
"lastModifiedDateTime": "2016-08-30T08:32:00Z",
"list": {
"hidden": false,
"template": "genericList"
}
}
借助 select
和 expand
语句,可以通过单个请求中检索列表元数据、列定义和列表项。
请求
GET /sites/{site-id}/lists/{list-id}?select=id,name,lastModifiedDateTime&expand=columns(select=name,description),items(expand=fields(select=Name,Color,Quantity))
响应
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "1234-112-112-4",
"name": "Inventory",
"lastModifiedDateTime": "2016-08-30T08:32:00Z",
"columns": [
{
"name": "Name",
"description": "Customer-facing name of the SKU"
},
{
"name": "Color",
"description": "Color of the item in stock"
},
{
"name": "Quantity",
"description": "Number of items in stock"
}
],
"items": [
{
"id": "2",
"fields": {
"Name": "Gadget",
"Color": "Red",
"Quantity": 503
}
},
{
"id": "4",
"fields": {
"Name": "Widget",
"Color": "Blue",
"Quantity": 2357
}
},
{
"id": "7",
"fields": {
"Name": "Gizmo",
"Color": "Green",
"Quantity": 92
}
}
]
}