Crear propiedad extendida de valor único

Espacio de nombres: microsoft.graph

Cree una o varias propiedades extendidas de valor único en una instancia nueva o existente de un recurso.

Se admiten los siguientes recursos de usuario:

• calendar
• contact
• contactFolder
• event
• mailFolder
• message
• Tarea de Outlook
• Carpeta de tareas de Outlook
• todoTask

Se admiten los siguientes recursos de grupo:

• calendar de grupo
• evento de grupo
• post de grupo

Para obtener más información sobre cuándo usar extensiones abiertas o propiedades extendidas y cómo especificar propiedades extendidas, consulte Información general sobre las propiedades extendidas.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Permissions

Según el recurso en el que va a crear la propiedad extendida y el tipo de permiso (delegado o aplicación) que solicite, el permiso especificado en la tabla siguiente es el mínimo necesario para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Solicitud HTTP

Puede crear propiedades extendidas en una instancia de recurso nueva o existente.

Para crear una o varias propiedades extendidas en una instancia de recurso nueva, use la misma solicitud de REST que al crear la instancia e incluya las propiedades de la nueva instancia de recurso y de la propiedad extendida en el cuerpo de la solicitud. Algunos recursos admiten la creación de más de una manera. Para obtener más información sobre cómo crear estas instancias de recursos, vea los temas correspondientes para crear un mensaje, mailFolder, evento, calendario, contacto, contactFolder, tarea de Outlook, carpeta de tareas de Outlook, evento de grupo, publicación de grupo y todoTask.

A continuación tiene la sintaxis de las solicitudes.

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 /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 /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 crear una o varias propiedades extendidas en una instancia de recurso existente, especifique la instancia en la solicitud e incluya la propiedad extendida en el cuerpo de la solicitud.

Nota No se puede crear una propiedad extendida en una publicación 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 /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 /groups/{id}/events/{id}

Encabezados de solicitud

Cuerpo de la solicitud

Proporcione un cuerpo JSON para cada objeto singleValueLegacyExtendedProperty en la propiedad de la colección singleValueExtendedProperties de la instancia de recurso.

Al crear una propiedad extendida en una nueva instancia de recurso, además de la nueva colección singleValueExtendedProperties , proporcione una representación JSON de esa instancia de recurso (es decir, un mensaje, mailFolder, evento, todoTask, etc.)

Respuesta

Código de respuesta

Una operación que crea correctamente una propiedad extendida en una nueva instancia de recurso devuelve un código de 201 Created respuesta. En el caso de una nueva publicación de grupo, en función del método usado, la operación devuelve un 200 OK código de respuesta o 202 Accepted .

En una instancia de recurso existente, una operación que se ejecuta correctamente devuelve 200 OK.

Cuerpo de la respuesta

Al crear una propiedad extendida, la respuesta incluye solo la instancia nueva o existente, pero no la nueva propiedad extendida. Para ver la propiedad extendida recién creada, expanda la instancia con la propiedad extendida.

Al crear una propiedad extendida en una nuevapublicación de grupo respondiendo a un subproceso o publicación, la respuesta solo incluye un código de respuesta, pero no la nueva publicación ni la propiedad extendida.

Ejemplos

Solicitud 1

El primer ejemplo crea un evento nuevo y una propiedad extendida de valor único en la misma operación POST. Aparte de las propiedades que normalmente incluiría en un nuevo evento, el cuerpo de la solicitud incluye la colección singleValueExtendedProperties que contiene una propiedad extendida de valor único y lo siguiente para la propiedad:

• id especifica el tipo de propiedad como String, el GUID y la propiedad denominada Fun.
• value especifica Food como el valor de la propiedad 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"
     }
  ]
}

Respuesta 1

Una respuesta correcta se indica mediante un HTTP 201 Created código de respuesta e incluye el nuevo evento en el cuerpo de la respuesta, de forma similar a la respuesta de crear solo un evento. La respuesta no incluye ninguna propiedad extendida recién creada.

Para ver la propiedad extendida recién creada, expanda el evento con la propiedad extendida.

Solicitud 2

El segundo ejemplo crea una propiedad extendida de valor único para el mensaje existente especificado. La propiedad extendida es el único elemento de la matriz singleValueExtendedProperties. El cuerpo de la solicitud incluye lo siguiente para la propiedad extendida:

• id especifica el tipo de propiedad como String, el GUID y la propiedad denominada Color.
• value especifica Green como el valor de la propiedad 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"
      }
    ]
}

Respuesta 2

Una respuesta correcta se indica mediante un HTTP 200 OK código de respuesta e incluye el mensaje especificado en el cuerpo de la respuesta, de forma similar a la respuesta de la actualización de un mensaje. La respuesta no incluye la propiedad extendida recién creada.

Para ver la propiedad extendida recién creada, expanda el mensaje con la propiedad extendida.