Llamada a las API List

Acceder a las API List con solicitudes GET de HTTP. Las API List devuelven una lista de registros que coinciden con los criterios especificados en los parámetros de solicitud.

Las solicitudes de lista REST utilizan las API getNameList , donde Nombre es el tipo de recurso que especifica en la solicitud. Para ver la lista completa de recursos y API, vea los archivos Javadoc de REST.

Formato de solicitud

Utilice el siguiente formato de solicitud HTTP para llamar a las API List:

GET http://host:port/contextRoot/restapi/Name?parameters

El ejemplo siguiente muestra una llamada REST a getOrganizationList:

GET http://host:port/contextRoot/restapi/organization?IsNode=Y&OrganizationName=~like~DEMO

Filtrado de consultas

En una llamada de la API List de REST, puede filtrar los resultados de acuerdo con los parámetros de atributo/valor que se especifican en la consulta. En el ejemplo getOrganizationList, IsNode=Y y OrganizationName=~like~DEMO son parámetros de atributo/valor. Los parámetros de atributo/valor se separan mediante el signo de ampersand (&) en el URL de solicitud.

Puede especificar la relación entre atributos y sus valores con las siguientes opciones de formato:

Formato	Descripción
`attribute=value`	`atributo` igual a `valor`.
`attribute=~neq~value`	`atributo` no es igual a `valor`.
`attribute=~gt~value`	`atributo` es mayor que `valor`.
`attribute=~gteq~value`	`atributo` es mayor que o igual a `valor`.
`attribute=~lt~value`	`atributo` es menor que `valor`.
`attribute=~lteq~value`	`atributo` es menor que o igual a `valor`.
`attribute=~ew~value`	`atributo` termina por `valor`.
`attribute=~sw~value`	`atributo` empieza por `valor`.
`attribute=~like~value`	`atributo` se parece a `valor`.

Ordenación de resultados

Para organizar los datos de respuesta en secuencia de acuerdo con atributos específicos, pase el parámetro sort y los atributos por los que desea ordenar en el URL de solicitud:

sort({+ or -}attribute1,{+ or -}attribute2)

+	Orden ascendente
-	Ordenar en orden descendente

El ejemplo siguiente muestra una llamada REST a getOrganizationList con la función de ordenar pasada como parámetro:

GET /restapi/organization?sort(+OrganizationName,-Createts)

De forma alternativa, puede pasar el parámetro _sort en el URL de la solicitud si desea que los parámetros de la solicitud tengan el formato attribute=value. El ejemplo siguiente muestra el formato de una solicitud de secuenciación idéntica que utiliza el parámetro _sort.

GET /restapi/organization?_sort=+OrganizationName,-Createts

Paginación

La paginación se controla mediante la cabecera Range de HTTP. Por ejemplo, si se especifica la cabecera Range con el valor items=20-39, se devuelve los artículos en las posiciones 20 a 39 de la consulta.

De forma alternativa, puede pasar el parámetro _range en el URL. Utilice esta opción si encuentra problemas con la cabecera Range:

GET /restapi/organization?_range=20-39