Completar operaciones básicas con puntos de conexión REST de SharePoint

You can perform basic create, read, update, and delete (CRUD) operations by using the Representational State Transfer (REST) interface provided by SharePoint. The REST interface exposes all the SharePoint entities and operations that are available in the other SharePoint client APIs. One advantage of using REST is that you don't have to add references to any SharePoint libraries or client assemblies. Instead, you make HTTP requests to the appropriate endpoints to retrieve or update SharePoint entities, such as webs, lists, and list items.

Para obtener una introducción completa a la interfaz de REST de SharePoint y su arquitectura, vea Introducción al servicio REST para SharePoint.

Para obtener información sobre cómo se trabaja con las entidades de SharePoint principales, vea Trabajar con listas y elementos de lista con REST y Trabajar con carpetas y archivos con REST.

Para obtener un ejemplo de cómo ejecutar varias operaciones de este tipo en el contexto de una aplicación web ASP.NET escrita en C#, vea SharePoint-Add-in-REST-OData-BasicDataOperations.

Para obtener información sobre los conjuntos de API disponibles en la plataforma de SharePoint, vea Choose the right API set in SharePoint (Elegir el conjunto de API correcto en SharePoint).

Para obtener información sobre cómo usar las otras API cliente, vea lo siguiente:

• Completar operaciones básicas con código de biblioteca de JavaScript en SharePoint- Completar operaciones básicas con código de una biblioteca cliente de SharePoint
• Creación de aplicaciones de Windows Phone con acceso a SharePoint

Operaciones HTTP en servicios REST de SharePoint

The endpoints in the SharePoint REST service correspond to the types and members in the SharePoint client object models. By using HTTP requests, you can use these REST endpoints to perform typical CRUD (Create, Read, Update, and Delete) operations against SharePoint entities, such as lists and sites.

Normalmente, los puntos de conexión que representan operaciones de lectura se asignan a comandos GET HTTP. Los puntos de conexión que representan operaciones de creación se asignan a comandos POST HTTP, y los puntos de conexión que representan tareas de actualización o inserción se asignan a comandos PUT HTTP.

En SharePoint, use POST para crear entidades tales como listas y sitios. El servicio REST de SharePoint admite el envío de comandos POST que incluyen definiciones de objetos a extremos que representan colecciones. Por ejemplo, podría enviar un comando POST que incluyera una nueva definición de objetos de lista en ATOM a la siguiente dirección URL para crear una lista de SharePoint:

http://<site url>/_api/web/lists

Para tareas POST, toda propiedad innecesaria se establece en sus valores predeterminados. Si trata de establecer una propiedad de solo lectura como parte de una tarea POST, el servicio devuelve una excepción.

Use operaciones PUT y MERGE para actualizar objetos de SharePoint existentes. Los extremos de servicios que representan una operación set de propiedades de objeto admiten tanto solicitudes PUT como solicitudes MERGE. En el caso de las solicitudes MERGE, configurar las propiedades es opcional, de manera que aquellas que no defina explícitamente retendrán la propiedad actual. En el caso de los comandos PUT, sin embargo, las propiedades que no se configuren explícitamente se establecerán en los valores predeterminados. Además, si no especifica todas las propiedades necesarias en actualizaciones de objeto cuando use comandos PUT de HTTP, el servicio REST devolverá una excepción.

Use el comando HTTP DELETE con la dirección URL específica del extremo para eliminar el objeto de SharePoint representado por ese extremo. En el caso de los objetos reciclables, como listas, archivos y elementos de lista, esto da como resultado una operación Recycle.

Lectura de datos con la interfaz de REST de SharePoint

Para usar las capacidades de REST que están integradas en SharePoint, construya una solicitud RESTful HTTP usando el estándar OData, que corresponde a la API del modelo de objetos de cliente que quiere usar. Cada entidad de SharePoint se expone en un extremo del sitio de SharePoint de destino y sus metadatos se representan en formato XML o JSON. Puede efectuar las solicitudes HTTP en cualquier lenguaje, incluidos, entre otros, JavaScript y C#.

To read information from a REST endpoint, you must know both the URL of the endpoint and the OData representation of the SharePoint entity that is exposed at that endpoint. For example, to retrieve all the lists in a specific SharePoint site, you would make a GET request to http://<site url>/_api/web/lists. You can navigate to this URL in your browser and see the XML that gets returned. When you make the request in code, you can specify whether to receive the OData representation of the lists in XML or JSON.

The following C# code demonstrates how to make this GET request that returns a JSON representation of all of a site's lists by using JQuery. It also assumes that you have a valid OAuth access token that is stored in the accessToken variable. You do not need the access token if you make this call from inside an add-in web, as you would in a SharePoint-hosted add-in. Note that you cannot obtain an access token from code that is running on a browser client. You must obtain the access token from code that is running on a server.

Para obtener más información sobre cómo se puede obtener un token de acceso, vea Flujo de tokens de contexto de OAuth para complementos para SharePoint y Flujo de código de autenticación de OAuth para aplicaciones en SharePoint.

HttpWebRequest endpointRequest =
  (HttpWebRequest)HttpWebRequest.Create(
  "http://<site url>/_api/web/lists");
endpointRequest.Method = "GET";
endpointRequest.Accept = "application/json;odata=verbose";
endpointRequest.Headers.Add("Authorization",
  "Bearer " + accessToken);
HttpWebResponse endpointResponse =
  (HttpWebResponse)endpointRequest.GetResponse();

This request would look a little different if you are writing your add-in in JavaScript while using the SharePoint cross-domain library. In this case, you don't need to provide an access token.

The following code demonstrates how this request would look if you are using the cross-domain library and want to receive the OData representation of the lists as XML instead of JSON. (Because Atom is the default response format, you don't have to include an Accept header.) For more information about using the cross-domain library, see Access SharePoint data from add-ins using the cross-domain library.

var executor = new SP.RequestExecutor(appweburl);
executor.executeAsync(
  {
    url: appweburl +
          "/_api/SP.AppContextSite(@target)/web/lists?@target='" +
          hostweburl + "'",
    method: "GET",
    success: successHandler,
    error: errorHandler
  }
);

El código del ejemplo siguiente muestra cómo solicitar una representación JSON de todas las listas de un sitio usando C#. Se presupone que el usuario tiene un token de acceso OAuth que se almacena en la variable accessToken.

HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(sharepointUrl.ToString() + "/_api/web/lists");
endpointRequest.Method = "GET";
endpointRequest.Accept = "application/json;odata=verbose";
endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();

Obtener propiedades que no se devuelven con el recurso

Muchos valores de propiedades se devuelven cuando se recupera un recurso, pero con algunas propiedades, se debe enviar una solicitud GET directamente al extremo de la propiedad. Esto suele ser así con las propiedades que representan entidades de SharePoint.

El siguiente ejemplo muestra cómo obtener una propiedad anexando el nombre de la propiedad al extremo del recurso. El ejemplo obtiene el valor de la propiedad de Author de un recurso File.

http://<site url>/_api/web/getfilebyserverrelativeurl('/<folder name>/<file name>')/author

Para obtener los resultados en formato JSON, incluya un encabezado Accept establecido en "application/json;odata=verbose".

Escritura de datos mediante la interfaz de REST

Puede crear y actualizar entidades de SharePoint creando solicitudes RESTful HTTP en los extremos apropiados igual que cuando lee datos. No obstante, una de las diferencias clave es que se usa una solicitud POST. Cuando actualiza entidades, también pasa un método de solicitud HTTP PUT o MERGE agregando uno de estos términos a los encabezados de la solicitud como valor de la clave X-HTTP-Method. El método MERGE actualiza únicamente las propiedades de la entidad que especifica el usuario, mientras que el método PUT sustituye la entidad existente por otra nueva que se suministra en el cuerpo de POST. Use el método DELETE para eliminar la entidad. Si crea o actualiza una entidad, debe proporcionar una representación OData de la entidad que quiere crear o cambiar en el cuerpo de la solicitud HTTP.

Cuando cree, actualice o elimine entidades de SharePoint, es importante que tenga en cuenta que, si no usa OAuth para autorizar sus solicitudes, estas operaciones también necesitan el valor de resumen de formulario de solicitud del servidor como valor del encabezado X-RequestDigest. Puede recuperar este valor ejecutando una solicitud POST con un cuerpo vacío a http://<site url>/_api/contextinfo y extrayendo el valor del nodo d:FormDigestValue en el XML que el extremo contextinfo devuelve. En el siguiente ejemplo se ve una solicitud HTTP al extremo contextinfo de C#.

HttpWebRequest endpointRequest =(HttpWebRequest)HttpWebRequest.Create(
                                    "http://<site url>/_api/contextinfo");
endpointRequest.Method = "POST";
endpointRequest.Accept = "application/json;odata=verbose";
HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();

Si usa el flujo de autorización y autenticación descrito en Autorización y autenticación de complementos de SharePoint, no necesita incluir el resumen de solicitud en sus solicitudes.

Si usa la biblioteca entre dominios de JavaScript, SP.RequestExecutor controla la obtención y el envío del valor implícito del formulario.

If you're creating a SharePoint-hosted SharePoint Add-in, you don't have to make a separate HTTP request to retrieve the form digest value. Instead, you can retrieve the value in JavaScript code from the SharePoint page (if the page uses the default master page), as shown in the following example, which uses JQuery and creates a list.

jQuery.ajax({
        url: "http://<site url>/_api/web/lists",
        type: "POST",
        data:  JSON.stringify({ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true,
 'BaseTemplate': 100, 'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test' }
),
        headers: {
            "accept": "application/json;odata=verbose",
            "content-type": "application/json;odata=verbose",
            "content-length": <length of post body>,
            "X-RequestDigest": $("#__REQUESTDIGEST").val()
        },
        success: doSuccess,
        error: doError
});

En el ejemplo siguiente se muestra cómo actualizar la lista que se creó en el ejemplo anterior. El ejemplo cambia el título de la lista, usa JQuery y presupone que esta operación se está ejecutando en un complemento hospedado en SharePoint.

jQuery.ajax({
        url: "http://<site url>/_api/web/lists/GetByTitle('Test')",
        type: "POST",
        data: JSON.stringify({ '__metadata': { 'type': 'SP.List' }, 'Title': 'New title' }),
        headers: {
            "X-HTTP-Method":"MERGE",
            "accept": "application/json;odata=verbose",
            "content-type": "application/json;odata=verbose",
            "content-length": <length of post body>,
            "X-RequestDigest": $("#__REQUESTDIGEST").val(),
            "IF-MATCH": "*"
        },
        success: doSuccess,
        error: doError
});

The value of the IF-MATCH key in the request headers is where you specify the etag value of a list or list item. This particular value applies only to lists and list items, and is intended to help you avoid concurrency problems when you update those entities. The previous example uses an asterisk (*) for this value, and you can use that value whenever you don't have any reason to worry about concurrency issues. Otherwise, you should obtain the etag value or a list or list item by performing a GET request that retrieves the entity. The response headers of the resulting HTTP response pass the etag as the value of the ETag key. This value is also included in the entity metadata.

The following example shows the opening <entry> tag for the XML node that contains the list information. The m:etag property contains the etag value.

<entry xml:base="http://site url/_api/" xmlns=http://www.w3.org/2005/Atom
       xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
       xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
       xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" m:etag=""1"">

Crear un sitio con REST

En el siguiente ejemplo, se muestra cómo crear un sitio en JavaScript.

jQuery.ajax({
    url: "http://<site url>/_api/web/webinfos/add",
    type: "POST",
    data: JSON.stringify(
        {'parameters': {
            '__metadata':  {'type': 'SP.WebInfoCreationInformation' },
            'Url': 'RestSubWeb',
            'Title': 'RestSubWeb',
            'Description': 'REST created web',
            'Language':1033,
            'WebTemplate':'sts',
            'UseUniquePermissions':false}
        }
    ),
    headers: {
        "accept": "application/json; odata=verbose",
        "content-type":"application/json;odata=verbose",
        "content-length": <length of post body>,
        "X-RequestDigest": $("#__REQUESTDIGEST").val()
    },
    success: doSuccess,
    error: doError
});

Cómo difieren las solicitudes REST por entorno

La creación y el envío de una solicitud HTTP puede variar en función del tipo de lenguaje, de biblioteca y de complemento, por lo que con frecuencia se debe cambiar uno o más componentes de la solicitud cuando se traduce una solicitud de un entorno a otro. Por ejemplo, las solicitudes de jQuery AJAX usan parámetros data y type para especificar el tipo y el cuerpo de la solicitud, pero las solicitudes de biblioteca entre dominios usan parámetros body y method para especificar dichos valores.

En las secciones siguientes, se describen otras diferencias comunes entre entornos.

La manera de obtener y enviar el valor implícito del formulario depende del complemento

Al enviar una solicitud POST, hay que incluir el valor de síntesis de formulario en el encabezado X-RequestDigest. Sin embargo, la forma de obtener y enviar el valor difiere según el complemento:

• En complementos hospedados en SharePoint, solo es necesario pasar el encabezado siguiente:

  "X-RequestDigest": $("#__REQUESTDIGEST").val()

• En los complementos hospedados en la nube que usen OAuth, primero recupere el valor de síntesis de formulario enviando una solicitud al extremo de contextinfo y luego agréguelo a las solicitudes, tal como se muestra en Escritura de datos mediante la interfaz de REST.

• En los complementos hospedados en la nube que usan la biblioteca entre dominios de JavaScript, no es necesario especificar el valor de síntesis de formulario. De manera predeterminada, SP.RequestExecutor lo hace automáticamente. (También controla el valor content-length).

Los complementos que usan OAuth deben pasar tokens de acceso en las solicitudes

Cloud-hosted add-ins use either OAuth or the cross-domain library to authorize access to SharePoint data. Add-in components with code that runs on a remote web server must use OAuth to authorize access to SharePoint data. In this case, you need to include an Authorization header to send the access token. For an example that adds an authorization header to an HTTPWebRequest object, see Reading data with the SharePoint REST interface.

Para leer más información sobre los tokens de acceso OAuth y sobre cómo obtenerlos, vea Flujo de tokens de contexto de OAuth para complementos para SharePoint y Flujo de código de autenticación de OAuth para aplicaciones en SharePoint.

Los URI de punto de conexión en solicitudes entre dominios usan SP.AppContextSite para cambiar el contexto

Las solicitudes se envían al punto de conexión del recurso que se especifica en la propiedad url de la solicitud. Los URI de punto de conexión usan el siguiente formato:

<site url>/_api/<context>/<resource> (ejemplo, https://contoso.com/_api/web/lists)

Las solicitudes de biblioteca entre dominios usan este formato cuando acceden a datos en la web de complemento, que es el contexto predeterminado para las solicitudes de biblioteca entre dominios. Sin embargo, para acceder a datos en la web de hospedaje o en otra colección de sitios, las solicitudes deben inicializar la web de hospedaje u otra colección de sitios como contexto. Para ello, usan el extremo SP.AppContextSite del URI, tal como se muestra en la Tabla 1. Los URI de ejemplo de la Tabla 1 usan el alias @target para enviar la dirección URL de destino de la cadena de consulta porque la dirección URL contiene un carácter especial (':').

Tabla 1: Usar el punto de conexión SP.AppContextSite para cambiar el contexto de la solicitud

SharePoint Add-ins can get the add-in web URL and host web URL from the query string of the add-in page, as shown in the following code example. The example also shows how to reference the cross-domain library, which is defined in the SP.RequestExecutor.js file on the host web. The example assumes that your add-in launches from SharePoint. For guidance about setting your SharePoint context correctly when your add-in does not launch from SharePoint, see Authorization Code OAuth flow for SharePoint Add-ins.

var hostweburl;
var appweburl;

// Get the URLs for the add-in web the host web URL from the query string.
$(document).ready(function () {
  //Get the URI decoded URLs.
  hostweburl = decodeURIComponent(getQueryStringParameter("SPHostUrl"));
  appweburl = decodeURIComponent(getQueryStringParameter("SPAppWebUrl"));

  // Load the SP.RequestExecutor.js file.
  $.getScript(hostweburl + "/_layouts/15/SP.RequestExecutor.js", runCrossDomainRequest);
});

// Build and send the HTTP request.
function runCrossDomainRequest() {
  var executor = new SP.RequestExecutor(appweburl);
  executor.executeAsync({
      url: appweburl + "/_api/SP.AppContextSite(@target)/web/lists?@target='" + hostweburl + "'",
      method: "GET",
      headers: { "Accept": "application/json; odata=verbose" },
      success: successHandler,
      error: errorHandler
  });
}

// Get a query string value.
// For production add-ins, you may want to use a library to handle the query string.
function getQueryStringParameter(paramToRetrieve) {
  var params = document.URL.split("?")[1].split("&");
  var strParams = "";
  for (var i = 0; i < params.length; i = i + 1) {
    var singleParam = params[i].split("=");
    if (singleParam[0] == paramToRetrieve) return singleParam[1];
  }
}
??? // success and error callback functions

Propiedades usadas en solicitudes REST

En la tabla 2, se muestran propiedades que se suelen usar en solicitudes HTTP para el servicio REST de SharePoint.

Tabla 2. Cuándo usar propiedades de solicitud de REST en solicitudes HTTP

Compatibilidad con trabajos por lotes

El servicio REST de SharePoint Online (y SharePoint 2016 local o versiones posteriores) admite la combinación de varias solicitudes en una sola llamada al servicio mediante la opción de consulta $batch de OData. Para obtener más información y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API REST.

Vea también

• Introducción al servicio REST para SharePoint
• Acceso a datos seguro y modelos de objetos de cliente para complementos de SharePoint
• Trabajar con datos externos en SharePoint
• Recursos de OData
• Establecer permisos personalizados en una lista usando la interfaz de REST
• Desarrollar complementos de SharePoint