Servicio REST de SharePoint
SharePoint incluye un servicio de Transferencia de Estado Representacional (REST) que es comparable a los modelos existentes de objeto de cliente de SharePoint. Ahora, los desarrolladores pueden interactuar de forma remota con datos de SharePoint mediante el uso de cualquier tecnología que admita solicitudes web REST. Básicamente, los desarrolladores pueden realizar operaciones de creación, lectura, actualización y eliminación (CRUD) desde sus complementos, soluciones y aplicaciones cliente de SharePoint mediante el uso de tecnologías web REST y la sintaxis estándar de Open Data Protocol (OData).
Cómo funciona el servicio REST de SharePoint
SharePoint agrega la capacidad de interactuar de forma remota con sitios de SharePoint mediante REST. Ahora puede interactuar directamente con objetos de SharePoint mediante el uso de cualquier tecnología que admita capacidades REST estándar.
Para obtener acceder a recursos de SharePoint usando REST, puede crear una solicitud de HTTP RESTful mediante el estándar OData, que corresponde a la API de modelo de objeto de cliente deseada, como se muestra en el siguiente ejemplo:
GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Usar comandos HTTP con servicio REST de SharePoint
Para usar las capacidades REST que se integran en SharePoint, puede crear una solicitud de HTTP RESTful mediante el estándar OData, que corresponde a la API de modelo de objeto de cliente que desea usar. El servicio web client.svc gestiona la solicitud de HTTP y proporciona la respuesta adecuada en formato Atom o JSON. A continuación, la aplicación cliente debe analizar esa respuesta.
Los puntos de conexión en el servicio REST de SharePoint corresponde a los tipos y miembros de los modelos de objeto de cliente de SharePoint. Mediante el uso de solicitudes de HTTP, puede usar estos puntos de conexión REST para realizar operaciones CRUD típicas en entidades de SharePoint, como listas y sitios.
La siguiente tabla brinda una descripción general de las solicitudes de HTTP.
| Acción | Solicitud de HTTP | No olvide que: |
|---|---|---|
| Leer un recurso | GET | Es posible que sea necesario modificar el formato de los datos devueltos. |
| Crear o actualizar un recurso | POST | Use POST para crear entidades como listas y sitios. El servicio REST de SharePoint admite el envío de comandos POST que incluyen definiciones de objetos a puntos de conexión que representan colecciones. Para operaciones POST, las propiedades que no son necesarias se establecen en sus valores predeterminados. Si intenta establecer una propiedad de solo lectura como parte de una operación POST, el servicio devuelve una excepción. |
| Actualizar o insertar un recurso | PUT | Use las operaciones PUT y MERGE para actualizar los objetos existentes de SharePoint. Cualquier punto de conexión del servicio que represente una operación de conjunto de propiedades de objeto admite solicitudes PUT y solicitudes MERGE. Para solicitudes MERGE, la configuración de propiedades es opcional; las propiedades que no establezca explícitamente conservan su propiedad actual. Para solicitudes PUT, si no especifica todas las propiedades necesarias en las actualizaciones de objetos, el servicio REST devuelve una excepción. Las propiedades opcionales que no especifique explícitamente se establecen en sus propiedades predeterminadas. |
| Eliminar un recurso | DELETE | Use el comando HTTP DELETE en la URL del punto de conexión específica para eliminar el objeto de SharePoint que está representado por ese punto de conexión. Los objetos reciclables están disponibles, como listas, archivos y elementos de lista, lo que da como resultado una operación de reciclaje. |
Crear URL de REST para obtener acceso a recursos de SharePoint
SharePoint usa API de REST. Una API es un intermediario de software que permite que dos aplicaciones se comuniquen entre sí. Cada vez que usa una aplicación en su teléfono para consultar el tiempo, está usando una API.
Para crear puntos de conexión del servicio REST de SharePoint, siga estos pasos:
Empiece con la referencia del servicio REST:
https://{site_url}/_apiEspecifique el punto de entrada apropiado, por ejemplo:
https://{site_url}/_api/webEjemplo:
https://contoso.sharepoint.com/_api/webVaya desde el punto de entrada a los recursos específicos a los que desea acceder, incluida la especificación de parámetros para los puntos de conexión que corresponden a los métodos en el modelo de objetos de cliente, por ejemplo:
https://{site_url}/_api/web/lists/getbytitle('list_name')Ejemplo:
https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')