api search Page History

Search - API

Busca artigos utilizando diversos filtros

Retorna uma lista de artigo filtrada.

Está requisição utiliza os parâmetros de paginação page e per_page para restringir a lista.

Parâmetros:

  • fields (opcional) - Mostra somente os campos escolhidos, separado por vírgulas.
  • type (opcional) - Filtra o tipo do artigo: UploadedFile, Event, TinyMceArticle, TextileArticle, RawHTMLArticle, Folder, Blog, Forum, Gallery, RssFeed.
  • query (opcional) - Filtra por algum texto contido no artigo.
  • category_ids(opcional) - Filtra por categorias, deve ser passado o id da categoria.
  • parent_id (opcional) - Filtra pelo pai do artigo.
GET /search/article

Exemplo:

GET /search/article?query=Empresa

{
  "articles": [
    {
      "id": 435,
      "body": "Empresa Solidária de Comercialização de Bonito - Noosfero doesn't like wales no more",
      "abstract": null,
      "created_at": "2016/02/18 13:19:20",
      "updated_at": "2016/02/18 13:19:20",
      "title": "Empresa Solidária de Comercialização de Bonito - Noosfero doesn't like wales no more",
      "author": null,
      "profile": {
        "identifier": "empresa-solidaria-de-comercializacao-de-bonito-noosfero",
        "name": "Empresa Solidária de Comercialização de Bonito - Noosfero",
        "id": 90,
        "created_at": "2016/02/18 13:18:42",
        "updated_at": "2016/02/18 13:18:42",
        "additional_data": {},
        "image": null,
        "region": null
      },
      "categories": [
        {
          "name": "Administração de sistemas",
          "id": 83,
          "slug": "administracao-de-sistemas",
          "full_name": "Produtos/Software Livre/Administração de sistemas",
          "image": null,
          "display_color": null
        }
      ],
      "image": null,
      "votes_for": 0,
      "votes_against": 0,
      "setting": {},
      "position": null,
      "hits": 0,
      "start_date": null,
      "end_date": null,
      "tag_list": [
        "free-software",
        "ruby"
      ],
      "children_count": 0,
      "slug": "empresa-solidaria-de-comercializacao-de-bonito-noosfero-doesn-t-like-wales-no-more",
      "path": "blog/empresa-solidaria-de-comercializacao-de-bonito-noosfero-doesn-t-like-wales-no-more",
      "parent": {
        "id": 244,
        "body": null,
        "abstract": null,
        "created_at": "2016/02/18 13:18:42",
        "updated_at": "2016/02/18 13:19:20",
        "title": "Blog",
        "author": null,
        "profile": {
          "identifier": "empresa-solidaria-de-comercializacao-de-bonito-noosfero",
          "name": "Empresa Solidária de Comercialização de Bonito - Noosfero",
          "id": 90,
          "created_at": "2016/02/18 13:18:42",
          "updated_at": "2016/02/18 13:18:42",
          "additional_data": {},
          "image": null,
          "region": null
        },
        "categories": [],
        "image": null,
        "votes_for": 0,
        "votes_against": 0,
        "setting": {},
        "position": null,
        "hits": 0,
        "start_date": null,
        "end_date": null,
        "tag_list": [],
        "children_count": 2,
        "slug": "blog",
        "path": "blog"
      },
      "children": []
    }
  ]
}

Exemplo:

GET /search/article?query=Empresa&fields=title,id

{
  "articles": [
    {
      "id": 435,
      "title": "Empresa Solidária de Comercialização de Bonito - Noosfero doesn't like wales no more"
    },
    {
      "id": 427,
      "title": "Empresa Solidária de Serviços de Reviravolta do Serrado - Noosfero doesn't like wales no more"
    },
    {
      "id": 424,
      "title": "Empresa Solidária de Serviços de Reviravolta do Serrado - Noosfero release a new version of project X"
    },
    {
      "id": 357,
      "title": "Gallery Empresa Solidária de Artesanato de Reviravolta do Serrado - Noosfero doesn't use free-software no more"
    },
    {
      "id": 356,
      "title": "Gallery Empresa Solidária de Produção de Alimentos de Reviravolta do Serrado - Noosfero doesn't use free-software no more"
    }
  ]
}
Last edited by Gust