API:Lists/pt

Category:MediaWiki action API/pt

Pedido OBTER para listar os itens que correspondem ao critério selecionado.

Documentação da API

As listas geralmente devolvem agregações de dados, tais como páginas reunidas de uma wiki, ou ligações reunidas numa única página. Para solicitar uma lista, passe o parâmetro list da sua string da consulta a um sub módulo de lista válido, tais como allimages ou usercontribs.

Para utilizar a lista de APIs, especifique action=query&list=list1|list2 no URL.

Veja as páginas da lista de APIs para exemplos mais concretos de como utilizar as listas:

Notas adicionais

  • A maioria dos sub módulos da lista podem ser utilizados como geradores, salvo indicação em contrário.
  • As listas diferem de properties em que, em lugar de anexar os dados aos elementos no elemento pages, cada pronta tem o seu próprio ramo separado no elemento query.
  • Limites de consulta da lista:
    • O limite dos resultados pode ser definido como alto como 500 para os utilizadores regulares, ou 5000 para os utilizadores com o direito de apihighlimits (normalmente robôs e administradores do sistema).
    • Alguns módulos impõem limites mais rigorosos sob certas condições. Consulte esta subpágina para mais detalhes.
    • Se não tem a certeza de qual o limite se aplica a si e quer apenas o maior número de resultados possível, defina o limite para max. Nesse caso, um elemento limits será devolvido, especificando os limites utilizados.
    • O parâmetro de limite para um determinado módulo consiste no prefixo do módulo seguido de limit, por isso, ptlimit é o número máximo de protectedtitles devolvidos, e cmlimit é o número máximo de categorymembers devolvidos.

Consultar também

Category:MediaWiki action API/pt