Trabalhar com blocos de anotações de equipe

Artigo
07/26/2016

Aplica-se aos: Blocos de anotações empresariais no Office 365

Escolas, faculdades e universidades em todo o mundo usam blocos de anotações de equipe para ajudar a promover a produtividade, o compromisso e a colaboração.

Você pode usar o ponto de extremidade staffNotebooks para executar tarefas comuns de blocos de anotações de equipe, como criar blocos de anotações de equipe e adicionar ou remover líderes ou membros.

Observação

A API do OneNote fornece o ponto de extremidade staffNotebooks para operações específicas dos blocos de anotações de equipe.

Construir a URI de solicitação

Para construir o URI de solicitação, inicie com a URL raiz do serviço para a sua plataforma:

Blocos de anotações no OneDrive for Business

https://www.onenote.com/api/v1.0/me/notes/

https://www.onenote.com/api/v1.0/users/{id}/notes/

Blocos de anotações do site do SharePoint

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

Blocos de anotações de grupo unificados

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/
Acrescentar o ponto de extremidade staffNotebooks, seguido de um caminho de recurso, conforme necessário:

Criar blocos de anotações de equipe

../staffNotebooks[?omkt,sendemail]

Atualizar um bloco de anotações de equipe

../staffNotebooks/{notebook-id}

Obter um ou mais blocos de anotações de equipe

../staffNotebooks

../staffNotebooks/{notebook-id}

Excluir um bloco de anotações de equipe

../staffNotebooks/{notebook-id}

Adicionar membros ou líderes

../staffNotebooks/{notebook-id}/members

../staffNotebooks/{notebook-id}/leaders

Remover membros ou líderes

../staffNotebooks/{notebook-id}/members/{member-id}

../staffNotebooks/{notebook-id}/leaders/{leader-id}

Inserir seções

../staffNotebooks/{notebook-id}/copySectionsToContentLibrary

Seu URI de solicitação completo será parecido com estes exemplos:

https://www.onenote.com/api/v1.0/me/notes/staffNotebooks/{id}/leaders/{id}

https://www.onenote.com/api/v1.0/users/{id}/notes/staffNotebooks/{id}/members

https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/staffNotebooks

https://www.onenote.com/api/v1.0/myOrganization/groups/{id}/notes/staffNotebooks/{id}

https://www.onenote.com/api/v1.0/me/notes/staffNotebooks/{id}/copySectionsToContentLibrary

Observação

Saiba mais sobre a URL raiz de serviço.

Criar blocos de anotações de equipe

Para criar um bloco de anotações de equipe, envie uma solicitação POST para o ponto de extremidade staffNotebooks.

POST ../staffNotebooks[?omkt,sendemail]

No corpo da mensagem, envie um objeto JSON com os parâmetros de criação do bloco de anotações de equipe.

{
    "name": "notebook-name",
    "memberSections": [ 
        "section1-name", 
        "section2-name"
    ],
    "leaders": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
    ],
    "members": [
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group" 
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        },
        {
            "id": "alias@tenant",
            "principalType": "Person-or-Group"
        }
   ], 
   "hasLeaderOnlySectionGroup": true
}

Parâmetro	Descrição
nome	O nome do bloco de anotações.
memberSections	Uma matriz contendo um ou mais nomes de seção. Essas seções são criadas no grupo de seções de cada membro.
líderes	Uma matriz contendo um ou mais objetos de segurança.
membros	Uma matriz contendo um ou mais objetos de segurança. Um grupo de seções é criado para cada membro.
hasLeaderOnlySectionGroup	`true` para criar um grupo de seções Somente Líder visível apenas para líderes.
omkt	Parâmetro de consulta de URL que especifica o idioma do bloco de anotações. O padrão é `en-us`. Exemplo: `?omkt=es-es`
sendemail	Parâmetro de consulta de URL que especifica se é necessário enviar uma notificação por email quando o bloco de anotações é criado para os líderes e membros atribuídos ao bloco de anotações. O padrão é `false`.

Líderes e membros são representados por objetos de segurança que contêm as seguintes propriedades:

Parâmetro	Descrição
id	O nome UPN do Office 365. Confira a Documentação da API do Azure AD Graph para saber mais sobre usuários e grupos.
principalType	`Person` ou `Group`

Idiomas compatíveis

Você pode usar o parâmetro de consulta de URL omkt={language-code} para criar um bloco de anotações de equipe em um idioma específico. Por exemplo:

POST ../staffNotebooks?omkt=de-de

Os seguintes códigos de idioma são suportados. O padrão é en-us.

Código	Idioma
bg-bg	Български (България)
cs-cz	Čeština (Česká republika)
da-dk	Dansk (Dinamarca)
de-de	Deutsch (Deutschland)
el-gr	Ελληνικά (Ελλάδα)
en-us	Inglês (Estados Unidos)
es-es	Español (España)
et-ee	Eesti (Eesti)
fi-fi	Suomi (Suomi)
fr-fr	Français (France)
hi-in	हिंदी (तारत)
hr-hr	Hrvatski (Hrvatska)
hu-hu	Magyar (Magyarország)
id-id	Bahasa Indonesia (Indonesia)
it-it	Italiano (Italia)
ja-jp	日本語 (日本)
kk-kz	Қазақ (Қазақстан)
ko-kr	한국어 (대한민국)
lt-lt	Lietuvių (Lietuva)
lv-lv	Latviešu (Latvija)
ms-my	Bahasa Melayu (Asia Tenggara)
nb-no	Norsk (Norge)
nl-nl	Nederlands (Nederland)
pl-pl	Polski (Polska)
pt-br	Português (Brasil)
pt-pt	Português (Portugal)
ro-ro	Română (România)
ru-ru	Русский (Россия)
sk-sk	Slovenčina (Slovenská republika)
sl-si	Slovenski (Slovenija)
sr-Latn-RS	Srpski (Rep. Srbija i Rep. Crna Gora)
sv-se	Svenska (Sverige)
th-th	ไทย (ไทย)
tr-tr	Türkçe (Türkiye)
uk-ua	Українська (Україна)
vi-vn	Tiếng Việt (Việt Nam)
zh-cn	简体中文 (中国)
zh-tw	繁體中文 (台灣)

Exemplo

A solicitação a seguir cria um bloco de anotações de equipe chamado Reuniões de Equipe.

POST ../v1.0/users/{leader-id}/notes/staffNotebooks?sendemail=true
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "name": "Staff Meetings",
    "memberSections": [
        "Staff Notes",
        "Meeting Summaries",
    ],
    "leaders": [
        {
            "id": "leader1@contoso.com",
            "principalType": "Person"
        }
    ],
    "members": [
        {
            "id": "member1@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "member2@contoso.com",
            "principalType": "Person" 
        },
        {
            "id": "member3@contoso.com",
            "principalType": "Person"
        },
        {
            "id": "member4@contoso.com",
            "principalType": "Person"
        }
    ],
    "hasLeaderOnlySectionGroup": true
}

Isso cria um bloco de anotações de equipe com quatro grupos de seções de membros, cada um contendo uma seção de Folhetos, Notas de Equipe e Resumos de Reuniões. O grupo de seções criado para cada membro fica acessível somente para o membro e para o líder. Também cria um grupo de seções Somente Líder que fica visível apenas para o líder. O parâmetro de consulta sendemail=true especifica o envio de uma notificação por email para o líder e membros quando o bloco de anotações é criado.

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações POST /staffNotebooks.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho content-type	`application/json`
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 201.
Corpo da resposta	Uma representação OData do novo bloco de anotações no formato JSON. Além das propriedades do bloco de anotações regular, os blocos de anotações de equipe também apresentam as seguintes propriedades: memberSections. As seções de membros nos blocos de anotações. líderes. Os líderes que podem acessar o bloco de anotações. membro. Os membros que podem acessar o bloco de anotações. hasLeaderOnlySectionGroup. `true` se o bloco de anotações contiver um grupo de seções Somente Líder, caso contrário `false`.
Erros	Se a solicitação falhar, a API retornará erros no objeto @api.diagnostics no corpo da resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Atualizar blocos de anotações de equipe

Para atualizar um bloco de anotações de equipe, envie uma solicitação PATCH para o ponto de extremidade staffNotebooks/{notebook-id}.

Observação

No momento, apenas a propriedade hasLeaderOnlySectionGroup pode ser atualizada em uma solicitação PATCH.

PATCH ../staffNotebooks/{notebook-id}

No corpo da mensagem, envie um objeto JSON com o parâmetro de atualização.

{
    "hasLeaderOnlySectionGroup": true
}

Parâmetro	Descrição
hasLeaderOnlySectionGroup	`true` para adicionar um grupo de seções Somente Líder visível apenas para líderes. `false` não tem suporte.

Veja estes métodos para outras formas de alterar os blocos de anotações de equipe: Adicionar membros ou líderes, Remover membros ou líderes, Inserir seções.

Exemplo

A solicitação a seguir adiciona um grupo de seções Somente Líder ao bloco de anotações de equipe especificado.

PATCH ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id}
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "hasLeaderOnlySectionGroup": true
}

O novo grupo de seções Somente Líder fica visível apenas para líderes.

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações PATCH ../staffNotebooks/{notebook-id}.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho content-type	`application/json`
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 204.
Erros	Se a solicitação falhar, a API retornará erros no corpo de resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Obter blocos de anotações de equipe

Para obter um ou mais blocos de anotações de equipe, envie uma solicitação GET para o ponto de extremidade staffNotebooks.

Obter um ou mais blocos de anotações de equipe

GET ../staffNotebooks[?filter,orderby,select,top,skip,expand,count]

Obter um bloco de anotações de equipe específico

GET ../staffNotebooks/{notebook-id}[?select,expand]

Os blocos de anotações podem expandir as propriedades leaders e members. A ordem de classificação padrão é name asc.

Blocos de anotações de equipe também são devolvidos para solicitações GET /notebooks, mas os resultados não incluem propriedades específicas do bloco de anotações de equipe.

Exemplo

A solicitação a seguir obtém blocos de anotações de equipe criados a partir de 1º de janeiro de 2016.

GET ../v1.0/users/{leader-id}/notes/staffNotebooks?filter=createdTime%20ge%202016-01-01 
Authorization: Bearer {token}
Accept: application/json

Para saber mais sobre como obter blocos de anotações de equipe, incluindo exemplos e opções de sequência de caracteres de consulta compatíveis, veja Obter conteúdo e estrutura do OneNote.

Informações de solicitação e resposta

As informações a seguir aplicam-se às solicitações GET /staffNotebooks.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.Read, Notes.ReadWrite.CreatedByApp, Notes.ReadWrite, or Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status de HTTP 200.
Corpo da resposta	Uma representação OData dos blocos de anotações de equipe no formato JSON. Além das propriedades do bloco de anotações regular, os blocos de anotações de equipe também apresentam as seguintes propriedades: memberSections. As seções de membros nos blocos de anotações. líderes. Os líderes que podem acessar o bloco de anotações. membro. Os membros que podem acessar o bloco de anotações. hasLeaderOnlySectionGroup. `true` se o bloco de anotações contiver um grupo de seções Somente Líder, caso contrário `false`.
Erros	Se a solicitação falhar, a API retornará erros no objeto @api.diagnostics no corpo da resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Excluir blocos de anotações de equipe

Para excluir um bloco de anotações de equipe, envie uma solicitação DELETE para o ponto de extremidade staffNotebooks/{notebook-id}.

DELETE ../staffNotebooks/{notebook-id}

Exemplo

A solicitação a seguir exclui o bloco de anotações de equipe especificado.

DELETE ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id} 
Authorization: Bearer {token}
Accept: application/json

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações DELETE ../staffNotebooks/{notebook-id}.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 204.
Erros	Se a solicitação falhar, a API retornará erros no corpo de resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Adicionar membros e líderes

A adição de líderes e membros dá acesso ao bloco de anotações de equipe. A adição de um membro também cria um grupo de seções de membros. Este grupo de seções fica acessível somente para o membro e para o líder e contém as seções de membros definidas para o bloco de anotações.

Para adicionar um membro ou um líder a um bloco de anotações de equipe, envie uma solicitação POST para o ponto de extremidade apropriado.

Adicionar um membro

POST ../staffNotebooks/{notebook-id}/members

Adicionar um líder

POST ../staffNotebooks/{notebook-id}/leaders

Envie um objeto de segurança JSON no corpo da mensagem. Você pode adicionar um membro ou um líder por solicitação.

{
    "id": "alias@tenant",
    "principalType": "Person-or-Group"
}

Líderes e membros são representados por objetos de segurança que contêm as seguintes propriedades:

Parâmetro	Descrição
id	O nome UPN do Office 365. Confira a Documentação da API do Azure AD Graph para saber mais sobre usuários e grupos.
principalType	`Person` ou `Group`

Exemplo

A solicitação a seguir adiciona um líder ao bloco de anotações de equipe especificado.

POST ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id}/leaders 
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "id": "leader2@contoso.com",
    "principalType": "Person"
}

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações POST /members e POST /leaders.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho content-type	`application/json`
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 201.
Corpo da resposta	O membro ou líder adicionado.
Erros	Se a solicitação falhar, a API retornará erros no objeto @api.diagnostics no corpo da resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Remover membros e líderes

A remoção de membros e líderes de um bloco de anotações de equipe revoga seu acesso ao bloco de anotações, mas não exclui nenhum conteúdo.

Para remover um membro ou um líder de um bloco de anotações de equipe, envie uma solicitação DELETE para o ponto de extremidade apropriado.

Remover um membro

DELETE ../staffNotebooks/{notebook-id}/members/{member-id}

Remover um líder

DELETE ../staffNotebooks/{notebook-id}/leaders/{leader-id}

Você pode remover um membro ou um líder por solicitação.

Exemplo

A solicitação a seguir remove o membro especificado do bloco de anotações de equipe especificado.

DELETE ../v1.0/users/{leader-id}/notes/staffNotebooks/{notebook-id}/members/{member-id} 
Authorization: Bearer {token}
Accept: application/json

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações DELETE /members e DELETE /leaders.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 204.
Erros	Se a solicitação falhar, a API retornará erros no objeto @api.diagnostics no corpo da resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor com o valor do cabeçalho de Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Inserir seções

Use copySectionsToContentLibrary para copiar seções específicas de blocos de anotações do Office 365 e inseri-las na biblioteca de conteúdo de um bloco de anotações de equipe. Uma biblioteca de conteúdo é um grupo de seções dentro do bloco de anotações de equipe que tem permissões de leitura/gravação para líderes e permissão de leitura para membros.

Para inserir seções em um bloco de anotações de equipe, envie uma solicitação POST para o ponto de extremidade copySectionsToContentLibrary do bloco de anotações de equipe de destino. Por exemplo:

POST ../staffNotebooks/{notebook-id}/copySectionsToContentLibrary

No corpo da mensagem, envie um objeto JSON com o parâmetro sectionIds.

{
    "sectionIds": [
        "section1-id", 
        "section2-id",
        ...
    ]
}

Parâmetro	Descrição
sectionIds	Uma matriz que contém as IDs das seções que você deseja inserir no bloco de anotações de equipe.

O usuário deve ter acesso ao bloco de anotações e seções de destino (próprios ou compartilhados). Todos os destinos devem estar no mesmo locatário.

Exemplo

A solicitação a seguir insere duas seções na Biblioteca de Conteúdo do bloco de anotações de equipe especificado.

POST ../v1.0/me/notes/staffNotebooks/{notebook-id}/copySectionsToContentLibrary
Authorization: Bearer {token}
Content-Type: application/json
Accept: application/json

{
    "sectionIds": [
        "1-85ba33b1-4959-4102-8dcd-d98e4e56e56f", 
        "1-8ba42j81-4959-4102-8dcd-d98e4e94s62ef"
    ]
}

Solicitação e informação de resposta

As informações a seguir aplicam-se às solicitações POST /copySectionsToContentLibrary.

Dados da solicitação	Descrição
Protocolo	Todas as solicitações usam o protocolo HTTPS de SSL/TLS.
Cabeçalho de autorização	`Bearer {token}`, onde {token} é um token de acesso do OAuth 2.0 válido para o aplicativo registrado. Se ausente ou inválido, a solicitação falhará com um código de status 401. Confira Autenticar usando o Azure AD (aplicativos para empresas).
Cabeçalho content-type	`application/json`
Cabeçalho Accept	`application/json`
Escopo de permissão	Notes.ReadWrite.CreatedByApp, Notes.ReadWrite ou Notes.ReadWrite.All

Dados da resposta	Descrição
Código de êxito	Um código de status HTTP 201.
Erros	Se a solicitação de criação falhar, a API retornará erros no corpo de resposta.
Cabeçalho X-CorrelationId	Um GUID que identifica de forma exclusiva a solicitação. Você pode usar esse valor juntamente com o valor do cabeçalho Data ao trabalhar com o suporte da Microsoft para solucionar problemas.

Construir a URL raiz de serviço do OneNote

A URL raiz do serviço do OneNote usa o formato a seguir para todas as chamadas para o API dp OneNote.

https://www.onenote.com/api/{version}/{location}/notes/

O segmento version na URL representa a versão da API do OneNote que você deseja usar.

Use v1.0 para o código de produção estável.
Use beta para experimentar um recurso que está em desenvolvimento. Os recursos e a funcionalidade na versão beta podem mudar, por isso, você não deve usá-la no código de produção.

O segmento location na URL representa a localização dos blocos de anotações que você deseja acessar:

Blocos de anotações no OneDrive for Business
- Use me para conteúdos do OneNote pertencentes ao usuário atual.
- Use users/{id} para o conteúdo do OneNote que o usuário especificado (na URL) compartilhou com o usuário atual. Use a API do Azure AD Graph para obter IDs de usuários.
Blocos de anotações do site do SharePoint
- Sites de equipe e outros sites do SharePoint podem conter blocos de anotações do OneNote em suas bibliotecas de documentos.
- Use myOrganization/siteCollections/{id}/sites/{id} para conteúdo do OneNote em um site no locatário no qual o usuário atual está conectado. Apenas o locatário atual tem suporte, acessado com a palavra-chave myOrganization. Aprenda como obter IDs de site.
Blocos de anotações de grupo unificados
- Grupos unificados (também chamados de grupos do Office 365) fazem parte da experiência conectada do Office 365. Os membros do grupo podem compartilhar blocos de anotações, arquivos e e-mails.
- Use myOrganization/groups/{id} para conteúdos do OneNote no grupo especificado do qual o usuário atual é membro. Grupos unificados são os únicos tipos de grupo com suporte. Use a API do Azure AD Graph para obter IDs de grupos.

Use o método FromUrl para obter o conjunto de sites e as IDs dos sites

Você pode usar o método FromUrl para obter o conjunto de sites e as IDs dos sites para uma URL absoluta do site especificado. Você deve fazer essa chamada somente quando necessário e armazenar os valores para uso futuro.

O formato da URL do site depende da sua configuração, por exemplo https://domain.sharepoint.com/site-a ou https://domain.com/sites/site-a.

Exemplo de solicitação

GET https://www.onenote.com/api/v1.0/myOrganization/siteCollections/FromUrl(url='{full-path-to-SharePoint-site}')

Authorization: Bearer {token}

Accept: application/json

Resposta de exemplo

{"@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.SiteMetadata", "siteCollectionId":"09d1a587-a84b-4264-3d15-669429be8cc5", "siteId":"d9e4d5c8-683f-4363-89ae-18c4e3da91e9"}

Requisitos para uso de FromUrl e como trabalhar com os blocos de anotações do site do SharePoint:

Você só pode criar blocos de anotações, grupos de seções, seções e páginas do OneNote em sites que tenham uma biblioteca de documentos padrão. (Alguns modelos de site não criam uma biblioteca de documentos padrão.) No entanto, as solicitações GET retornam o conteúdo do OneNote de todas as bibliotecas de documentos no site.
A URL raiz do serviço do OneNote é imutável, o que significa que você não pode usar um caminho do site da API REST do SharePoint e depois rastrear o ponto de extremidade notes nele.
O usuário para quem você está fazendo a chamada deve ser membro do site.
O método FromUrl funciona apenas com sites que foram indexados. Pode levar várias horas para indexar um site novo.

Trabalhar com blocos de anotações de equipe

Construir a URI de solicitação

Criar blocos de anotações de equipe

Idiomas compatíveis

Exemplo

Solicitação e informação de resposta

Atualizar blocos de anotações de equipe

Exemplo

Solicitação e informação de resposta

Obter blocos de anotações de equipe

Exemplo

Informações de solicitação e resposta

Excluir blocos de anotações de equipe

Exemplo

Solicitação e informação de resposta

Adicionar membros e líderes

Exemplo

Solicitação e informação de resposta

Remover membros e líderes

Exemplo

Solicitação e informação de resposta

Inserir seções

Exemplo

Solicitação e informação de resposta

Construir a URL raiz de serviço do OneNote

Use o método FromUrl para obter o conjunto de sites e as IDs dos sites

Exemplo de solicitação

Resposta de exemplo

Confira também

Recursos adicionais