Referencia y ejemplos de las API de REST

Encuentre documentación en MSDN sobre la interfaz de transferencia de estado representacional (REST) de SharePoint 2013.

Esta página contiene vínculos a recursos REST de uso habitual que están disponibles para los desarrolladores de SharePoint 2013.

Última modificación: martes, 17 de noviembre de 2015

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

Vea el vídeo: Conceptos básicos de SharePoint 2013 REST y OData

Sugerencia

El servicio REST de SharePoint Online admite la combinación de varias solicitudes en una sola llamada al servicio mediante el uso de la opción de consulta $batch de OData. Para obtener información detallada y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API de REST. Esta opción aún no está disponible para la implementación de SharePoint local.

Referencia de REST de SharePoint 2013

Nota

Algunos de los siguientes vínculos abren la documentación para el objeto JavaScript correspondiente, que muestra el extremo de REST en la parte inferior de la página.

Extremos principales de REST

Recurso	Descripción
SP. ChangeCollection object (sp.js)	Representa una colección de objetos SP.Change.
SP. EventReceiverDefinitionCollection object (sp.js)	Representa una colección de objetos EventReceiverDefinition que se usan para enumerar una lista de receptores de eventos registrados para objetos Microsoft SharePoint Foundation.
SP. EventReceiverDefinition object (sp.js)
SP. FeatureCollection object (sp.js)	Representa una colección de objetos SP.Feature.
SP. Objeto de característica (Object sp.js)	Representa una característica activada.
SP. RecycleBinItemCollection object (sp.js)	Representa una colección de objetos SP.RecycleBinItem.
SP. RecycleBinItem object (sp.js)	Representa un elemento de papelera de reciclaje en la papelera de reciclaje de un sitio o una colección de sitios.
SP. RegionalSettings object (sp.js)	Representa la configuración regional que se usa en el servidor que ejecuta Microsoft SharePoint Foundation.
SP. Objeto de sitio (Object sp.js)	Representa una colección de sitios de una aplicación web, incluidos un sitio web de primer nivel y todos sus subsitios.
SP. TimeZoneCollection object (sp.js)
SP. Objeto TimeZone (Object sp.js)
Web	Representa un sitio de SharePoint.
SP. WebTemplateCollection object (sp.js)	Especifica una colección de plantillas de sitio.
SP. WebTemplate object (sp.js)	Especifica una definición de sitio o plantilla de sitio usada para crear una instancia de un sitio.

Extremos de REST relacionados con listas

Recurso	Descripción
ListCollection	Representa una colección de recursos List.
List	Representa una lista de un sitio web de SharePoint.
ListItemCollection	Representa una colección de recursos ListItem.
ListItem	Representa un elemento o una fila de una lista.
SP. ContentTypeCollection object (sp.js)	Representa una colección de tipos de contenido de lista o sitio web.
SP. ContentType object (sp.js)	Representa el tipo de contenido de un sitio web o una lista.
FieldCollection	Representa una colección de recursos Field.
Field	Representa un campo de una lista de un sitio web de Microsoft SharePoint Foundation.
SP. FieldLinkCollection object (sp.js)	Representa una colección de objetos SP.FieldLink que son referencias de columna o campo en un tipo de contenido.
SP. FieldLink object (sp.js)	Especifica una referencia a un campo o una definición de campo de un tipo de contenido.
SP. FormCollection object (sp.js)	Representa una colección de objetos SP.Form de una lista.
SP. Objeto Form (Object sp.js)	Un formulario que proporciona una interfaz de presentación y edición para un solo elemento de lista.
Objeto SP.InformationRightsManagementSettings (Object sp.js)
SP. ListTemplateCollection object (sp.js)	Representa una colección de objetos SP.ListTemplate.
SP. Objeto ListTemplate (Object sp.js)	Especifica una plantilla de lista.
SP. RelatedFieldCollection object (sp.js)	Representa una colección de objetos SP.RelatedField que almacenan propiedades de campos de búsqueda de relación.
SP. RelatedField object (sp.js)	Especifica una relación con un campo de búsqueda.
ViewCollection	Representa una colección de recursos View.
View	Especifica una vista de lista.
ViewFieldCollection	Representa una colección de campos de una vista de lista.

Extremos de REST para archivos y carpetas

Recurso	Descripción
FileCollection	Representa una colección de recursos File.
File	Representa un archivo de un sitio web de SharePoint que puede ser una página de elementos web, un elemento de una biblioteca de documentos o un archivo de una carpeta.
FileVersionCollection	Representa una colección de recursos FileVersion.
FileVersion	Representa una versión de un recurso File.
FolderCollection	Representa una colección de recursos Folder.
Folder	Representa una carpeta de un sitio web de SharePoint.

Extremos de REST para usuarios y grupos

Recurso	Descripción
GroupCollection	Representa una colección de recursos Group.
Group	Representa un grupo de un sitio web de Microsoft SharePoint Foundation.
RoleAssignmentCollection	Representa una colección de recursos RoleAssignment que define todas las asignaciones de rol para un objeto protegible.
RoleAssignment	Define las asignaciones de roles del objeto protegible para un usuario o grupo del sitio web, la lista o el elemento de lista.
RoleDefinitionCollection	Representa la colección de recursos RoleDefinition que definen las definiciones de rol que hay disponibles para usar en el sitio.
RoleDefinition	Define una sola definición de roles, incluidos un nombre, una descripción y un conjunto de derechos.
RoleDefinitionBindingCollection	Define las definiciones de roles enlazadas a un objeto de asignación de roles.
UserCollection	Representa una colección de recursos User.
User	Representa un usuario de Microsoft SharePoint Foundation.
UserCustomActionCollection	Representa una colección de recursos UserCustomAction.
UserCustomAction	Representa una acción personalizada asociada con una lista, un sitio web o un subsitio de SharePoint.

Tipos complejos de REST

Recurso	Descripción
AppLicense	Representa una licencia de la aplicación para el usuario especificado para la Complemento de SharePoint determinada.
AppLicenseCollection
AppPrincipalConfiguration	La configuración asociada con una entidad de seguridad de aplicaciones.
AppPrincipalCredentialReference	Representa una referencia a una credencial para una entidad de seguridad de aplicaciones.
BasePermissions	Representa permisos de base para una definición de roles.
CamlQuery	Especifica una consulta de Lenguaje de marcado de aplicaciones de colaboración (CAML) en una lista o en listas combinadas.
ChangeLogItemQuery	Representa el parámetro de entrada del método GetListItemChangesSinceToken.
ChangeQuery	Define una consulta realizada en el registro de cambios.
ChangeToken	Representa la ubicación secuencial única de un cambio dentro del registro de cambios.
ContentTypeCreationInformation	Especifica propiedades que se usan como parámetros para inicializar un nuevo tipo de contenido.
ContentTypeId	Representa el identificador de tipo de contenido de un tipo de contenido.
ContextWebInformation	La información de contexto para un sitio.
DocumentLibraryInformation	Representa información sobre una biblioteca de documentos.
EventReceiverDefinitionCreationInformation	Especifica la información de creación del receptor de eventos.
ExternalAppPrincipalCreationParameters	Representa el objeto que encapsula todos los parámetros usados para crear una nueva entidad de seguridad de aplicaciones externa.
FieldCalculatedErrorValue	Representa el valor del campo calculado de un elemento de lista cuando el valor del campo es un error de cálculo, como una división por cero o un desbordamiento.
FieldCreationInformation	Representa las propiedades que se pueden establecer al crear un campo.
FieldGeolocationValue	Representa los valores de altitud, latitud, longitud y medida de un campo de geolocalización.
FieldLookupValue	Especifica el valor de una búsqueda de un campo dentro de un elemento de lista.
FieldRatingScaleQuestionAnswer	Representa una subpregunta y una subrespuesta específicas dentro de un campo de escala de clasificación de un elemento de lista.
FieldUrlValue	Especifica el hipervínculo y los valores de descripción de FieldURL.
FieldUserValue	Representa el valor de un campo de usuario de un elemento de lista.
FileCreationInformation	Representa las propiedades que se pueden establecer al crear un archivo mediante el método FileCollection.Add.
GroupCreationInformation	Un objeto que se usa para facilitar la creación de un grupo entre sitios.
KeyValue	Representa un diccionario de pares de clave y valor.
Language	Representa un lenguaje natural usado dentro del contexto de Microsoft SharePoint Foundation.
ListDataSource	Representa información asociada con una conexión a un origen de datos externo.
ListDataValidationExceptionValue	Excepción que se arroja cuando se produce un error en la validación de los datos de un campo de lista o de un elemento de lista.
ListDataValidationFailure	Describe un error de validación específico cuando se inserta o actualiza un elemento de lista.
ListItemCollectionPosition	Especifica la información necesaria para obtener la página de datos siguiente de una vista de lista.
ListItemCreationInformation	Especifica las propiedades del elemento de lista nuevo.
ListItemFormUpdateValue	Representa las propiedades de un campo de elemento de lista y su valor.
MenuNode	Representa un nodo de navegación en la jerarquía de navegación. Una jerarquía de navegación es una estructura de árbol de nodos de navegación.
MenuState	Representa el estado de menú del SiteMapProvider ("SPSiteMapProvider") predeterminado donde comienza el volcado en el nodo raíz del sitio con una profundidad de 10 niveles.
NavigationNodeCreationInformation	Describe un nodo de navegación nuevo que se creará.
RelatedItem
RenderListDataParameters	Representa los parámetros que se usan para representar los datos de la lista como cadena Notación de objetos de JavaScript (JSON).
RoleDefinitionCreationInformation	Contiene propiedades que se usan como parámetros para inicializar una definición de roles.
SimpleDataRow	Representa una fila en una tabla de datos.
SimpleDataTable	Representa una tabla de datos.
TimeZoneInformation	Representa la información sobre una zona horaria.
UpgradeInfo	Representa la información de actualización de la colección de sitios.
UsageInfo	Proporciona campos que se usan para obtener acceso a información sobre el uso de la colección de sitios.
UserCreationInformation	Parámetros para invitar a un usuario.
UserIdInfo	Representa la información del identificador único de un proveedor de identidad.
ViewCreationInformation	Especifica las propiedades usadas para crear una vista de lista nueva.
WebCreationInformation	Especifica las propiedades de un sitio nuevo.
WebInfoCreationInformation	Representa metadatos acerca de la creación de sitios.
WebRequestInfo	Representa los datos del autor de la llamada necesarios para realizar la solicitud web de salida.
WebResponseInfo	Contiene una copia de la respuesta del servicio de terceros.
XmlSchemaFieldCreationInformation	Representa las propiedades que se pueden establecer al crear un campo.

Introducciones a REST de SharePoint 2013

Recurso	Descripción
Introducción al servicio REST para SharePoint 2013	Obtenga información sobre los conceptos básicos del uso del servicio REST de SharePoint 2013 para obtener acceso a los datos de SharePoint y actualizarlos usando los protocolos web estándar REST y OData.
Procedimiento para realizar operaciones básicas con extremos REST de SharePoint 2013	Aprenda a llevar a cabo operaciones CRUD básicas con la interfaz de REST de SharePoint 2013.
Información general de la API de REST de SharePoint Search	Agregue la función de búsqueda al cliente y aplicaciones móviles mediante el servicio de búsqueda REST en SharePoint Server 2013 y de cualquier tecnología que sea compatible con las solicitudes web REST.
Referencia sobre la API de REST de perfiles de usuario	Infórmese sobre los extremos de REST de SharePoint 2013 para PeopleManager, ProfileLoader y UserProfile de usuario, y conozca otros recursos relacionados.
Referencia a API de REST de fuente social para SharePoint 2013	Aprenda sobre el uso de extremos de REST de SharePoint 2013 para tareas relacionadas con fuentes.
Following people and content REST API reference for SharePoint 2013	Aprenda sobre el uso de extremos de REST de SharePoint 2013 para seguir a personas y contenido.

Ejemplos de código de REST de SharePoint 2013

Recurso	Descripción
SharePoint 2013: aplicación remota "Hola a todos" con REST	Aprenda a crear una Complemento de SharePoint básica "Hola a todos" hospedada por el proveedor que use la interfaz de REST de SharePoint para leer información sobre un sitio de SharePoint 2013 desde una aplicación web remota.
SharePoint 2013: usar el servicio REST de búsqueda desde una aplicación para SharePoint	Aprenda a enviar una consulta de búsqueda a Buscar en SharePoint 2013 desde una Complemento de SharePoint.
SharePoint 2013: crear consultas de REST y usar REST para atravesar un sitio	Aprenda a usar las API de REST de SharePoint para atravesar un sitio de SharePoint 2013 y a diseñar una aplicación que cree consultas que realicen operaciones de datos básicas en las entidades básicas de SharePoint expuestas en los extremos de REST.
SharePoint 2013: realizar operaciones básicas de acceso a datos usando REST en aplicaciones	Aprenda a usar las API de REST de SharePoint para realizar operaciones básicas de acceso a datos en elementos de lista y listas de SharePoint 2013.
SharePoint 2013: realizar operaciones básicas de datos en archivos y carpetas usando REST	Un ejemplo de código que usa REST y la biblioteca entre dominios de SharePointJavaScript para realizar operaciones básicas en bibliotecas de documentos y archivos.
SharePoint 2013: hacer llamadas de tipo de directiva solo de aplicación en una aplicación remota (REST)	Aprenda a usar el atributo AllowAppOnlyPolicy con REST y OAuth para devolver una llamada a SharePoint 2013.
SharePoint 2013: acceder a una lista externa con REST	Aprenda a crear una Complemento de SharePoint que use direcciones URL de RESTful para consultar y manipular datos de una lista externa.
Ejemplo de código: usar el control de cromo y la biblioteca entre dominios (REST)	Aprenda a incluir una página web remota que hospede el control de cromo y recupere información de la web de host usando la biblioteca entre dominios y la REST de SharePoint 2013.
SharePoint 2013: obtener elementos de lista usando la biblioteca entre dominios (REST)	Aprenda a usar la biblioteca entre dominios de Complementos de SharePoint para leer elementos de una lista hospedada en la web de aplicación.
SharePoint 2013: obtener el título de la web de host usando la biblioteca entre dominios (REST)	Aprenda a usar la biblioteca entre dominios de SharePoint 2013 para leer la propiedad title de la web de host.
Establecer permisos personalizados en una lista usando la interfaz REST	Aprenda a definir permisos específicos personalizados en una lista SharePoint con la interfaz REST y JavaScript.

Recursos adicionales

• Introducción al servicio REST para SharePoint 2013

• Procedimiento para realizar operaciones básicas con extremos REST de SharePoint 2013

• Realizar llamadas REST con C# y JavaScript para SharePoint 2013

• Demostración de realización de llamadas REST con C# y JavaScript para SharePoint 2013

• Desarrollar complementos para SharePoint

• Acceso a datos seguro y modelos de objetos de cliente para complementos de SharePoint

• Trabajar con datos externos en SharePoint 2013

• Protocolo Open Data

• OData: Formato de notación de objetos JavaScript (JSON)