SharePoint REST interface with operators and functions

Introduction

What information the article has

• various operators that can be used with REST interface
• various functions that can be used with REST interface

Skill Level – Medium

Filter operators

Following are the various filter operators that can be used with REST interface
eq Equal to
ne Not equal to
gt Greater than
ge Greater than or equal to
lt Less than
le Less than or equal to
and Logical and
or Logical or
not Logical negation
add Addition
sub Subtraction
mul Multiplication
div Division
mod Modulo
( ) Precedence grouping

Functions

Following are the various functions that can be used with REST interface
bool substringof(string s0, string s1)
Checks whether s0 is within s1

bool endswith(string s0, string s1)
Checks whether s0 ends with s1

bool startswith(string s0, string s1) 
Checks whether s0 starts with s1

int length(string s)
Length of string s

int indexof(string s0, string s1)
Index of string s0 within s1

string insert(string s0, int pos, string s1)
Inserts s0 into s1 at position pos.

string remove(string s0, int pos)
Removes characters from position pos in s0

string remove(string s0, int pos, int length)
Removes length characters from position pos in s0

string replace(string s0, string f0, string s1)
Replaces f0 in s0 with s1

string substring(string s0, int pos)
Returns the substring from position pos in s0

string substring(string s0, int pos, int length)
Returns the substring from position pos in s0 with the length characters

string tolower(string s0)
Transforms s0 to lowercase

string toupper(string s0)
Transforms s0 to uppercase

string trim(string s0)
Removes leading and trailing whitespaces

string concat(strings s0, string s1)
Concatenates two strings

int day(DateTime dt)
Day of the date dt

int hour(DateTime dt)
Hour of the date dt

int minute(DateTime dt)
Minute of the date dt

int month(DateTime dt)
Month of the date dt

int second(DateTime dt)
Second of the date dt

int year(DateTime dt)
Year of the date dt

double round(double dbl)
Rounded value of dbl with double precision

decimal round(decimal dec)
Rounded value of dec with decimal precision

double floor(double dbl)
Floor value of dbl with double precision

decimal floor(decimal dec)
Floor value of dec with decimal precision

Examples of usage

/Employees?$filter=Id eq 1
Filter using the eq operator extracts exactly one element if the filtered element is unique

Employees?$filter=’Jac,Arth’ eq concat(FirstName, concat(‘,’, LastName))
Filter after concatinating the column values

Employees?$filter=year(Modified) eq 2010
Filter on the year of the Modified property

Employees?$filter=Id eq 3 and substring(Department, 0, 1) eq ‘I’
Filter on the result set along with expression

Conclusion

REST interface is a great way of accessing SharePoint data and hope the above operators and functions will give grater ability

Interfaz de REST de SharePoint Foundation

La interfaz de transferencia de estado de representación (REST) en Microsoft SharePoint 2010 proporciona acceso a las listas y bibliotecas como un servicio de datos relacionales. Un concepto básico de cualquier interfaz de REST es el recurso; en SharePoint, las listas y elementos se representan como recursos HTTP a los que se puede tener acceso mediante direcciones URL remotas.

Las operaciones en la interfaz de REST de SharePoint constituyen un conjunto estándar de operaciones para servicios web con REST. Las operaciones de lectura, creación, actualización y eliminación se asignan directamente a verbos GET, POST, PUT y DELETE HTTP. Esto elimina la necesidad de tener capas intermedias entre el cliente y el servidor, y resulta útil para la interoperabilidad ya que permite que las aplicaciones de otras plataformas se conecten fácilmente a SharePoint. La interoperabilidad es una de las ventajas de la nueva interfaz de REST de SharePoint Foundation, pero esta interfaz también proporciona una gran experiencia de desarrollo a través de la integración con los servicios de datos de ADO.NET, en los que se basa.

La interfaz de REST usa convenciones flexibles de direcciones URL para consultar datos, lo que permite filtrar, ordenar y seleccionar información de listas de SharePoint Foundation directamente desde el explorador. También se puede recuperar información de las listas de SharePoint Foundation mediante varias representaciones, incluida la compatibilidad con estándares de AtomPub, Atom y la notación de objetos JavaScript (JSON). Las representaciones estándar para las listas de SharePoint Foundation hacen que los datos de la lista estén disponibles para los clientes conforme a los estándares, desde lectores de fuente Atom sencillos hasta clientes más avanzados que permiten a los usuarios finales analizar grandes cantidades de datos en Microsoft Excel. Las características avanzadas de los servicios de datos de ADO.NET también son compatibles con la interfaz de REST de SharePoint Foundation, como el procesamiento por lotes de varias operaciones en una única solicitud, el control de simultaneidad a través de HTTP ETags, la paginación de grandes conjuntos de datos y el acceso a secuencias de documentos en bibliotecas de documentos de SharePoint.

La siguiente tabla muestra direcciones URL de ejemplo que implementan la interfaz de REST.

Dirección URL	Descripción
http://myserver/_vti_bin/ListData.svc	La escritura de la dirección URL del servicio de REST devuelve un documento de servicio Atom estándar que describe las colecciones de información que están disponibles en el sitio de SharePoint Foundation.
http://myserver/_vti_bin/ListData.svc/Projects	La escritura de un nombre después de la dirección URL del servicio devuelve datos de lista de SharePoint Foundation en formato XML como una fuente Atom estándar que contiene entradas para cada elemento de lista y las propiedades de cada uno, así como propiedades de navegación representadas como vínculos Atom. Las propiedades de navegación representan relaciones con otras listas de SharePoint Foundation formadas mediante columnas de búsqueda.
http://myserver/_vti_bin/ListData.svc/$metadata	La interfaz de SharePoint Foundation devuelve el XML del modelo de datos de entidad que describe los tipos de entidad para cada lista en el sitio web.
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees(2)	Devuelve el elemento de lista especificado por identificador (2) como una fuente Atom con una entrada que corresponde al elemento solicitado.
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$orderby=Name	Ordena la fuente Atom por nombre.
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$filter=Project/Title eq 'My Project Title'	Usa una propiedad de navegación para filtrar la lista por título de un proyecto relacionado.

Al aprovechar las nuevas funciones del almacén de datos de SharePoint Foundation, las consultas de REST proporcionan un mecanismo flexible para trabajar con datos de lista de SharePoint Foundation en formato XML, y cualquier aplicación que puede enviar direcciones URL de REST a SharePoint Foundation puede recuperar sus datos de lista. Por ejemplo, la interfaz de REST usa la nueva característica de uniones de listas, de modo que cuando SharePoint Foundation recibe una consulta de servicios de datos de ADO.NET que implementa la característica de uniones, la consulta se traduce en una consulta de Lenguaje de marcado de aplicaciones de colaboración (CAML) nativa.