Listar entradas
GET/workspaces/:workspace/models/:model/entries
Lista as entradas do modelo especificado. É possível filtrar as entradas retornadas usando vários parâmetros descritos abaixo.
Filtragem avançada
Além dos parâmetros detalhados abaixo, é possível filtrar entradas de acordo com o conteúdo de um ou mais campos específicos.
Por exemplo, você pode requisitar apenas entradas que contém o texto bar no
campo de texto foo adicionando esse parâmetro à requisição:
field:foo:eq=bar
A sintaxe da filtragem avançada é field:<chave do campo>:<tipo de filtro>. Os
tipos de filtro aplicáveis dependem do tipo de campo, e todos os tipos
disponíveis estão descritos nas tabelas abaixo.
É possível utilizar vários filtros na mesma requisição. Note que mútiplos filtros serão aplicados na busca utilizando o operador lógico AND. No momento, não possível combinar filtros utilizando o operador OR.
Caso o campo requisitado não exista ou o tipo de filtro utilizado não esteja
disponível para o tipo do campo requisitado, o filtro será ignorado. Filtros
ignorados são indicados na resposta do servidor pela propriedade
ignored_filters do objeto meta.
Campos sem conteúdo
Alguns tipos de filtro podem retornar entradas que não tem conteúdo cadastrado no campo selecionado.
Por exemplo, para buscar por entradas que não contém o texto bar em um
campo de chave foo, você utilizaria esse parâmetro:
field:foo:neq=bar
Nesse caso, o Starlight pesquisará pela string bar dentre todas as entradas
do modelo e retornará todas que não contém essa string, incluindo entradas que
não tem nenhum conteúdo nesse campo. Isso inclui entradas que foram criadas
antes desse campo ser adicionado ao modelo, caso haja alguma.
Para remover entradas que não tem conteúdo nesse campo da lista, você
pode combinar o filtro desejado com o filtro filled, por exemplo:
field:foo:neq=bar&field:foo:filled=true
Nesse caso, serão retornadas apenas as entradas que não tenham a string bar,
mas que tenham algum texto cadastrado nesse campo.
Filtros disponíveis
Os filtros utilizáveis dependem do tipo do campo que será filtrado, descritos abaixo e agrupados por tipo de campo.
Todos os tipos
Esses filtros estão disponíveis para todos os tipos de campo.
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| filled | Retorna entradas que tenham qualquer tipo de conteúdo no campo. | true ou false | field:foo:filled=true |
| unfilled | Retorna entradas que não tenham conteúdo no campo. | true ou false | field:foo:unfilled=true |
Título, Slug, String, Texto e HTML
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| eq | Retorna entradas em que o conteúdo seja igual ao especificado. | Qualquer string | field:foo:eq=Hello%20World |
| neq | Retorna entradas em que o conteúdo seja diferente do especificado. | Qualquer string | field:foo:neq=Hello%20World |
| like | Retorna entradas que contenham a string especificada em qualquer parte do conteúdo. | Qualquer string | field:foo:like=World |
| nlike | Retorna entradas que não contenham a string especificada em alguma parte do conteúdo. | Qualquer string | field:foo:nlike=World |
Inteiro, Decimal e Float
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| eq | Retorna entradas que tenham um número igual ao especificado. | Qualquer número | field:foo:eq=42 |
| neq | Retorna entradas que tenham um número diferente do especificado. | Qualquer número | field:foo:neq=42 |
| gt | Retorna entradas que contenham um número maior que o especificado. | Qualquer número | field:foo:gt=42 |
| gte | Retorna entradas que contenham um número maior ou igual que o especificado. | Qualquer número | field:foo:gte=42 |
| lt | Retorna entradas que contenham um número menor que o especificado. | Qualquer número | field:foo:lt=42 |
| lte | Retorna entradas que contenham um número menor ou igual que o especificado. | Qualquer número | field:foo:lte=42 |
Booleano
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| eq | Retorna entradas em que o valor booleano seja igual ao especificado. | true ou false | field:foo:eq=true |
Mídia
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| eq | Retorna entradas em que a mídia selecionada seja igual à especificada. | ID de uma mídia | field:foo:eq=1234567890 |
| neq | Retorna entradas em que a mídia selecionada seja diferente da especificada, ou que não tenham mídia selecionada. | ID de uma mídia | field:foo:neq=1234567890 |
Relação
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| eq | Retorna entradas em que o objeto selecionado nesse campo é igual ao especificado. | <tipo do objeto>:<ID do objeto> | field:foo:eq=entry:123456789 |
| neq | Retorna entradas em que o objeto selecionado nesse campo é diferente do especificado, ou que não tenham um objeto selecionado nesse campo. | <tipo-do-objeto>:<ID-do-objeto> | field:foo:neq=collection:123456789 |
| type | Retorna entradas em que o objeto selecionado nesse campo é do tipo especificado. | entry, singleton, collection ou media. | field:foo:type=entry |
| ntype | Retorna entradas em que o objeto selecionado nesse campo não é do tipo do especificado, ou que não tenham um objeto selecionado nesse campo. | entry, singleton, collection ou media. | field:foo:ntype=singleton |
Editor Visual
| Filtro | Descrição | Valor | Exemplo |
|---|---|---|---|
| like | Retorna entradas que contenham a string especificada em qualquer parte textual do conteúdo. | Qualquer string | field:foo:like=World |
| nlike | Retorna entradas que não contenham a string especificada em alguma parte textual do conteúdo. | Qualquer string | field:foo:nlike=World |
Request
Responses
- 200
- 404
Success.
Instância não encontrada.