Compartir a través de

Referencia de la API rest de BCS para SharePoint

  • Artículo

Referencias y bibliotecas de clases

Contiene información de referencia para construir direcciones URL de transferencia de estado representacional (REST) para acceder a orígenes de datos externos y manipularlos mediante Servicios de conectividad empresarial (BCS) en SharePoint.

Uso de LAS API de RESTful para acceder a datos externos en SharePoint

La interfaz REST proporcionada por SharePoint le permite acceder a la mayoría de los recursos de SharePoint a través de direcciones URL especialmente construidas. Servicios de conectividad empresarial (BCS) usa esta arquitectura para proporcionar acceso a datos externos.

Puede tener acceso a datos externos mediante la construcción de direcciones URL como lo haría a los elementos de lista estándar de access.

Nota:

[!NOTA] No se proporciona acceso a las entidades a través de la conectividad a datos profesionales directamente. Para trabajar con datos externos, debe crear una lista externa y usar las direcciones URL de REST para tener acceso a los elementos de lista incluidos en la lista externa.

Los verbos HTTP compatibles para trabajar con listas externas son GET, PUT, POSTy DELETE.

A diferencia de con las listas normales, no se puede crear una lista externa con REST. Debe hacer mediante la creación de un modelo de conectividad a datos profesionales y una lista externa mediante Visual Studio 2012.

La información de la Tabla 1 muestra cómo construir direcciones URL de REST y las llamadas correspondientes al modelo de objetos de cliente, para acceder a datos de orígenes de datos externos y manipularlos.

Tabla 1. Formatos de URL de REST para acceder a datos externos

URL Descripción Método HTTP
http://[sharepointsite]/_api
La base de toda solicitud REST. El directorio virtual _api está asignado para llamar a client.svc, donde se puede usar el modelo de objetos de cliente.
GET
http://[sharepointsite]/_api/web/title
Recupera el título de la web actual.
GET
http://[sharepointsite]/_api/lists
Recupera todas las listas de un sitio.
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')
Recupera los metadatos de una lista especificada.
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')/items
Recupera los elementos de lista de una lista especificada.
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title
Recupera el título de una determinada lista.
GET

Construcción de cadenas de consulta para filtrar datos

Con el fin de limitar la cantidad de datos devueltos, o hacerlo más relevantes para el usuario, puede usar las operaciones de filtro que se encuentra en la tabla 2.

Tabla 2. Operadores para filtrar datos

Operador Descripción
eq
 Igual a
Nota: Cuando se usa EQ para filtrar, los criterios de filtro se pasan al sistema externo donde se produce el filtrado en el servidor.
Gt
 Mayor que
Nota: Cuando se usa el operador GT , solo se ejecuta el filtrado del lado cliente.> Por ejemplo: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 devuelve todos los títulos con una clasificación media superior a 3.

Nota:

[!NOTA] Para recuperar las columnas que forman parte de una asociación, debe incluir explícitamente la columna en la dirección URL mediante $select en la cadena de consulta.

Vea también