Crear propiedad extendida de varios valores

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Precaución

Las aplicaciones existentes que usan esta característica con tareas de Outlook deben actualizarse, ya que las tareas de Outlook están en desuso. Consulte Api de tareas pendientes en versión preliminar pública para obtener más información.

Cree una o más propiedades extendidas de varios valores en una instancia nueva o existente de un recurso.

Se admiten los siguientes recursos de usuario:

Y los siguientes recursos de grupo:

Consulte el artículo de información general sobre las propiedades extendidas para obtener más información sobre cuándo usar las extensiones abiertas o las propiedades extendidas y cómo especificar las propiedades extendidas.

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

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

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.

Recurso admitido Delegado (cuenta profesional o educativa) Delegado (cuenta de Microsoft personal) Aplicación
calendar Calendars.ReadWrite Calendars.ReadWrite Calendars.ReadWrite
contact Contacts.ReadWrite Contacts.ReadWrite Contacts.ReadWrite
contactFolder Contacts.ReadWrite Contacts.ReadWrite Contacts.ReadWrite
evento Calendars.ReadWrite Calendars.ReadWrite Calendars.ReadWrite
calendar de grupo Group.ReadWrite.All No admitido No se admite
evento de grupo Group.ReadWrite.All No admitido No se admite
post de grupo Group.ReadWrite.All No admitido No se admite
mailFolder Mail.ReadWrite Mail.ReadWrite Mail.ReadWrite
mensaje Mail.ReadWrite Mail.ReadWrite Mail.ReadWrite
Tarea de Outlook Tasks.ReadWrite Tasks.ReadWrite No compatible
Carpeta de tareas de Outlook Tasks.ReadWrite Tasks.ReadWrite No compatible

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 y publicación de grupo.

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 /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 /groups/{id}/events/{id}

Encabezados de solicitud

Nombre Valor
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json

Cuerpo de la solicitud

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

Propiedad Tipo Descripción
multiValueExtendedProperties Colección multiValueLegacyExtendedProperty Una matriz de una o más propiedades extendidas con varios valores.
id String Para cada propiedad de la colección multiValueExtendedProperties, especifique esto para identificar la propiedad. Debe tener uno de los formatos compatibles. Consulte la Información general de las propiedades extendidas de Outlook para obtener más información. Necesario.
value string Para cada propiedad de la colección multiValueExtendedProperties, especifique el valor de la propiedad. Obligatorio.

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

Respuesta

Código de respuesta

Una operación que crea correctamente una propiedad extendida en una nueva instancia de recurso devuelve 201 Created, excepto en un mensaje de grupo nuevo, ya que, según el método usado, la operación puede devolver 200 OK 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 en un recurso compatible distinto a la publicación de grupo, 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 publicación de grupo nueva, la respuesta incluye solo un código de respuesta, pero no la nueva publicación ni la propiedad extendida. No se puede crear una propiedad extendida en una publicación de grupo existente.

Ejemplo

Solicitud 1

En el primer ejemplo se crea una propiedad extendida de varios valores en un nuevo evento durante la misma operación POST. Aparte de las propiedades que normalmente incluiría para un nuevo evento, el cuerpo de la solicitud incluye la colección multiValueExtendedProperties que contiene una propiedad extendida. El cuerpo de la solicitud incluye lo siguiente para esa propiedad extendida de varios valores:

  • id, que especifica la propiedad como una matriz de cadenas con el GUID especificado y el nombre Recreation.
  • value, que especifica Recreation como una matriz de 3 valores de cadena, ["Food", "Hiking", "Swimming"].
POST https://graph.microsoft.com/beta/me/events
Content-Type: application/json

{
  "subject": "Family reunion",
  "body": {
    "contentType": "HTML",
    "content": "Let's get together this Thanksgiving!"
  },
  "start": {
      "dateTime": "2015-11-26T09:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "end": {
      "dateTime": "2015-11-29T21:00:00",
      "timeZone": "Pacific Standard Time"
  },
  "attendees": [
    {
      "emailAddress": {
        "address": "Terrie@contoso.com",
        "name": "Terrie Barrera"
      },
      "type": "Required"
    },
    {
      "emailAddress": {
        "address": "Lauren@contoso.com",
        "name": "Lauren Solis"
      },
      "type": "Required"
    }
  ],
  "multiValueExtendedProperties": [
     {
           "id":"StringArray {66f5a359-4659-4830-9070-00050ec6ac6e} Name Recreation",
           "value": ["Food", "Hiking", "Swimming"]
     }
  ]
}
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 varios valores para el mensaje especificado. La propiedad extendida es el único elemento de la colección multiValueExtendedProperties. El cuerpo de la solicitud incluye lo siguiente para la propiedad extendida de varios valores:

  • id especifica la propiedad como una matriz de cadenas con el GUID especificado y el nombre Palette.
  • valor especifica Palette como una matriz de 3 valores de cadena, ["Green", "Aqua", "Blue"].
PATCH https://graph.microsoft.com/beta/me/messages('AAMkAGE1M2_as77AACHsLrBBBA=')

Content-Type: application/json

{
  "multiValueExtendedProperties": [
      {
         "id":"StringArray {66f5a359-4659-4830-9070-00049ec6ac6e} Name Palette",
         "value":["Green", "Aqua", "Blue"]
      }
    ]
}
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.