Compartilhar via

Obter metadados de uma lista

  • Artigo

Retorna os metadados de uma list.

Permissões

Uma das permissões a seguir é necessária para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTP

GET /sites/{site-id}/lists/{list-id}
GET /sites/{site-id}/lists/{list-id}?expand=columns,items(expand=fields)

Corpo da solicitação

Não forneça um corpo de solicitação com esse método.

Exemplo

Solicitação

GET /sites/{site-id}/lists/{list-id}

Resposta

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"
    }
}

Com instruções select e expand, você pode recuperar metadados de lista, definições de coluna e itens de lista em uma única solicitação.

Solicitação

GET /sites/{site-id}/lists/{list-id}?select=id,name,lastModifiedDateTime&expand=columns(select=name,description),items(expand=fields(select=Name,Color,Quantity))

Resposta

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
       }
    }
  ]
}