Atualizar planContextLink

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 de um objeto planContextLink.

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ão com privilégios mínimos	Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante)	Sem suporte.	Sem suporte.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Sem suporte.	Sem suporte.

Solicitação HTTP

PATCH /me/planner/plans_v2/{planId}/contexts/{planContextLinkId}
PATCH /users/{usersId}/planner/plans_v2/{planId}/contexts/{planContextLinkId}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade	Tipo	Descrição
chave	Cadeia de caracteres	Identificador do contexto em que o plano é apresentado. Opcional.
displayNameSegments	String collection	Exibir segmentos de nome usados para renderizar onde a planta é superada. Opcional.
webUrl	String	URL da superfície onde a planta é exibida. Opcional.
associationType	Cadeia de caracteres	Descreve como a planta está associada à superfície. Opcional.
displayAs	plannerPlanContextType	Como o link de contexto deve ser exibido. Os valores possíveis são teamsTab, sharePointPage, meetingNotes, other, unknownFutureValue, loopPage, project. Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter os seguintes valores dessa enumeração evolutiva: loopPage , project. Opcional.
isActive	Booliano	Indica se o link de contexto está ativo no momento. Opcional.
customLinkText	Cadeia de caracteres	Texto personalizado usado para renderizar o link, se fornecido. Opcional.
ownerAppId	Cadeia de caracteres	ID do aplicativo do aplicativo proprietário da superfície à qual o plano está vinculado. Opcional.
isCreation	Booliano	Indica se esse link de contexto representa a superfície de criação original do plano. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto planContextLink atualizado no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/contexts/{planContextLinkId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "key": "19:abcdef1234567890abcdef1234567890@thread.tacv2",
  "displayNameSegments": [
    "Contoso Project"
  ],
  "webUrl": "https://teams.microsoft.com/l/entity/com.microsoft.teamspace.tab.planner/tab-contoso-project",
  "associationType": "primary",
  "displayAs": "teamsTab",
  "isActive": true,
  "customLinkText": "Project plan",
  "ownerAppId": "4d1c9a3e-7b52-4f8a-9d31-6c2e8f4b9a17",
  "isCreation": true
}

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

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "id": "901187ee-a684-eeaa-61d0-b0fb4774cdab",
  "key": "String",
  "displayNameSegments": [
    "String"
  ],
  "webUrl": "String",
  "associationType": "String",
  "displayAs": "String",
  "isActive": "Boolean",
  "customLinkText": "String",
  "ownerAppId": "String",
  "isCreation": "Boolean",
  "createdDateTime": "String (timestamp)"
}