Compartilhar via


Atualizar evento

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.

Atualizar as propriedades do objeto evento.

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Observações para atualizar as propriedades específicas

Observe os seguintes comportamentos ou recomendações ao atualizar as propriedades correspondentes:

  • atualizações de propriedade e reuniões dos participantes

    • Uma atualização de evento que inclui apenas a propriedade participantes no corpo da solicitação envia uma atualização de reunião apenas aos participantes que foram alterados.
    • Uma atualização de evento que remove um participante especificado como membro de uma lista de distribuição envia uma atualização de reunião a todos os participantes.
  • propriedade do corpo e reuniões online

    Antes de atualizar o corpo de um evento que foi configurado como uma reunião online, primeiro deve-se obter a propriedade corpo, aplicar as alterações apropriadas ao conteúdo e preservar o blob de reunião para reunião online. Remover inadvertidamente o blob de reunião do corpo desabilitará a reunião online.

  • propriedades término e início e seus fusos horários

    Ao atualizar o fuso horário da hora de início ou de término de um evento, primeiro encontre os fusos horários com suporte para garantir que você tenha definido apenas fusos horários que tenham sido configurados para o servidor de caixas de correio do usuário.

Permissões

Uma das seguintes permissões é necessária para chamar esta 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) Calendars.ReadWrite
Delegado (conta pessoal da Microsoft) Calendars.ReadWrite
Aplicativo Calendars.ReadWrite

Solicitação HTTP

PATCH /me/events/{id}
PATCH /users/{id | userPrincipalName}/events/{id}
PATCH /groups/{id}/events/{id}

PATCH /me/calendar/events/{id}
PATCH /users/{id | userPrincipalName}/calendar/events/{id}
PATCH /groups/{id}/calendar/events/{id}

PATCH /me/calendars/{id}/events/{id}
PATCH /users/{id | userPrincipalName}/calendars/{id}/events/{id}

PATCH /me/calendarGroups/{id}/calendars/{id}/events/{id}
PATCH /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização string {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade. Para obter o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
attendees Participante A coleção de participantes do evento. Veja notas adicionais para atualizar propriedades específicas.
corpo ItemBody O corpo da mensagem associada ao evento. Veja notas adicionais para atualizar propriedades específicas.
categories Coleção de cadeias de caracteres As categorias associadas ao evento.
end DateTimeTimeZone A data, a hora e o fuso horário em que o evento termina. Veja notas adicionais para atualizar propriedades específicas.
hideAttendees Booliano Quando definido como true, cada participante só se vê na solicitação de reunião e na lista de Rastreamento da reunião. O padrão é falso.
importance Cadeia de caracteres A importância do evento. Os valores possíveis são: low, normal, high.
isAllDay Booliano Defina como true se o evento durar o dia inteiro. Se estiver definido como true, independentemente de ser um evento de um ou de vários dias, a hora de início e término deve ser definida como meia-noite e estar no mesmo fuso horário.
isOnlineMeeting Booliano True se o evento tem informações sobre a reunião online, caso contrário, false. O padrão é false. Opcional.
isReminderOn Booliano Defina como true se um alerta estiver definido para lembrar o usuário sobre o evento.
location Local O local do evento.
locations location collection Locais onde o evento é realizado ou onde participar. As propriedades location e locations sempre correspondem entre si. Se você atualizar a propriedade location, os locais anteriores na coleção locations deverão ser removidos e substituídos pelo novo valor location.
onlineMeetingProvider onlineMeetingProviderType Representa o provedor de serviços de reunião online. Os valores possíveis são teamsForBusiness, skypeForBusiness e skypeForConsumer. Opcional.
recurrence PatternedRecurrence O padrão de recorrência do evento.
reminderMinutesBeforeStart Int32 O número de minutos antes da hora de início do evento em que o alerta de lembrete ocorre.
responseRequested Booliano Defina como true se o remetente quiser receber uma resposta quando o evento for aceito ou recusado.
sensitivity String Os valores possíveis são: normal, personal, private, confidential.
showAs String O status a ser exibido. Os valores possíveis são: free , , busytentative, , oof, . unknownworkingElsewhere
iniciar DateTimeTimeZone A data, a hora e o fuso horário do evento. Veja notas adicionais para atualizar propriedades específicas.
assunto String O texto da linha de assunto do evento.

Como o recurso evento dá suporte as extensões, você pode usar a operação PATCH para adicionar, atualizar ou excluir seus próprios dados específicos do aplicativo nas propriedades personalizadas de uma extensão em uma instância do evento existente.

Se o evento que você está atualizando é o evento mestre de uma série recorrente, com vários participantes e com instâncias atualizadas separadamente, vários emails de notificação serão enviados: uma para a série mestre e um por instância que foi atualizada.

Resposta

Se bem-sucedido, este método retorna um código de resposta 200 OK e um objeto event atualizado no corpo da resposta.

Observação: Esse método poderá retornar uma Resposta de Solicitação Incorreta HTTP 400 com um código de erro ErrorOccurrenceCrossingBoundary e a seguinte mensagem de erro: A ocorrência modificada está cruzando ou se sobrepondo à ocorrência adjacente. Isso indica que a atualização viola a seguinte restrição do Outlook nas exceções de recorrência: uma ocorrência não pode ser movida para ou antes do dia da ocorrência anterior e não pode ser movida para ou após o dia da ocorrência seguinte.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/me/events/{id}
Content-type: application/json

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "2016-10-19T10:37:00Z"
  },
  "recurrence": null, 
  "reminderMinutesBeforeStart": 99,
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "teamsForBusiness",
  "isReminderOn": true,
  "hideAttendees": false,
  "categories": ["Red category"]
}

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

{
  "originalStartTimeZone": "originalStartTimeZone-value",
  "originalEndTimeZone": "originalEndTimeZone-value",
  "responseStatus": {
    "response": "",
    "time": "2016-10-19T10:37:00Z"
  },
  "recurrence": null,
  "iCalUId": "040000008200E00074=",
  "uid": "040000008200E00074=",
  "reminderMinutesBeforeStart": 99,
  "isOnlineMeeting": true,
  "onlineMeetingProvider": "teamsForBusiness",
  "isReminderOn": true,
  "hideAttendees": false,
  "onlineMeeting": {
        "joinUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_NzIyNzhlMGEtM2YyZC00ZmY0LTlhNzUtZmZjNWFmZGNlNzE2%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%22bc55b173-cff6-457d-b7a1-64bda7d7581a%22%7d",
        "conferenceId": "177513992",
        "tollNumber": "+91 22 6241 6885"
    }
}