Obter pacote

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Recupere os metadados de um pacote com base na ID exclusiva do pacote.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

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

Solicitação HTTP

GET /drive/bundles/{bundle-id}
GET /drive/items/{bundle-id}

Como pacotes são itens, você pode usar a coleção de itens para retornar metadados sobre um pacote. Você também pode usar a coleção de pacotes como uma conveniência para garantir que você obtenha um pacote na resposta.

Parâmetros de consulta opcionais

Você pode usar os parâmetros de consulta OData para restringir a forma dos objetos retornados dessa chamada.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
if-none-match eTag. Opcional. Se esse cabeçalho de solicitação for incluído e o eTag (ou cTag) fornecido corresponder à marca atual no arquivo, uma 304 Not Modified resposta será retornada.

Corpo da solicitação

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

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto driveItem que contém o pacote no corpo da resposta.

Para obter informações sobre respostas de erro, consulte Tipos de recursos e respostas de erro do Microsoft Graph.

Exemplos

Exemplo 1: obter um pacote

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/drive/bundles/{bundle-id}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "0123456789abc",
  "name": "My Photo Album Bundle",
  "eTag": "etag",
  "cTag": "etag",
  "createdBy": { "user": { "id": "1234", "displayName": "Ryan Gregg" } },
  "createdDateTime": "datetime",
  "lastModifiedBy": { "user": { "id": "1234", "displayName": "Ryan Gregg" } },
  "lastModifiedDateTime": "datetime",
  "size": 1234,
  "webUrl": "http://onedrive.com/...",
  "bundle": {
    "childCount": 4,
     "album": { }
  }
}

Exemplo 2: Obter um pacote e seus filhos em uma única chamada

Use o expandparâmetro query string para incluir os filhos de um pacote na mesma solicitação que recupera os metadados de um pacote.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/drive/items/{bundle-id}?expand=children

Resposta

O exemplo a seguir mostra a resposta. Essa chamada retorna os metadados do pacote e uma lista de filhos do pacote. Se o pacote não tiver filhos, ele retornará uma coleção vazia.

Se o número de filhos no pacote for maior que o tamanho de página padrão, a children@odata.nextLink propriedade será retornada com uma URL que pode ser usada para solicitar a próxima página de filhos no pacote.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "101230100alkc",
  "name": "My Cool Day at the Beach",
  "children": [
    { "id": "120100abab", "name": "image1.jpg", "file": {} },
    { "id": "120100abo1", "name": "image2.jpg", "file": {} }
  ],
  "children@odata.nextLink": "https://api.onedrive.com/v1.0/..."
}