Chamando APIs List

Acesse as APIs List com as solicitações HTTP GET. As APIs List retornam uma lista de registros que correspondem aos critérios que são especificados nos parâmetros de solicitação.

A Lista REST solicita as APIs getNameList, em que Name é o tipo de recurso que você especifica na solicitação. Para ver a lista completa de recursos e APIs, visualize os arquivos REST Javadoc.

Formato da solicitação

Use o formato de solicitação de HTTP a seguir para chamar APIs List:

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

O exemplo a seguir mostra uma chamada REST para getOrganizationList:

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

Filtragem de consulta

Em uma chamada de API REST, é possível filtrar os resultados de acordo os parâmetros de atributo/valor que são especificados na consulta. No exemplo getOrganizationList, IsNode=Y e OrganizationName=~like~DEMO são parâmetros de atributo/valor. Os parâmetros atributo/valor são separados por és comerciais (&) na URL da solicitação.

É possível especificar os relacionamentos entre atributos e seus valores com as seguintes opções de formatação:

Formato	Descrição
`attribute=value`	`attribute` igual a `value`.
`attribute=~neq~value`	`attribute` não igual a `value`.
`attribute=~gt~value`	`attribute` é maior que `value`.
`attribute=~gteq~value`	`attribute` é maior ou igual a `value`.
`attribute=~lt~value`	`attribute` é menor que `value`.
`attribute=~lteq~value`	`attribute` é menor ou igual a `value`.
`attribute=~ew~value`	`attribute` termina com `value`.
`attribute=~sw~value`	`attribute` inicia com `value`.
`attribute=~like~value`	`attribute` é como `value`.

Classificando resultados

Para organizar os dados de resposta em sequência de acordo com atributos específicos, transmita o parâmetro sort e os atributos pelos quais deseja classificar na URL da solicitação:

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

+ Classifique em ordem crescente
- Classificar em ordem decrescente

O exemplo a seguir mostra uma chamada REST para getOrganizationList com a função de classificação transmitida como um parâmetro:

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

Como alternativa, é possível transmitir o parâmetro _sort na URL de solicitação se desejar que os parâmetros de solicitação tenham o formato attribute=value. O exemplo a seguir mostra o formato de uma solicitação de sequenciamento idêntica que usa o parâmetro _sort.

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

Paginação

A paginação é controlada pelo cabeçalho Range HTTP. Por exemplo, especificar um cabeçalho Range com valor items=20-39 retorna itens do 20º ao 39º a partir da consulta.

Como alternativa, é possível transmitir o parâmetro _range na URL de solicitação. Use essa opção se você encontrar problemas com o cabeçalho Range:

GET /restapi/organization?_range=20-39