Criar uma propriedade estendida de valor único

Namespace: microsoft.graph

Crie uma ou mais propriedades estendidas de vários valores em uma instância nova ou existente de um recurso.

Há suporte para as seguintes fontes de dados:

• calendar
• contact
• contactFolder
• event
• pasta de caixa de correio
• mailFolder
• message
• Observação
• Tarefa do Outlook
• Pasta de tarefas do Outlook
• todoTask
• todoTaskList

Os seguintes recursos de grupo são suportados:

• grupo calendar
• grupo event
• grupo post

Para obter mais informações sobre quando usar extensões abertas ou propriedades estendidas e como especificar propriedades estendidas, consulte Visão geral de propriedades estendidas.

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

Permissões

Dependendo do recurso no qual você está criando a propriedade estendida e do tipo de permissão (delegada ou aplicativo) solicitado, a permissão especificada na tabela a seguir é a mínima necessária para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Solicitação HTTP

Você pode criar propriedades estendidas em uma instância de recurso nova ou existente.

Para criar uma ou mais propriedades estendidas em uma nova instância de recurso, use a mesma solicitação REST válida para a criação da instância e inclua as propriedades da nova instância de recurso e a propriedade estendida no corpo da solicitação. Alguns recursos dão suporte à criação de mais de uma maneira. Para obter mais informações sobre como criar essas instâncias de recurso, consulte os tópicos correspondentes para criar uma mensagem, mailFolder, evento, calendário, contato, contactFolder, mailboxFolder, tarefa do Outlook, pasta de tarefas do Outlook, evento de grupo, postagem de grupo e todoTask.

Veja a seguir a sintaxe das solicitações.

POST /me/messages
POST /users/{id|userPrincipalName}/messages
POST /me/mailFolders/{id}/messages

POST /me/mailFolders
POST /users/{id|userPrincipalName}/mailFolders

POST /me/events
POST /users/{id|userPrincipalName}/events

POST /me/calendars
POST /users/{id|userPrincipalName}/calendars

POST /me/contacts
POST /users/{id|userPrincipalName}/contacts

POST /me/contactFolders
POST /users/{id|userPrincipalName}/contactFolders

POST /admin/exchange/mailboxes/{mailboxId}/folders
POST /me/notes
POST /users/{id|userPrincipalName}/notes

POST /me/outlook/tasks
POST /users/{id|userPrincipalName}/outlook/tasks
POST /me/outlook/taskFolders/{id}/tasks
POST /users/{id|userPrincipalName}/outlook/taskFolders/{id}/tasks
POST /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks
POST /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks

POST /me/outlook/taskFolders
POST /users/{id|userPrincipalName}/outlook/taskFolders
POST /me/outlook/taskGroups/{id}/taskFolders
POST /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders

POST /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
POST /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

POST /me/todo/lists?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

POST /groups/{id}/events

POST /groups/{id}/threads/{id}/posts/{id}/reply
POST /groups/{id}/conversations/{id}/threads/{id}/posts/{id}/reply
POST /groups/{id}/threads/{id}/reply
POST /groups/{id}/conversations/{id}/threads/{id}/reply
POST /groups/{id}/threads
POST /groups/{id}/conversations

Para criar uma ou mais propriedades estendidas em uma instância de recurso existente, especifique essa instância na solicitação e inclua a propriedade estendida no corpo da solicitação.

Observação Você não pode criar uma propriedade estendida em uma postagem de grupo existente.

PATCH /me/messages/{id}
PATCH /users/{id|userPrincipalName}/messages/{id}
PATCH /me/mailFolders/{id}/messages/{id}

PATCH /me/mailFolders/{id}
PATCH /users/{id|userPrincipalName}/mailFolders/{id}

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

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

PATCH /me/contacts/{id}
PATCH /users/{id|userPrincipalName}/contacts/{id}

PATCH /me/contactFolders/{id}
PATCH /users/{id|userPrincipalName}/contactFolders/{id}

PATCH /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}
PATCH /me/notes/{id}
PATCH /users/{id|userPrincipalName}/notes/{id}

PATCH /me/outlook/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/tasks/{id}
PATCH /me/outlook/taskFolders/{id}/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskFolders/{id}/tasks/{id}
PATCH /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks/{id}

PATCH /me/outlook/taskFolders/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskFolders/{id}
PATCH /me/outlook/taskGroups/{id}/taskFolders/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}

PATCH /me/todo/lists/{todoTaskListId}/tasks?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')
PATCH /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

PATCH /me/todo/lists/{todoTaskListId}?$expand=singleValueExtendedProperties($filter=id eq '{singleValueExtendedPropertyId}')

PATCH /groups/{id}/events/{id}

Cabeçalhos de solicitação

Corpo da solicitação

Forneça um corpo JSON de cada objeto singleValueLegacyExtendedProperty na propriedade da coleção singleValueExtendedProperties da instância do recurso.

Ao criar uma propriedade estendida em uma nova instância de recurso, além da nova coleção singleValueExtendedProperties , forneça uma representação JSON dessa instância de recurso (ou seja, uma mensagem, mailFolder, evento, todoTask etc.)

Resposta

Código da resposta

Uma operação que cria com êxito uma propriedade estendida em uma nova instância de recurso retorna um código de 201 Created resposta. No caso de uma nova postagem de grupo, dependendo do método usado, a operação retorna um código de resposta ou um 200 OK202 Accepted .

Em uma instância de recurso existente, uma operação de criação bem-sucedida retorna 200 OK.

Corpo da resposta

Quando você cria uma propriedade estendida, a resposta inclui apenas a instância nova ou existente, mas não a nova propriedade estendida. Para ver a propriedade estendida recém-criada, obtenha a instância expandida com a propriedade estendida.

Quando você cria uma propriedade estendida em uma novapostagem de grupo respondendo a um tópico ou postagem, a resposta inclui apenas um código de resposta, mas não a nova postagem nem a propriedade estendida.

Exemplos

Solicitação 1

O primeiro exemplo cria um novo evento e uma propriedade de valor único estendida na mesma operação POST. Além das propriedades que você normalmente incluiria para um novo evento, o corpo da solicitação inclui a coleção singleValueExtendedProperties, que contém uma propriedade estendida de valor único e as seguintes informações sobre a propriedade:

• id especifica o tipo de propriedade como String, o GUID e a propriedade nomeada Fun.
• value especifica Food como o valor da propriedade Fun.

POST https://graph.microsoft.com/beta/me/events
Content-Type: application/json

{
  "subject": "Celebrate Thanksgiving",
  "body": {
    "contentType": "HTML",
    "content": "Let's get together!"
  },
  "start": {
      "dateTime": "2015-11-26T18:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "end": {
      "dateTime": "2015-11-26T23:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "attendees": [
    {
      "emailAddress": {
        "address": "Terrie@contoso.com",
        "name": "Terrie Barrera"
      },
      "type": "Required"
    }
  ],
  "singleValueExtendedProperties": [
     {
       "id":"String {66f5a359-4659-4830-9070-00040ec6ac6e} Name Fun",
       "value":"Food"
     }
  ]
}

Resposta 1

Uma resposta bem-sucedida é indicada por um código de resposta HTTP 201 Created e inclui o novo evento em seu corpo, semelhante à resposta da criação de apenas um evento. A resposta não inclui nenhuma propriedade estendida recém-criada.

Para ver a propriedade estendida recém-criada, obtenha o evento expandido com a propriedade estendida.

Solicitação 2

O segundo exemplo cria uma propriedade estendido de valor único para a mensagem especificada existente. A propriedade estendida é o único elemento na matriz singleValueExtendedProperties. O corpo da solicitação inclui o seguinte para essa propriedade estendida:

• id especifica o tipo de propriedade como String, o GUID e a propriedade nomeada Color.
• value especifica Green como o valor da propriedade Color.

PATCH https://graph.microsoft.com/beta/me/messages('AAMkAGE1M2_bs88AACHsLqWAAA=')

Content-Type: application/json

{
  "singleValueExtendedProperties": [
      {
         "id":"String {66f5a359-4659-4830-9070-00047ec6ac6e} Name Color",
         "value":"Green"
      }
    ]
}

Resposta 2

Uma resposta bem-sucedida é indicada por um código de resposta HTTP 200 OK e inclui a mensagem especificada em seu corpo, semelhante à resposta da atualização de uma mensagem. A resposta não inclui a propriedade estendida recém-criada.

Para ver a propriedade estendida recém-criada, obtenha a mensagem expandida com a propriedade estendida.