Ajuda da API do MediaWiki
Esta é uma página de documentação da API do MediaWiki gerada automaticamente.
Documentação e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Módulo principal
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Estado: A API do MediaWiki é uma interface consolidada e estável que é constantemente suportada e melhorada. Embora tentemos evitá-lo, podemos ocasionalmente realizar alterações disruptivas. Inscreva-se na lista de distribuição mediawiki-api-announce para receber notificações das atualizações.
Pedidos incorretos: Quando são enviados pedidos incorretos à API, será devolvido um cabeçalho HTTP com a chave "MediaWiki-API-Error" e depois tanto o valor desse cabeçalho como o código de erro devolvido serão definidos com o mesmo valor. Para mais informação, consulte API:Erros e avisos.
Testes: Para testar facilmente pedidos à API, visite Testes da API.
- action
A operação a ser realizada.
- block
- Bloquear um utilizador.
- changeauthenticationdata
- Alterar os dados de autenticação do utilizador atual.
- changecontentmodel
- Alterar o modelo de conteúdo de uma página
- checktoken
- Verificar a validade de uma chave a partir de action=query&meta=tokens.
- clearhasmsg
- Limpa a indicação
hasmsg
do utilizador atual. - clientlogin
- Entrar na wiki usando o processo interativo.
- compare
- Obter a diferença entre duas páginas.
- createaccount
- Criar uma conta de utilizador nova.
- delete
- Eliminar uma página.
- edit
- Criar e editar páginas.
- emailuser
- Enviar correio eletrónico a um utilizador.
- embedvideo
- Get gerado código de vídeo incorporado para determinados parâmetros.
- expandtemplates
- Expande todas as predefinições existentes num texto wiki.
- feedcontributions
- Devolve um feed das contribuições do utilizador.
- feedrecentchanges
- Devolve um feed das mudanças recentes.
- feedwatchlist
- Devolve um feed das páginas vigiadas.
- filerevert
- Reverter um ficheiro para uma versão antiga.
- help
- Apresentar ajuda para os módulos especificados.
- imagerotate
- Rodar uma ou mais imagens.
- import
- Importar uma página de outra wiki ou de um ficheiro XML.
- linkaccount
- Ligar uma conta de um fornecedor terceiro ao utilizador atual.
- login
- Iniciar uma sessão e obter cookies de autenticação.
- logout
- Terminar a sessão e limpar os dados da sessão.
- managetags
- Executar tarefas de gestão relacionadas com etiquetas de modificação.
- mergehistory
- Fundir o historial de páginas.
- move
- Mover uma página.
- opensearch
- Pesquisar a wiki usando o protocolo OpenSearch.
- options
- Alterar as preferências do utilizador atual.
- paraminfo
- Obter informação sobre os módulos da API.
- parse
- Faz a análise sintática do conteúdo e devolve o resultado da análise.
- patrol
- Patrulhar uma página ou revisão.
- protect
- Alterar o nível de proteção de uma página.
- purge
- Limpar a cache para os títulos especificados.
- query
- Obter dados de, e sobre, o MediaWiki.
- removeauthenticationdata
- Remover os dados de autenticação do utilizador atual.
- resetpassword
- Enviar a um utilizador uma mensagem eletrónica de reinício da palavra-passe.
- revisiondelete
- Eliminar e restaurar revisões.
- rollback
- Desfazer a última edição da página.
- rsd
- Exportar um esquema (schema) RSD (Really Simple Discovery).
- setnotificationtimestamp
- Atualizar a data e hora de notificação de alterações às páginas vigiadas.
- setpagelanguage
- Alterar a língua de uma página.
- tag
- Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.
- unblock
- Desbloquear um utilizador.
- undelete
- Restaurar revisões de uma página eliminada.
- unlinkaccount
- Remover do utilizador atual uma conta ligada de uma wiki terceira.
- upload
- Carregar um ficheiro, ou obter o estado dos carregamentos pendentes.
- userrights
- Alterar os grupos a que um utilizador pertence.
- validatepassword
- Validar uma palavra-passe face às regras para palavras-passe da wiki.
- watch
- Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.
- tokens
- Obsoleto. Obter chaves para operações de modificação de dados.
- cspreport
- Interno. Usado por browsers para reportar violações da norma "Content Security Policy". Este módulo nunca deve ser usado, exceto quando utilizado automaticamente por um browser compatível com a CSP.
- stashedit
- Interno. Preparar uma edição na cache partilhada.
- visualeditor
- Interno. Devolve o HTML5 para uma página a partir do serviço Parsoid.
- visualeditoredit
- Interno. Gravar no MediaWiki uma página HTML5 (convertida para texto wiki através do serviço Parsoid).
- Um dos seguintes valores: block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens, cspreport, stashedit, visualeditor, visualeditoredit
- Padrão: help
- format
O formato do resultado.
- json
- Produzir os dados de saída no formato JSON.
- jsonfm
- Produzir os dados de saída em formato JSON (realce sintático em HTML).
- none
- Não produzir nada.
- php
- Produzir os dados de saída em formato PHP seriado.
- phpfm
- Produzir os dados de saída em formato PHP seriado (realce sintático em HTML).
- rawfm
- Produzir os dados de saída, incluindo elementos para despiste de erros, em formato JSON (realce sintático em HTML).
- xml
- Produzir os dados de saída em formato XML.
- xmlfm
- Produzir os dados de saída em formato XML (realce sintático em HTML).
- Um dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Padrão: jsonfm
- maxlag
O atraso máximo pode ser usado quando o MediaWiki é instalado num cluster de bases de dados replicadas. Para impedir que as operações causem ainda mais atrasos de replicação do sítio, este parâmetro pode fazer o cliente aguardar até que o atraso de replicação seja inferior ao valor especificado. Caso o atraso atual exceda esse valor, o código de erro maxlag é devolvido com uma mensagem como À espera do servidor $host: $lag segundos de atraso.
Consulte Manual: Parâmetro maxlag para mais informações.- Tipo: inteiro
- smaxage
Definir no cabeçalho HTTP
s-maxage
de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.- Tipo: inteiro
- Padrão: 0
- maxage
Definir no cabeçalho HTTP
max-age
de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.- Tipo: inteiro
- Padrão: 0
- assert
Verificar que o utilizador está autenticado se definido com o valor user, não autenticado se definido com o valor anon, ou que tem o privilégio de conta robô se bot.
- Um dos seguintes valores: anon, bot, user
- assertuser
Verificar que o utilizador atual é o utilizador nomeado.
- Tipo: utilizador, por nome de utilizador
- requestid
Qualquer valor fornecido aqui será incluído na resposta. Pode ser usado para distinguir pedidos.
- servedby
Incluir nos resultados o nome do servidor que serviu o pedido.
- Tipo: booliano (detalhes)
- curtimestamp
Incluir a data e hora atuais no resultado.
- Tipo: booliano (detalhes)
- responselanginfo
Incluir as línguas usadas para uselang e errorlang no resultado.
- Tipo: booliano (detalhes)
- origin
Ao aceder à API usando um pedido AJAX entre domínios (CORS), coloque aqui o domínio de origem. Isto tem de ser incluído em todas as verificações prévias e, portanto, tem de fazer parte do URI do pedido (e não do conteúdo do POST).
Para pedidos autenticados, este valor tem de corresponder de forma exata a um dos cabeçalhos
Origin
, portanto, tem de ser algo como https://en.wikipedia.org ou https://meta.wikimedia.org. Se este parâmetro não for igual ao cabeçalhoOrigin
, será devolvida a resposta 403. Se este parâmetro for igual ao cabeçalhoOrigin
e a origem for permitida (white-listed) os cabeçalhosAccess-Control-Allow-Origin
eAccess-Control-Allow-Credentials
serão preenchidos.Para pedidos não autenticados, especifique o valor *. Isto fará com que o cabeçalho
Access-Control-Allow-Origin
seja preenchido, masAccess-Control-Allow-Credentials
terá o valorfalse
e o acesso a todos os dados específicos do utilizador está restringido.- uselang
A língua a ser usada nas traduções de mensagens. action=query&meta=siteinfo com siprop=languages devolve uma lista de códigos de língua, ou especifique user para usar a língua nas preferências do utilizador atual, ou especifique content para usar a língua de conteúdo desta wiki.
- Padrão: user
- errorformat
O formato a ser usado no texto de avisos e erros.
- plaintext
- Texto wiki com os elementos HTML removidos e as entidades substituídas.
- wikitext
- Texto wiki sem análise sintática.
- html
- HTML.
- raw
- Chave e parâmetros da mensagem.
- none
- Sem saída de texto, só os códigos de erro.
- bc
- Formato usado antes do MediaWiki 1.29. errorlang e errorsuselocal são ignorados.
- Um dos seguintes valores: bc, html, none, plaintext, raw, wikitext
- Padrão: bc
- errorlang
A língua a ser usada para avisos e erros. action=query&meta=siteinfo com siprop=languages devolve uma lista de códigos de língua, ou especifique content para usar a língua de conteúdo desta wiki, ou especifique uselang para usar o mesmo valor que o parâmetro uselang.
- Padrão: uselang
- errorsuselocal
Se fornecido, os textos de erro utilizarão mensagens personalizadas localmente do espaço nominal MediaWiki.
- Tipo: booliano (detalhes)
- Ajuda para o módulo principal.
- api.php?action=help [abrir na página de testes]
- Toda a ajuda numa página.
- api.php?action=help&recursivesubmodules=1 [abrir na página de testes]
action=block
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Bloquear um utilizador.
- user
Utilizador a ser bloqueado.
- Tipo: utilizador, por um de entre nome de utilizador, IP, gama de endereços IP e identificador de utilizador (p. ex. "#12345")
- userid
- Obsoleto.
Especificar antes user=#ID.
- Tipo: inteiro
- expiry
O período de expiração. Pode ser relativo (p. ex. 5 meses ou 2 semanas) ou absoluto (p. ex. 2014-09-18T12:34:56Z). Se definido como infinite, indefinite ou never, o bloqueio nunca expirará.
- Padrão: never
- reason
O motivo do bloqueio.
- Padrão: (vazio)
- anononly
Bloquear só utilizadores anónimos (isto é, impedir edições anónimas a partir deste endereço IP)
- Tipo: booliano (detalhes)
- nocreate
Impedir a criação de contas.
- Tipo: booliano (detalhes)
- autoblock
Bloquear automaticamente o último endereço IP usado e quaisquer outros endereços IP subsequentes a partir do quais o utilizador tente iniciar uma sessão.
- Tipo: booliano (detalhes)
- noemail
Impedir o utilizador de enviar correio eletrónico através da wiki. (Requer o privilégio
blockemail
).- Tipo: booliano (detalhes)
- hidename
Ocultar o nome do utilizador do registo de bloqueios. (Requer o privilégio
hideuser
).- Tipo: booliano (detalhes)
- allowusertalk
Permitir que o utilizador edite a sua própria página de discussão (depende de $wgBlockAllowsUTEdit).
- Tipo: booliano (detalhes)
- reblock
Se o utilizador já está bloqueado, sobrescrever o bloco existente.
- Tipo: booliano (detalhes)
- watchuser
Vigiar as páginas de utilizador e de discussão, do utilizador ou do endereço IP.
- Tipo: booliano (detalhes)
- tags
Etiquetas de modificação a aplicar à entrada no registo de bloqueios.
- Valores (separados com | ou alternativas):
- partial
Bloquear o utilizador de aceder a páginas ou espaços nominais específicos, em vez de a todo o site.
- Tipo: booliano (detalhes)
- pagerestrictions
Lista de títulos que o bloqueio impedirá o utilizador de editar. Só se aplica quando partial (parcial) estiver definido como 'true' (verdadeiro).
- Separar os valores com | ou alternativas.
- O número máximo de valores é 10.
- namespacerestrictions
Lista de identificadores dos espaços nominais que o bloqueio impedirá o utilizador de editar. Só se aplica quando partial (parcial) estiver definido como 'true' (verdadeiro).
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Bloquear o endereço IP 192.0.2.5 por três dias com um motivo.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [abrir na página de testes]
- Bloquear o utilizador Vandal indefinidamente com um motivo, e impedir a criação de nova conta e o envio de correio eletrónico.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [abrir na página de testes]
action=changeauthenticationdata (changeauth)
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar os dados de autenticação do utilizador atual.
- changeauthrequest
Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=change.
- Este parâmetro é obrigatório.
- changeauthtoken
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- *
- Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=change (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
- Tentar alterar a palavra-passe do utilizador atual para ExamplePassword.
- api.php?action=changeauthenticationdata&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC [abrir na página de testes]
action=changecontentmodel
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar o modelo de conteúdo de uma página
- title
Título da página para a qual alterar o modelo de conteúdo. Não pode ser usado em conjunto com pageid.
- pageid
Identificador da página para a qual alterar o modelo de conteúdo. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- summary
Editar resumo de edição e motivo da entrada no registo
- tags
Etiquetas de mudança a aplicar à entrada do registo e à edição.
- Valores (separados com | ou alternativas):
- model
Modelo de conteúdo do novo conteúdo.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- bot
Marca a mudança do modelo de conteúdo com um indicador de robô.
- Tipo: booliano (detalhes)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Alterar a página principal para ter o modelo de conteúdo
text
- api.php?action=changecontentmodel&title=Main Page&model=text&token=123ABC [abrir na página de testes]
action=checktoken
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Verificar a validade de uma chave a partir de action=query&meta=tokens.
- type
Tipo de chave que está a ser testado.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: createaccount, csrf, login, patrol, rollback, userrights, watch
- token
Chave a testar.
- Este parâmetro é obrigatório.
- maxtokenage
Validade máxima da chave, em segundos.
- Tipo: inteiro
- Testar a validade de uma chave csrf.
- api.php?action=checktoken&type=csrf&token=123ABC [abrir na página de testes]
action=clearhasmsg
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Limpa a indicação hasmsg
do utilizador atual.
- Limpar a indicação
hasmsg
do utilizador atual. - api.php?action=clearhasmsg [abrir na página de testes]
action=clientlogin (login)
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Entrar na wiki usando o processo interativo.
O procedimento geral para usar este módulo é:
- Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=login e uma chave login obtida de action=query&meta=tokens.
- Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
- Publique-os para este módulo, fornecendo loginreturnurl e quaisquer campos relevantes.
- Verifique o valor de status na resposta.
- Se recebeu PASS ou FAIL, terminou. A operação terá tido êxito ou falhado.
- Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com logincontinue e os campos relevantes preenchidos, e repita o passo 4.
- Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL loginreturnurl. Depois publique para este módulo com logincontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
- Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
- loginrequests
Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=login ou por uma resposta anterior deste módulo.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- loginmessageformat
Formato a usar nas mensagens de saída.
- Um dos seguintes valores: html, none, raw, wikitext
- Padrão: wikitext
- loginmergerequestfields
Combinar a informação de todos os pedidos de autenticação numa única matriz.
- Tipo: booliano (detalhes)
- loginpreservestate
Preservar o estado de uma tentativa de autenticação anterior falhada, se possível.
- Tipo: booliano (detalhes)
- loginreturnurl
O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou logincontinue.
Tipicamente, depois de receber uma resposta REDIRECT, abrirá um browser ou uma vista da Internet para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a vista da Internet para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido logincontinue a este módulo da API.
- logincontinue
Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro loginreturnurl.
- Tipo: booliano (detalhes)
- logintoken
Uma chave "login" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- *
- Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=login (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
- Inicia o processo de entrada na wiki com o utilizador Example e a palavra-passe ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [abrir na página de testes]
- Continuar o processo de autenticação após uma resposta UI para autenticação de dois fatores, fornecendo uma OATHToken de 987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [abrir na página de testes]
action=compare
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter a diferença entre duas páginas.
Tem de ser passado um número de revisão, ou um título de página, ou um identificador de página, ou uma referência relativa para "from" e "to".
- fromtitle
Primeiro título a comparar.
- fromid
Primeiro identificador de página a comparar.
- Tipo: inteiro
- fromrev
Primeira revisão a comparar.
- Tipo: inteiro
- fromslots
Substituir o conteúdo da revisão especificada por fromtitle, fromid ou fromrev.
Este parâmetro especifica os segmentos que deverão ser modificados. Use fromtext-{slot}, fromcontentmodel-{slot} e fromcontentformat-{slot} para especificar conteúdo para cada segmento.
- Valores (separados com | ou alternativas): main
- fromtext-{slot}
Texto do segmento especificado. Se for omitido, o segmento é removido da revisão.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de fromslots.
- fromsection-{slot}
Quando fromtext-{slot} é o conteúdo de uma única secção, este é o número da secção. Será fundido na revisão especificada por fromtitle, fromid ou fromrev tal como acontece na edição de uma secção.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de fromslots.
- fromcontentformat-{slot}
Formato de seriação do conteúdo de fromtext-{slot}.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de fromslots.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- fromcontentmodel-{slot}
Modelo de conteúdo de fromtext-{slot}. Se não for fornecido, ele será deduzido a partir dos outros parâmetros.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de fromslots.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- frompst
Fazer uma transformação anterior à gravação, de fromtext-{slot}.
- Tipo: booliano (detalhes)
- fromtext
- Obsoleto.
Especificar fromslots=main e usar fromtext-main.
- fromcontentformat
- Obsoleto.
Especificar fromslots=main e usar fromcontentformat-main.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- fromcontentmodel
- Obsoleto.
Especificar fromslots=main e usar fromcontentmodel-main.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- fromsection
- Obsoleto.
Utilizar apenas a secção especificada do conteúdo 'from' especificado.
- totitle
Segundo título a comparar.
- toid
Segundo identificador de página a comparar.
- Tipo: inteiro
- torev
Segunda revisão a comparar.
- Tipo: inteiro
- torelative
Usar uma revisão relativa à revisão determinada a partir de fromtitle, fromid ou fromrev. Todas as outras opções 'to' serão ignoradas.
- Um dos seguintes valores: cur, next, prev
- toslots
Substituir o conteúdo da revisão especificada por totitle, toid ou torev.
Este parâmetro especifica os segmentos que deverão ser modificados. Use totext-{slot}, tocontentmodel-{slot} e tocontentformat-{slot} para especificar conteúdo para cada segmento.
- Valores (separados com | ou alternativas): main
- totext-{slot}
Texto do segmento especificado. Se for omitido, o segmento é removido da revisão.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de toslots.
- tosection-{slot}
Quando totext-{slot} é o conteúdo de uma única secção, este é o número da secção. Será fundido na revisão especificada por totitle, toid ou torev tal como acontece na edição de uma secção.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de toslots.
- tocontentformat-{slot}
Formato de seriação do conteúdo de totext-{slot}.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de toslots.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- tocontentmodel-{slot}
Modelo de conteúdo de totext-{slot}. Se não for fornecido, ele será deduzido a partir dos outros parâmetros.
- Este parâmetro é um parâmetro modelado. Ao fazer o pedido, {slot} no nome do parâmetro deve ser substituído com os valores de toslots.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- topst
Fazer uma transformação anterior à gravação, de totext.
- Tipo: booliano (detalhes)
- totext
- Obsoleto.
Especificar toslots=main e usar totext-main.
- tocontentformat
- Obsoleto.
Especificar toslots=main e usar tocontentformat-main.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- tocontentmodel
- Obsoleto.
Especificar toslots=main e usar tocontentmodel-main.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- tosection
- Obsoleto.
Utilizar apenas a secção especificada do conteúdo 'to' especificado.
- prop
As informações que devem ser obtidas.
- diff
- O HTML da lista de diferenças.
- diffsize
- O tamanho do HTML da lista de diferenças, em bytes.
- rel
- Os identificadores da revisão anterior a 'from' e da posterior a 'to', se existirem.
- ids
- Os identificadores de página e de revisão das revisões 'from' e 'to'.
- title
- Os títulos de página das revisões 'from' e 'to'.
- user
- O nome e o identificador de utilizador das revisões 'from' e 'to'. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade fromuserhidden ou touserhidden.
- comment
- O comentário das revisões 'from' e 'to'. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade fromcommenthidden ou tocommenthidden.
- parsedcomment
- O comentário após análise sintática, das revisões 'from' e 'to'. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade fromcommenthidden ou tocommenthidden.
- size
- O tamanho das revisões 'from' e 'to'.
- timestamp
- (sem descrição)
- Valores (separados com | ou alternativas): comment, diff, diffsize, ids, parsedcomment, rel, size, timestamp, title, user
- Padrão: diff|ids|title
- slots
Devolver as diferenças individuais destes segmentos, em vez de uma lista combinada para todos os segmentos.
- Valores (separados com | ou alternativas): main
- Para especificar todos os valores, use *.
- Criar uma lista de diferenças entre as revisões 1 e 2.
- api.php?action=compare&fromrev=1&torev=2 [abrir na página de testes]
action=createaccount (create)
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Criar uma conta de utilizador nova.
O procedimento geral para usar este módulo é:
- Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=create e uma chave createaccount obtida de action=query&meta=tokens.
- Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
- Publique-os para este módulo, fornecendo createreturnurl e quaisquer campos relevantes.
- Verifique o valor de status na resposta.
- Se recebeu PASS ou FAIL, terminou. A operação terá tido êxito ou falhado.
- Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com createcontinue e os campos relevantes preenchidos, e repita o passo 4.
- Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL createreturnurl. Depois publique para este módulo com createcontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
- Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
- createrequests
Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=create ou por uma resposta anterior deste módulo.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- createmessageformat
Formato a usar nas mensagens de saída.
- Um dos seguintes valores: html, none, raw, wikitext
- Padrão: wikitext
- createmergerequestfields
Combinar a informação de todos os pedidos de autenticação numa única matriz.
- Tipo: booliano (detalhes)
- createpreservestate
Preservar o estado de uma tentativa de autenticação anterior falhada, se possível.
Se action=query&meta=authmanagerinfo devolveu o valor verdadeiro para hasprimarypreservedstate, pedidos marcados como primary-required devem ser omitidos. Se devolveu um valor não vazio em preservedusername, esse nome de utilizador tem de ser usado no parâmetro username.
- Tipo: booliano (detalhes)
- createreturnurl
O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou createcontinue.
Tipicamente, depois de receber uma resposta REDIRECT, abrirá um browser ou uma vista da Internet para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a vista da Internet para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido createcontinue a este módulo da API.
- createcontinue
Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro createreturnurl.
- Tipo: booliano (detalhes)
- createtoken
Uma chave "createaccount" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- *
- Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=create (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
- Iniciar o processo de criação do utilizador Example com a palavra-passe ExamplePassword.
- api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC [abrir na página de testes]
action=cspreport
- Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Usado por browsers para reportar violações da norma "Content Security Policy". Este módulo nunca deve ser usado, exceto quando utilizado automaticamente por um browser compatível com a CSP.
- reportonly
Marcar como sendo um relatório vindo de uma norma de monitorização e não de uma norma exigida.
- Tipo: booliano (detalhes)
- source
Aquilo que gerou o cabeçalho CSP que desencadeou este relatório.
- Padrão: internal
action=delete
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Eliminar uma página.
- title
Título da página a eliminar. Não pode ser usado em conjunto com pageid.
- pageid
Identificador da página a eliminar. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- reason
Motivo para a eliminação. Se não for definido, será usado um motivo gerado automaticamente.
- tags
Etiquetas de modificação a aplicar à entrada no registo de eliminações.
- Valores (separados com | ou alternativas):
- watch
- Obsoleto.
Adicionar a página às páginas vigiadas do utilizador atual.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- unwatch
- Obsoleto.
Remover a página das páginas vigiadas do utilizador atual.
- Tipo: booliano (detalhes)
- oldimage
O nome da imagem antiga a ser eliminada, tal como fornecido por action=query&prop=imageinfo&iiprop=archivename.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Eliminar a página Main Page.
- api.php?action=delete&title=Main%20Page&token=123ABC [abrir na página de testes]
- Eliminar Main Page com o motivo Preparing for move.
- api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move [abrir na página de testes]
action=edit
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Criar e editar páginas.
- title
Título da página a ser editada. Não pode ser usado em conjunto com pageid.
- pageid
Identificador da página a ser editada. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- section
Número da secção. 0 para a secção de topo, new para uma secção nova.
- sectiontitle
Título para uma nova secção.
- text
Conteúdo da página.
- summary
Resumo da edição. Também é o título da secção quando section=new e sectiontitle não está definido.
- tags
Etiquetas de modificação a aplicar à revisão.
- Valores (separados com | ou alternativas):
- minor
Marcar esta edição como menor.
- Tipo: booliano (detalhes)
- notminor
Não marcar esta edição como uma edição menor, mesmo se a preferência "Por omissão, marcar todas as edições como menores" do utilizador estiver definida.
- Tipo: booliano (detalhes)
- bot
Marcar esta edição como edição de robô.
- Tipo: booliano (detalhes)
- baserevid
Identificador da revisão base, usado para detetar conflitos de edições. Pode ser obtido através de action=query&prop=revisions. Autoconflitos causam a falha da edição a menos que esteja definido o parâmetro basetimestamp.
- Tipo: inteiro
- basetimestamp
Data e hora da revisão de base, usada para detetar conflitos de edição. Pode ser obtida usando action=query&prop=revisions&rvprop=timestamp. Os autoconflitos serão ignorados.
- Tipo: data e hora (formatos permitidos)
- starttimestamp
Data e hora de início do processo de edição, usada para detetar conflitos de edição. Pode-se obter um valor apropriado usando curtimestamp ao iniciar o processo de edição (por exemplo, ao carregar o conteúdo da página para edição).
- Tipo: data e hora (formatos permitidos)
- recreate
Ignorar todos os erros acerca da página ter sido eliminada entretanto.
- Tipo: booliano (detalhes)
- createonly
Não editar a página se ela já existe.
- Tipo: booliano (detalhes)
- nocreate
Gerar um erro se a página não existe.
- Tipo: booliano (detalhes)
- watch
- Obsoleto.
Adicionar a página às páginas vigiadas do utilizador atual.
- Tipo: booliano (detalhes)
- unwatch
- Obsoleto.
Remover a página da lista de páginas vigiadas do utilizador atual.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- md5
A chave MD5 do parâmetro text, ou os parâmetros prependtext e appendtext concatenados. Se estiver definido, a edição não será realizada a menos que a chave seja correta.
- prependtext
Adicionar este texto ao início da página. Tem precedência sobre text.
- appendtext
Adicionar este texto ao fim da página. Tem precedência sobre text.
Para acrescentar uma nova secção no fim da página, usar section=new em vez deste parâmetro.
- undo
Desfazer esta revisão. Tem precedência sobre text, prependtext e appendtext.
- Tipo: inteiro
- O valor não pode ser inferior a 0.
- undoafter
Desfazer todas as revisões desde undo até esta. Se não for definido, desfazer só uma revisão.
- Tipo: inteiro
- O valor não pode ser inferior a 0.
- redirect
Resolver automaticamente redirecionamentos.
- Tipo: booliano (detalhes)
- contentformat
Formato para seriação do conteúdo, usado para o texto de entrada.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- contentmodel
Modelo de conteúdo do novo conteúdo.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- token
Uma chave "csrf" obtida de action=query&meta=tokens
A chave deve ser sempre enviada como último parâmetro, ou pelo menos após o parâmetro text.
- Este parâmetro é obrigatório.
- g-recaptcha-response
Campo do widget ReCaptcha.
- Editar uma página.
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&baserevid=1234567&token=123ABC [abrir na página de testes]
- Acrescentar __NOTOC__ ao início de uma página.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [abrir na página de testes]
- Desfazer desde a revisão 13579 até à 13585 com resumo automático.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [abrir na página de testes]
action=emailuser
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enviar correio eletrónico a um utilizador.
- target
Utilizador a quem enviar correio eletrónico.
- Este parâmetro é obrigatório.
- subject
Assunto.
- text
Texto.
- Este parâmetro é obrigatório.
- ccme
Enviar-me uma cópia desta mensagem.
- Tipo: booliano (detalhes)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Enviar uma mensagem de correio ao utilizador WikiSysop com o texto Content.
- api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [abrir na página de testes]
action=embedvideo
- Este módulo requer direitos de leitura.
- Fonte: EmbedVideo
- Licença: MIT
Get gerado código de vídeo incorporado para determinados parâmetros.
- service
Nome do Serviço (YouTube, Twitch, etc)
- Este parâmetro é obrigatório.
- id
O ID do vídeo para esse serviço
- Este parâmetro é obrigatório.
- dimensions
Uma largura numérica (100) ou largura por altura (100x100)
- alignment
Alinhamento de vídeo
- description
Descrição do vídeo
- container
Accepts frame, or leave empty
- urlargs
Argumentos adicionais para passar no URL de vídeo (por alguns serviços)
- autoresize
Auto resize video? (true or false)
action=expandtemplates
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Expande todas as predefinições existentes num texto wiki.
- title
Título da página.
- text
Texto wiki a converter.
- Este parâmetro é obrigatório.
- revid
Identificador da revisão, para
{{REVISIONID}}
e variáveis semelhantes.- Tipo: inteiro
- prop
As informações que devem ser obtidas:
Note que, se não for selecionado nenhum valor, o resultado irá conter o texto wiki mas a saída estará num formato obsoleto.
- wikitext
- O texto wiki expandido.
- categories
- Quaisquer categorias existentes na entrada que não estão representadas no texto wiki de saída.
- properties
- Propriedades da página, definidas por palavras mágicas expandidas, no texto wiki.
- volatile
- Indica se o resultado é volátil e não deve ser reutilizado noutra parte da página.
- ttl
- O período máximo a partir do qual os armazenamentos do resultado na cache devem ser invalidados.
- modules
- Quaisquer módulos ResourceLoader que as funções do analisador sintático solicitaram que fossem adicionados ao resultado de saída. Um dos valores jsconfigvars ou encodedjsconfigvars tem de ser solicitado em conjunto com o valor modules.
- jsconfigvars
- Devolve as variáveis de configuração JavaScript específicas desta página.
- encodedjsconfigvars
- Devolve as variáveis de configuração JavaScript específicas da página, no formato de uma string JSON.
- parsetree
- A árvore de análise sintática em XML do texto de entrada.
- Valores (separados com | ou alternativas): categories, encodedjsconfigvars, jsconfigvars, modules, parsetree, properties, ttl, volatile, wikitext
- includecomments
Indica se devem ser incluídos comentários HTML no resultado.
- Tipo: booliano (detalhes)
- generatexml
- Obsoleto.
Gerar a árvore de análise sintática em XML (substituído por prop=parsetree).
- Tipo: booliano (detalhes)
- Expandir o texto wiki {{Project:Sandbox}}.
- api.php?action=expandtemplates&text={{Project:Sandbox}} [abrir na página de testes]
action=feedcontributions
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve um feed das contribuições do utilizador.
- feedformat
O formato do feed.
- Um dos seguintes valores: atom, rss
- Padrão: rss
- user
Os utilizadores dos quais serão obtidas as contribuições.
- Este parâmetro é obrigatório.
- Tipo: utilizador, por um de entre nome de utilizador, IP, gama de endereços IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- namespace
O espaço nominal pelo qual as contribuições serão filtradas.
- Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- year
Desde o ano.
- Tipo: inteiro
- month
Desde o mês.
- Tipo: inteiro
- tagfilter
Filtrar as contribuições para produzir as que têm estas etiquetas.
- Valores (separados com | ou alternativas): mw-blank, mw-changed-redirect-target, mw-contentmodelchange, mw-new-redirect, mw-removed-redirect, mw-replace, mw-rollback, mw-undo, visualeditor, visualeditor-needcheck, visualeditor-switched, visualeditor-wikitext
- Padrão: (vazio)
- deletedonly
Mostrar apenas as contribuições eliminadas.
- Tipo: booliano (detalhes)
- toponly
Mostrar só edições que sejam a revisão mais recente.
- Tipo: booliano (detalhes)
- newonly
Mostrar apenas as edições que são criações de páginas.
- Tipo: booliano (detalhes)
- hideminor
Ocultar edições menores.
- Tipo: booliano (detalhes)
- showsizediff
Mostrar diferença de tamanho entre edições.
- Tipo: booliano (detalhes)
- Devolver as contribuições do utilizador Example.
- api.php?action=feedcontributions&user=Example [abrir na página de testes]
action=feedrecentchanges
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve um feed das mudanças recentes.
- feedformat
O formato do feed.
- Um dos seguintes valores: atom, rss
- Padrão: rss
- namespace
O espaço nominal ao qual os resultados serão limitados.
- Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- invert
Todos os espaços nominais exceto o selecionado.
- Tipo: booliano (detalhes)
- associated
Incluir o espaço nominal associado (de discussão ou principal).
- Tipo: booliano (detalhes)
- days
Dias aos quais limitar os resultados.
- Tipo: inteiro
- O valor não pode ser inferior a 1.
- Padrão: 7
- limit
O número máximo de resultados a serem devolvidos.
- Tipo: inteiro
- O valor deve estar entre 1 e 50.
- Padrão: 50
- from
Mostrar alterações desde então.
- Tipo: data e hora (formatos permitidos)
- hideminor
Ocultar edições menores.
- Tipo: booliano (detalhes)
- hidebots
Ocultar mudanças feitas por robôs.
- Tipo: booliano (detalhes)
- hideanons
Ocultar mudanças feitas por utilizadores anónimos.
- Tipo: booliano (detalhes)
- hideliu
Ocultar mudanças feitas por utilizadores registados.
- Tipo: booliano (detalhes)
- hidepatrolled
Ocultar mudanças patrulhadas.
- Tipo: booliano (detalhes)
- hidemyself
Ocultar mudanças feitas pelo utilizador atual.
- Tipo: booliano (detalhes)
- hidecategorization
Ocultar mudanças de pertença a categorias.
- Tipo: booliano (detalhes)
- tagfilter
Filtrar por etiqueta.
- target
Mostrar apenas mudanças em páginas afluentes a esta.
- showlinkedto
Mostrar mudanças em páginas com hiperligações para a página selecionada.
- Tipo: booliano (detalhes)
- Mostrar mudanças recentes.
- api.php?action=feedrecentchanges [abrir na página de testes]
- Mostrar as mudanças recentes de 30 dias.
- api.php?action=feedrecentchanges&days=30 [abrir na página de testes]
action=feedwatchlist
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve um feed das páginas vigiadas.
- feedformat
O formato do feed.
- Um dos seguintes valores: atom, rss
- Padrão: rss
- hours
Mostrar as mudanças recentes desde há este número de horas.
- Tipo: inteiro
- O valor deve estar entre 1 e 72.
- Padrão: 24
- linktosections
Ligar diretamente às secções alteradas, se possível.
- Tipo: booliano (detalhes)
- allrev
Incluir revisões múltiplas da mesma página dentro do intervalo de tempo indicado.
- Tipo: booliano (detalhes)
- wlowner
Usado com token para aceder à lista de páginas vigiadas de outro utilizador.
- Tipo: utilizador, por nome de utilizador
- wltoken
Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.
- wlshow
Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, definir show=minor|!anon.
- Valores (separados com | ou alternativas): !anon, !autopatrolled, !bot, !minor, !patrolled, !unread, anon, autopatrolled, bot, minor, patrolled, unread
- wltype
Os tipos de alterações a serem mostradas:
- edit
- Edições normais.
- new
- Criações de páginas.
- log
- Entradas do registo.
- external
- Mudanças externas.
- categorize
- Alterações de pertença a categorias.
- Valores (separados com | ou alternativas): categorize, edit, external, log, new
- Padrão: edit|new|log|categorize
- wlexcludeuser
Não listar as mudanças deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- Mostrar o feed das páginas vigiadas.
- api.php?action=feedwatchlist [abrir na página de testes]
- Mostrar todas as mudanças às páginas vigiadas nas últimas 6 horas.
- api.php?action=feedwatchlist&allrev=&hours=6 [abrir na página de testes]
action=filerevert
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Reverter um ficheiro para uma versão antiga.
- filename
Nome do ficheiro de destino, sem o prefixo File:.
- Este parâmetro é obrigatório.
- comment
Comentário do carregamento.
- Padrão: (vazio)
- archivename
Nome de arquivo da revisão para a qual o ficheiro será revertido.
- Este parâmetro é obrigatório.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Reverter Wiki.png para a revisão de 2011-03-05T15:27:40Z.
- api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [abrir na página de testes]
action=help
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Apresentar ajuda para os módulos especificados.
- modules
Módulos para os quais apresentar ajuda (valores dos parâmetros action e format, ou main). Pode-se especificar submódulos com um +.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Padrão: main
- submodules
Incluir ajuda para submódulos do módulo nomeado.
- Tipo: booliano (detalhes)
- recursivesubmodules
Incluir ajuda para os submódulos de forma recursiva.
- Tipo: booliano (detalhes)
- wrap
Envolver a saída numa estrutura padrão de resposta da API.
- Tipo: booliano (detalhes)
- toc
Incluir uma tabela de conteúdo na saída HTML.
- Tipo: booliano (detalhes)
- Ajuda para o módulo principal.
- api.php?action=help [abrir na página de testes]
- Ajuda para action=query e todos os respetivos submódulos.
- api.php?action=help&modules=query&submodules=1 [abrir na página de testes]
- Toda a ajuda numa página.
- api.php?action=help&recursivesubmodules=1 [abrir na página de testes]
- Ajuda para o próprio módulo de ajuda.
- api.php?action=help&modules=help [abrir na página de testes]
- Ajuda para dois submódulos de consulta.
- api.php?action=help&modules=query+info|query+categorymembers [abrir na página de testes]
action=imagerotate
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Rodar uma ou mais imagens.
- rotation
Graus de rotação da imagem no sentido horário.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: 90, 180, 270
- continue
Quando houver mais resultados disponíveis, usar isto para continuar
- tags
Etiquetas a aplicar à entrada no registo de carregamentos.
- Valores (separados com | ou alternativas):
- titles
Uma lista dos títulos a serem trabalhados.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revids
Uma lista dos identificadores de revisões a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- generator
Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.
Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categorymembers
- Listar todas as páginas numa categoria específica.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- search
- Efetuar uma pesquisa do texto integral.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.
- Tipo: booliano (detalhes)
- converttitles
Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Rodar File:Example.png 90 graus.
- api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC [abrir na página de testes]
- Rodar todas as imagens na categoria Category:Flip em 180 graus.
- api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC [abrir na página de testes]
action=import
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Importar uma página de outra wiki ou de um ficheiro XML.
Note que o pedido POST de HTTP tem de ser feito como um carregamento de ficheiro (isto é, usando "multipart/form-data") ao enviar um ficheiro para o parâmetro xml.
- summary
Resumo da importação para a entrada do registo.
- xml
Ficheiro XML carregado.
- Deve ser postado como um upload de arquivo usando multipart/form-data.
- interwikiprefix
Para importações carregadas: o prefixo interwikis a ser aplicado aos nomes de utilizador desconhecidos (e aos conhecidos se assignknownusers estiver definido).
- interwikisource
Para importações interwikis: a wiki de onde importar.
- Um dos seguintes valores:
- interwikipage
Para importações interwikis: a página a importar.
- fullhistory
Para importações interwikis: importar o historial completo, não apenas a versão atual.
- Tipo: booliano (detalhes)
- templates
Para importações interwikis: importar também todas as predefinições incluídas.
- Tipo: booliano (detalhes)
- namespace
Importar para este espaço nominal. Não pode ser usado em conjunto com rootpage.
- Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- assignknownusers
Atribuir as edições aos utilizadores locais se o utilizador nomeado existir localmente.
- Tipo: booliano (detalhes)
- rootpage
Importar como subpágina desta página. Não pode ser usado em conjunto com namespace.
- tags
Etiquetas de modificação a aplicar à entrada no registo de importações e à revisão nula nas páginas importadas.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Importar meta:Help:ParserFunctions para o espaço nominal 100 com o historial completo.
- api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC [abrir na página de testes]
action=linkaccount (link)
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Ligar uma conta de um fornecedor terceiro ao utilizador atual.
O procedimento geral para usar este módulo é:
- Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=link e uma chave csrf obtida de action=query&meta=tokens.
- Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
- Publique-os para este módulo, fornecendo linkreturnurl e quaisquer campos relevantes.
- Verifique o valor de status na resposta.
- Se recebeu PASS ou FAIL, terminou. A operação terá tido êxito ou falhado.
- Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com linkcontinue e os campos relevantes preenchidos, e repita o passo 4.
- Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL linkreturnurl. Depois publique para este módulo com linkcontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
- Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
- linkrequests
Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=link ou por uma resposta anterior deste módulo.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- linkmessageformat
Formato a usar nas mensagens de saída.
- Um dos seguintes valores: html, none, raw, wikitext
- Padrão: wikitext
- linkmergerequestfields
Combinar a informação de todos os pedidos de autenticação numa única matriz.
- Tipo: booliano (detalhes)
- linkreturnurl
O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou linkcontinue.
Tipicamente, depois de receber uma resposta REDIRECT, abrirá um browser ou uma vista da Internet para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a vista da Internet para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido linkcontinue a este módulo da API.
- linkcontinue
Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro linkreturnurl.
- Tipo: booliano (detalhes)
- linktoken
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- *
- Este módulo aceita parâmetros adicionais, dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=link (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
- Iniciar o processo de ligação a uma conta do fornecedor Example.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [abrir na página de testes]
action=login (lg)
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Iniciar uma sessão e obter cookies de autenticação.
Esta operação só deve ser usada em combinação com Special:BotPasswords; a sua utilização para entrar com a conta principal é obsoleta e poderá falhar sem aviso. Para entrar com a conta principal de forma segura, use action=clientlogin.
- lgname
Nome de utilizador.
- lgpassword
Palavra-passe.
- lgdomain
Domínio (opcional).
- lgtoken
Uma chave "login" obtida de action=query&meta=tokens
action=logout
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Terminar a sessão e limpar os dados da sessão.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Terminar a sessão do utilizador atual.
- api.php?action=logout&token=123ABC [abrir na página de testes]
action=managetags
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Executar tarefas de gestão relacionadas com etiquetas de modificação.
- operation
A operação que será realizada:
- create
- Criar uma nova etiqueta de modificação para uso manual.
- delete
- Remover da base de dados uma etiqueta de modificação, incluindo remover a etiqueta de todas as revisões, entradas nas mudanças recentes e entradas do registo onde ela é utilizada.
- activate
- Ativar uma etiqueta de modificação, permitindo que os utilizadores a apliquem manualmente.
- deactivate
- Desativar uma etiqueta de modificação, impedindo que os utilizadores a apliquem manualmente.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: activate, create, deactivate, delete
- tag
Etiqueta a ser criada, eliminada, ativada ou desativada. Para criar uma etiqueta ela não pode existir. Para eliminar uma etiqueta, ela tem de existir. Para ativar uma etiqueta, ela tem de existir e não estar a ser utilizada por nenhuma extensão. Para desativar uma etiqueta, ela tem de estar ativa e definida manualmente.
- Este parâmetro é obrigatório.
- reason
Um motivo, opcional, para a criação, eliminação, ativação ou desativação da etiqueta.
- ignorewarnings
Indica se devem ser ignorados todos os avisos gerados durante a operação.
- Tipo: booliano (detalhes)
- tags
Etiquetas de modificação a aplicar à entrada no registo de gestão de etiquetas.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Criar uma etiqueta com o nome spam e o motivo For use in edit patrolling
- api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [abrir na página de testes]
- Eliminar a etiqueta vandlaism com o motivo Misspelt
- api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC [abrir na página de testes]
- Ativar uma etiqueta com o nome spam e o motivo For use in edit patrolling
- api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [abrir na página de testes]
- Desativar uma etiqueta com o nome spam e o motivo No longer required
- api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC [abrir na página de testes]
action=mergehistory
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Fundir o historial de páginas.
- from
Título da página cujo historial será fundido. Não pode ser usado em conjunto com fromid.
- fromid
Identificador da página cujo historial será fundido. Não pode ser usado em conjunto com from.
- Tipo: inteiro
- to
Título da página à qual o historial será fundido. Não pode ser usado em conjunto com toid.
- toid
Identificador da página à qual o historial será fundido. Não pode ser usado em conjunto com to.
- Tipo: inteiro
- timestamp
Data e hora até a qual as revisões serão movidas do historial da página de origem para o historial das páginas de destino. Se omitido, todo o historial da página de origem será fundido com a página de destino.
- Tipo: data e hora (formatos permitidos)
- reason
Motivo para fundir o historial.
- Padrão: (vazio)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Fundir todo o historial da página Oldpage com o da página Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason [abrir na página de testes]
- Fundir as revisões de Oldpage até à data e hora 2015-12-31T04:37:41Z com Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason×tamp=2015-12-31T04%3A37%3A41Z [abrir na página de testes]
action=move
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Mover uma página.
- from
Título da página cujo nome será alterado. Não pode ser usado em conjunto com fromid.
- fromid
Identificador da página cujo nome será alterado. Não pode ser usado em conjunto com from.
- Tipo: inteiro
- to
Novo título da página.
- Este parâmetro é obrigatório.
- reason
Motivo para a alteração do nome.
- Padrão: (vazio)
- movetalk
Alterar o nome da página de discussão, se esta existir.
- Tipo: booliano (detalhes)
- movesubpages
Alterar o nome das subpáginas, se estas existirem.
- Tipo: booliano (detalhes)
- noredirect
Não criar um redirecionamento.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- ignorewarnings
Ignorar quaisquer avisos.
- Tipo: booliano (detalhes)
- tags
Etiquetas de modificação a aplicar à entrada no registo de movimentações e à revisão nula na página de destino.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Mover Badtitle para Goodtitle sem deixar um redirecionamento.
- api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect= [abrir na página de testes]
action=opensearch
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Pesquisar a wiki usando o protocolo OpenSearch.
- search
Texto a pesquisar.
- Este parâmetro é obrigatório.
- namespace
Espaços nominais a pesquisar. Ignorados se search começar com um prefixo de espaço nominal válido.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- Padrão: 0
- limit
O número máximo de resultados a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- suggest
- Obsoleto.
Deixou de ser utilizado.
- Tipo: booliano (detalhes)
- redirects
Como tratar redirecionamentos:
- return
- Devolver o próprio redirecionamento.
- resolve
- Devolver a página de destino. Pode devolver menos de limit resultados.
Por razões históricas, o valor por omissão é "return" para o formato format=json e "resolve" para outros formatos.
- Um dos seguintes valores: resolve, return
- format
O formato do resultado.
- Um dos seguintes valores: json, jsonfm, xml, xmlfm
- Padrão: json
- warningsaserror
Se forem gerados avisos com format=json, devolver um erro da API em vez de ignorá-los.
- Tipo: booliano (detalhes)
- Encontrar as páginas que começam por Te.
- api.php?action=opensearch&search=Te [abrir na página de testes]
action=options
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar as preferências do utilizador atual.
Só podem ser definidas as opções que estão registadas no núcleo do MediaWiki ou numa das extensões instaladas, ou opções cuja chave tem o prefixo userjs-
(que são supostas ser usadas por scripts de utilizador).
- reset
Reiniciar preferências para os valores por omissão do sítio.
- Tipo: booliano (detalhes)
- resetkinds
Lista dos tipos de opções a reiniciar quando a opção reset está definida.
- Valores (separados com | ou alternativas): all, registered, registered-checkmatrix, registered-multiselect, special, unused, userjs
- Padrão: all
- change
Listas das alterações, na forma nome=valor (isto é, skin=vector). Se não for fornecido nenhum valor (nem sequer um sinal de igualdade), por exemplo, nomedaopção|outraopção|..., a opção será reiniciada para o seu valor por omissão. Se qualquer dos valores passados contém uma barra vertical (|), use um separador alternativo para valores múltiplos de forma a obter o comportamento correto.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- optionname
O nome da opção que deve ser configurada com o valor dado por optionvalue.
- optionvalue
O valor para a opção especificada por optionname.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Reiniciar todas as preferências.
- api.php?action=options&reset=&token=123ABC [abrir na página de testes]
- Alterar as preferências skin e hideminor.
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [abrir na página de testes]
- Reiniciar todas as preferências e depois definir skin e nickname.
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [abrir na página de testes]
action=paraminfo
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informação sobre os módulos da API.
- modules
Lista dos nomes dos módulos (valores dos parâmetros action e format, ou main). Podem ser especificados submódulos com +, ou todos os submódulos com +*, ou todos os submódulos de forma recursiva com +**.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- helpformat
Formato dos textos de ajuda.
- Um dos seguintes valores: html, none, raw, wikitext
- Padrão: none
- querymodules
- Obsoleto.
Lista de nomes dos módulos a consultar (valores dos parâmetros prop, meta ou list). Usar modules=query+foo em vez de querymodules=foo.
- Valores (separados com | ou alternativas): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, backlinks, blocks, categories, categoryinfo, categorymembers, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, filerepoinfo, fileusage, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, languageinfo, links, linkshere, logevents, mystashedfiles, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, usercontribs, userinfo, users, watchlist, watchlistraw
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- mainmodule
- Obsoleto.
Obter também informação sobre o módulo principal (do nível de topo). Em vez de usá-lo, usar modules=main.
- pagesetmodule
- Obsoleto.
Obter também informação sobre o módulo pageset (fornecendo titles= e restantes).
- formatmodules
- Obsoleto.
Lista de nomes de módulos de formato (valor do parâmetro format). Em vez de usá-lo, use modules.
- Valores (separados com | ou alternativas): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Mostrar informação para action=parse, format=jsonfm, action=query&list=allpages e action=query&meta=siteinfo.
- api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [abrir na página de testes]
- Mostrar informação de todos os módulos de action=query.
- api.php?action=paraminfo&modules=query%2B* [abrir na página de testes]
action=parse
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Faz a análise sintática do conteúdo e devolve o resultado da análise.
Consulte os vários módulos disponíveis no parâmetro prop de action=query para obter informação da versão atual de uma página.
Há várias formas de especificar o texto a analisar:
- Especificar uma página ou revisão, usando page, pageid ou oldid.
- Especificar o conteúdo de forma explícita, usando text, title, revid e contentmodel.
- Especificar só um resumo a analisar. prop deve receber o valor vazio.
- title
Título da página à qual o texto pertence. Se omitido, é preciso especificar contentmodel e deve usar API como título.
- text
Texto a analisar. Usar title ou contentmodel para controlar o modelo de conteúdo.
- revid
Identificador da revisão, para
{{REVISIONID}}
e variáveis semelhantes.- Tipo: inteiro
- summary
Resumo a analisar.
- page
Analisar o conteúdo desta página. Não pode ser usado em conjunto com text e title.
- pageid
Analisar o conteúdo desta página. Tem precedência sobre page.
- Tipo: inteiro
- redirects
Se page ou pageid estiverem definidos para um redirecionamento, resolvê-lo.
- Tipo: booliano (detalhes)
- oldid
Analisar o conteúdo desta revisão. Tem precedência sobre page e pageid.
- Tipo: inteiro
- prop
As informações que devem ser obtidas:
- text
- Fornece o texto analisado resultante do texto wiki.
- langlinks
- Fornece as hiperligações interlínguas do texto wiki analisado.
- categories
- Fornece as categorias do texto wiki analisado.
- categorieshtml
- Fornece a versão HTML das categorias.
- links
- Fornece as hiperligações internas do texto wiki analisado.
- templates
- Fornece as predefinições do texto wiki analisado.
- images
- Fornece as imagens do texto wiki analisado.
- externallinks
- Fornece as hiperligações externas do texto wiki analisado.
- sections
- Fornece as secções do texto wiki analisado.
- revid
- Adiciona o identificador de revisão da página analisada.
- displaytitle
- Adiciona o título do texto wiki analisado.
- headhtml
- Fornece o tipo analisado do documento, abrindo
<html>
, o elemento<head>
e o<body>
da página. - modules
- Fornece os módulos ResourceLoader usados na página. Para carregá-los, usar
mw.loader.using()
. Uma das variáveis jsconfigvars ou encodedjsconfigvars tem de ser pedida em conjunto com modules. - jsconfigvars
- Fornece as variáveis de configuração JavaScript específicas da página. Para aplicá-las, usar
mw.config.set()
. - encodedjsconfigvars
- Fornece as variáveis de configuração JavaScript específicas da página, no formato de uma string JSON.
- indicators
- Fornece o HTML dos indicadores de estado de página que são usados na página.
- iwlinks
- Fornece as hiperligações interwikis do texto wiki analisado.
- wikitext
- Fornece o texto wiki original que foi analisado.
- properties
- Fornece várias propriedades definidas no texto analisado.
- limitreportdata
- Fornece o relatório de limites de forma estruturada. Não fornece dados quando disablelimitreport está definido.
- limitreporthtml
- Fornece a versão HTML do relatório de limites. Não fornece dados quando disablelimitreport está definido.
- parsetree
- A árvore de análise XML do conteúdo da revisão (requer o modelo de conteúdo
wikitext
). - parsewarnings
- Fornece os avisos gerados durante a análise sintática do conteúdo.
- headitems
- Obsoleto. Fornece os elementos a colocar no
<head>
da página.
- Valores (separados com | ou alternativas): categories, categorieshtml, displaytitle, encodedjsconfigvars, externallinks, headhtml, images, indicators, iwlinks, jsconfigvars, langlinks, limitreportdata, limitreporthtml, links, modules, parsetree, parsewarnings, properties, revid, sections, templates, text, wikitext, headitems
- Padrão: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- wrapoutputclass
A classe CSS a utilizar para envolver o resultado do analisador sintático.
- Padrão: mw-parser-output
- pst
Fazer uma transformação anterior à gravação do texto de entrada, antes de analisá-lo. Só é válido quando usado com texto.
- Tipo: booliano (detalhes)
- onlypst
Fazer uma transformação anterior à gravação (PST, pre-save transform) do texto de entrada, mas não o analisar. Devolve o mesmo texto após aplicação da PST. Só é válido quando usado com text.
- Tipo: booliano (detalhes)
- effectivelanglinks
- Obsoleto.
Inclui hiperligações interlínguas fornecidas por extensões (para ser usado com prop=langlinks).
- Tipo: booliano (detalhes)
- section
Analisar apenas o conteúdo desta secção.
Quando tiver o valor new, analisar text e sectiontitle como se fosse adicionar uma nova secção à página.
new só é permitido quando se especifica text.
- sectiontitle
O novo título da secção quando section tem o valor new.
Ao contrário da edição de páginas, este não toma o valor de summary se for omitido ou estiver vazio.
- disablepp
- Obsoleto.
Em vez deste, usar disablelimitreport.
- Tipo: booliano (detalhes)
- disablelimitreport
Omitir o relatório de limites ("NewPP limit report") do resultado de saída do analisador sintático.
- Tipo: booliano (detalhes)
- disableeditsection
Omitir as hiperligações para edição da secção no resultado da análise sintática.
- Tipo: booliano (detalhes)
- disablestylededuplication
Não desduplicar as folhas de estilo internas (etiquetas <style>) na saída do analisador sintático.
- Tipo: booliano (detalhes)
- generatexml
- Obsoleto.
Gerar a árvore de análise XML (requer o modelo de conteúdo
wikitext
; substituído por prop=parsetree).- Tipo: booliano (detalhes)
- preview
Executar a análise em modo de antevisão.
- Tipo: booliano (detalhes)
- sectionpreview
Executar a análise em modo de antevisão (também ativa o modo de antevisão).
- Tipo: booliano (detalhes)
- disabletoc
Omitir a tabela de conteúdo no resultado.
- Tipo: booliano (detalhes)
- useskin
Aplicar o tema selecionado ao resultado do analisador sintático. Pode afetar as seguintes propriedades: langlinks, headitems, modules, jsconfigvars, indicators.
- Um dos seguintes valores: chameleon, monobook, timeless, vector
- contentformat
O formato da seriação de conteúdo, usado para o texto de entrada. Só é válido quando usado com text.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- contentmodel
Modelo de conteúdo do texto de entrada. Se omitido, title tem de ser especificado e o valor por omissão será o modelo do título especificado. Só é válido quando usado com text.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- Fazer a análise sintática de uma página.
- api.php?action=parse&page=Project:Sandbox [abrir na página de testes]
- Fazer a análise sintática do texto wiki.
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [abrir na página de testes]
- Fazer a análise sintática do texto wiki, especificando o título da página.
- api.php?action=parse&text={{PAGENAME}}&title=Test [abrir na página de testes]
- Fazer a análise sintática de um resumo.
- api.php?action=parse&summary=Some+[[link]]&prop= [abrir na página de testes]
action=patrol
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Patrulhar uma página ou revisão.
- rcid
Identificador da mudança recente a patrulhar.
- Tipo: inteiro
- revid
Identificador da revisão a patrulhar.
- Tipo: inteiro
- tags
Etiquetas de modificação a aplicar à entrada no registo de edições patrulhadas.
- Valores (separados com | ou alternativas):
- token
Uma chave "patrol" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Patrulhar uma mudança recente.
- api.php?action=patrol&token=123ABC&rcid=230672766 [abrir na página de testes]
- Patrulhar uma revisão.
- api.php?action=patrol&token=123ABC&revid=230672766 [abrir na página de testes]
action=protect
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar o nível de proteção de uma página.
- title
Título da página a proteger ou desproteger. Não pode ser usado em conjunto com pageid.
- pageid
Identificador da página a proteger ou desproteger. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- protections
Lista de níveis de proteção, na forma action=level (por exemplo, edit=sysop). O nível all significada que todos podem executar a operação, isto é, sem restrição.
Nota: Serão removidas as restrições de quaisquer operações não listadas.
- Este parâmetro é obrigatório.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- expiry
Datas e horas de expiração. Se só uma data e hora for definida, será usada para todas as proteções. Use infinite, indefinite, infinity ou never, para proteção sem expiração.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Padrão: infinite
- reason
Motivo da proteção ou desproteção.
- Padrão: (vazio)
- tags
Etiquetas de modificação a aplicar à entrada no registo de proteções.
- Valores (separados com | ou alternativas):
- cascade
Ativar a proteção em cascata (isto é, proteger as predefinições transcluídas e as imagens usadas nesta página). Ignorado se nenhum dos níveis de proteção dados suportam a proteção em cascata.
- Tipo: booliano (detalhes)
- watch
- Obsoleto.
Se definido, adicionar a página que está a ser protegida ou desprotegida às páginas vigiadas do utilizador atual.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Proteger uma página.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [abrir na página de testes]
- Desproteger uma página definindo a restrição all (isto é, todos podem executar a operação).
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [abrir na página de testes]
- Desproteger uma página definindo que não há restrições.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions [abrir na página de testes]
action=purge
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Limpar a cache para os títulos especificados.
- forcelinkupdate
Atualizar as tabelas de hiperligações e realizar outras atualizações de dados secundárias.
- Tipo: booliano (detalhes)
- forcerecursivelinkupdate
O mesmo que forcelinkupdate, e atualizar as tabelas de hiperligações de qualquer página que usa esta página como modelo.
- Tipo: booliano (detalhes)
- continue
Quando houver mais resultados disponíveis, usar isto para continuar
- titles
Uma lista dos títulos a serem trabalhados.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revids
Uma lista dos identificadores de revisões a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- generator
Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.
Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categorymembers
- Listar todas as páginas numa categoria específica.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- search
- Efetuar uma pesquisa do texto integral.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.
- Tipo: booliano (detalhes)
- converttitles
Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
- Purgar as páginas Main Page e API.
- api.php?action=purge&titles=Main_Page|API [abrir na página de testes]
- Purgar as primeiras 10 páginas no espaço nominal principal.
- api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [abrir na página de testes]
action=query
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter dados de, e sobre, o MediaWiki.
Todas as modificações de dados terão primeiro que usar uma consulta para adquirir uma chave, o que visa impedir abusos de sítios maliciosos.
- prop
As propriedades a serem obtidas para as páginas consultadas.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categoryinfo
- Devolve informação sobre as categorias indicadas.
- contributors
- Obter a lista do contribuidores autenticados e a contagem dos contribuidores anónimos de uma página.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- extlinks
- Devolve todos os URL externos (que não sejam interwikis) das páginas especificadas.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- imageinfo
- Devolve informação do ficheiro e o historial de carregamentos.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- info
- Obter a informação básica da página.
- iwlinks
- Devolve todas as hiperligações interwikis das páginas indicadas.
- langlinks
- Devolve todas as hiperligações interlínguas das páginas indicadas.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageprops
- Obter várias propriedades de página definidas no conteúdo da página.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- stashimageinfo
- Devolve informações dos ficheiros escondidos.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- Valores (separados com | ou alternativas): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
- list
As listas a serem obtidas.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- allusers
- Enumerar todos os utilizadores registados.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- blocks
- Listar todos os utilizadores e endereços IP bloqueados.
- categorymembers
- Listar todas as páginas numa categoria específica.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- filearchive
- Enumerar todos os ficheiros eliminados sequencialmente.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- logevents
- Obter eventos dos registos.
- mystashedfiles
- Obter uma lista dos ficheiros que estão na área de ficheiros escondidos do utilizador atual.
- pagepropnames
- Listar todos os nomes de propriedades de páginas em uso nesta wiki.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- search
- Efetuar uma pesquisa do texto integral.
- tags
- Listar as etiquetas de modificação.
- usercontribs
- Obter todas as edições de um utilizador.
- users
- Obter informações sobre uma lista de utilizadores.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- deletedrevs
- Obsoleto. Listar as revisões eliminadas.
- Valores (separados com | ou alternativas): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw, deletedrevs
- meta
Os metadados a serem obtidos.
- allmessages
- Devolver as mensagens deste sítio.
- authmanagerinfo
- Obter informação sobre o atual estado de autenticação.
- filerepoinfo
- Devolver meta informação sobre os repositórios de imagens configurados na wiki.
- languageinfo
- Devolver informações sobre as línguas disponíveis.
- siteinfo
- Devolver informação geral sobre o sítio.
- tokens
- Obtém chaves para operações de modificação de dados.
- userinfo
- Obter informações sobre o utilizador atual.
- Valores (separados com | ou alternativas): allmessages, authmanagerinfo, filerepoinfo, languageinfo, siteinfo, tokens, userinfo
- indexpageids
Incluir uma secção adicional de identificadores de página que lista todos os identificadores de página devolvidos.
- Tipo: booliano (detalhes)
- export
Exportar as revisões atuais de todas as páginas fornecidas ou geradas.
- Tipo: booliano (detalhes)
- exportnowrap
Devolver o XML de exportação sem envolvê-lo num resultado XML (o mesmo formato que Special:Export). Só pode ser usado com query+export.
- Tipo: booliano (detalhes)
- exportschema
Ao exportar, fazê-lo para a versão fornecida do formato da exportação XML. Só pode ser usado com query+export.
- Um dos seguintes valores: 0.10, 0.11
- Padrão: 0.11
- iwurl
Indica se deve ser obtido o URL completo quando o título é uma hiperligação interwikis.
- Tipo: booliano (detalhes)
- continue
Quando houver mais resultados disponíveis, usar isto para continuar
- rawcontinue
Devolver os dados em bruto de query-continue para continuar.
- Tipo: booliano (detalhes)
- titles
Uma lista dos títulos a serem trabalhados.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revids
Uma lista dos identificadores de revisões a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- generator
Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.
Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categorymembers
- Listar todas as páginas numa categoria específica.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- search
- Efetuar uma pesquisa do texto integral.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Resolver automaticamente os redirecionamentos listados nos parâmetros query+titles, query+pageids e query+revids, e nas páginas devolvidas por query+generator.
- Tipo: booliano (detalhes)
- converttitles
Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
- Obter informação do sítio e as revisões da página Main Page.
- api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue= [abrir na página de testes]
- Obter as revisões das páginas que começam por API/.
- api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [abrir na página de testes]
prop=categories (cl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as categorias às quais as páginas pertencem.
- clprop
As propriedades adicionais que devem ser obtidas para cada categoria:
- sortkey
- Adiciona a chave de ordenação (string hexadecimal) e o prefixo da chave de ordenação (parte legível) da categoria.
- timestamp
- Adiciona a data e hora a que a categoria foi adicionada.
- hidden
- Etiqueta as categorias que estão ocultadas com
__HIDDENCAT__
.
- Valores (separados com | ou alternativas): hidden, sortkey, timestamp
- clshow
Os tipos de categorias que serão mostrados.
- Valores (separados com | ou alternativas): !hidden, hidden
- cllimit
O número de categorias a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- clcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- clcategories
Listar só estas categorias. Útil para verificar se uma determinada página está numa determinada categoria.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- cldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter uma lista das categorias às quais pertence a página Albert Einstein.
- api.php?action=query&prop=categories&titles=Albert%20Einstein [abrir na página de testes]
- Obter informação sobre todas as categorias usadas na página Albert Einstein.
- api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [abrir na página de testes]
prop=categoryinfo (ci)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve informação sobre as categorias indicadas.
- cicontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter informações sobre Category:Foo e Category:Bar.
- api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [abrir na página de testes]
prop=contributors (pc)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter a lista do contribuidores autenticados e a contagem dos contribuidores anónimos de uma página.
- pcgroup
Incluir só os utilizadores nos grupos indicados. Não inclui os grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- pcexcludegroup
Excluir os utilizadores nos grupos indicados. Não inclui os grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- pcrights
Incluir só os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.
- Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, confirmaccount, confirmaccount-notify, createaccount, createpage, createtalk, delete, deletebatch, deletebatch-spoof, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, hideuser, import, importupload, ipblock-exempt, lookupcredentials, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, requestips, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, usermerge, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pcexcluderights
Excluir os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.
- Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, confirmaccount, confirmaccount-notify, createaccount, createpage, createtalk, delete, deletebatch, deletebatch-spoof, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, hideuser, import, importupload, ipblock-exempt, lookupcredentials, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, requestips, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, usermerge, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pclimit
O número de contribuidores a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- pccontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Mostrar os contribuidores da página Main Page.
- api.php?action=query&prop=contributors&titles=Main_Page [abrir na página de testes]
prop=deletedrevisions (drv)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informações sobre as revisões eliminadas.
Pode ser usado de várias maneiras:
- Obter as revisões eliminadas para um conjunto de páginas, definindo títulos ou identificadores de página. Ordenados por título e data e hora.
- Obter dados sobre um conjunto de revisões eliminadas definindo os respetivos ids: com identificadores de revisão. Ordenados pelo identificador de revisão.
- drvprop
As propriedades a serem obtidas para cada revisão:
- ids
- O identificador da revisão.
- flags
- As etiquetas da revisão (menor).
- timestamp
- A data e hora da revisão.
- user
- O utilizador que fez a revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- O identificador de utilizador do criador da revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- size
- O comprimento (em bytes) da revisão.
- slotsize
- O comprimento (em bytes) de cada segmento de revisão.
- sha1
- O resumo criptográfico SHA-1 (na base 16) da revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- slotsha1
- O resumo criptográfico SHA-1 (base 16) de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- contentmodel
- O identificador do modelo de conteúdo de cada segmento de revisão.
- comment
- O comentário do utilizador para a revisão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- O comentário do utilizador para a revisão, após a análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- content
- Conteúdo de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade textthidden.
- tags
- As etiquetas para a revisão.
- roles
- Listar as funções dos segmentos de conteúdo que existem na revisão.
- parsetree
- Obsoleto. Usar antes action=expandtemplates ou action=parse. A árvore XML da análise sintática do conteúdo da revisão
wikitext
.
- Valores (separados com | ou alternativas): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
- Padrão: ids|timestamp|flags|comment|user
- drvslots
Quais os segmentos de revisão cujos dados devem ser devolvidos quando propriedades relacionadas com segmentos são incluídas em drvprops. Se for omitido, serão devolvidos dados do segmento principal (main) num formato compatível com versões anteriores.
- Valores (separados com | ou alternativas): main
- Para especificar todos os valores, use *.
- drvlimit
Limitar o número de revisões que serão devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- drvexpandtemplates
- Obsoleto.
Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer drvprop=content).
- Tipo: booliano (detalhes)
- drvgeneratexml
- Obsoleto.
Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer drvprop=content).
- Tipo: booliano (detalhes)
- drvparse
- Obsoleto.
Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer drvprop=content). Por motivos de desempenho, se esta opção for usada drvlimit é forçado a ser 1.
- Tipo: booliano (detalhes)
- drvsection
Obter apenas o conteúdo da secção que tem este número.
- drvdiffto
- Obsoleto.
Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).
- drvdifftotext
- Obsoleto.
Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre drvdiffto. Se drvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.
- drvdifftotextpst
- Obsoleto.
Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com drvdifftotext.
- Tipo: booliano (detalhes)
- drvcontentformat
- Obsoleto.
O formato de seriação usado para drvdifftotext e esperado para o conteúdo produzido.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- drvstart
A data e hora da revisão a partir da qual será começada a enumeração. Ignorado ao processar uma lista de identificadores de revisão.
- Tipo: data e hora (formatos permitidos)
- drvend
A data e hora da revisão na qual será terminada a enumeração. Ignorado ao processar uma lista de identificadores de revisão.
- Tipo: data e hora (formatos permitidos)
- drvdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: drvstart tem de estar antes de drvend.
- older
- Listar o mais recente primeiro (padrão). Nota: drvstart tem de estar depois de drvend.
- Um dos seguintes valores: newer, older
- Padrão: older
- drvtag
Listar só as revisões marcadas com esta etiqueta.
- drvuser
Listar só as revisões deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- drvexcludeuser
Não listar as revisões deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- drvcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Listar as revisões eliminadas das páginas Main Page e Talk:Main Page, com o conteúdo.
- api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvslots=*&drvprop=user|comment|content [abrir na página de testes]
- Listar a informação da revisão eliminada 123456.
- api.php?action=query&prop=deletedrevisions&revids=123456 [abrir na página de testes]
prop=duplicatefiles (df)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- dflimit
O número de ficheiros duplicados a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- dfcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- dfdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- dflocalonly
Procurar ficheiros só no repositório local.
- Tipo: booliano (detalhes)
- Procurar os ficheiros duplicados de File:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles [abrir na página de testes]
- Procurar duplicados de todos os ficheiros.
- api.php?action=query&generator=allimages&prop=duplicatefiles [abrir na página de testes]
prop=extlinks (el)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todos os URL externos (que não sejam interwikis) das páginas especificadas.
- ellimit
O número de hiperligações a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- elcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- elprotocol
Protocolo do URL. Se vazio e elquery está definido, o protocolo é http. Deixe este parâmetro e elquery vazios para listar todas as hiperligações externas.
- Um dos seguintes valores: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp
- Padrão: (vazio)
- elquery
Texto de pesquisa sem protocolo. Útil para verificar se uma determinada página contém um determinado URL externo.
- elexpandurl
Expandir os URL relativos a protocolo com o protocolo canónico.
- Tipo: booliano (detalhes)
- Obter uma lista das hiperligações externas da Main Page.
- api.php?action=query&prop=extlinks&titles=Main%20Page [abrir na página de testes]
prop=fileusage (fu)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que usam os ficheiros indicados.
- fuprop
As propriedades a serem obtidas:
- pageid
- O identificador de cada página.
- title
- O título de cada página.
- redirect
- Indicar se a página é um redirecionamento.
- Valores (separados com | ou alternativas): pageid, redirect, title
- Padrão: pageid|title|redirect
- funamespace
Incluir só as páginas destes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- fushow
Mostrar só as páginas que correspondem a estes critérios:
- redirect
- Mostrar só os redirecionamentos.
- !redirect
- Mostrar só os não redirecionamentos.
- Valores (separados com | ou alternativas): !redirect, redirect
- fulimit
O número de elementos a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- fucontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter uma lista das páginas que usam File:Example.jpg.
- api.php?action=query&prop=fileusage&titles=File%3AExample.jpg [abrir na página de testes]
- Obter informação sobre as páginas que usam File:Example.jpg.
- api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info [abrir na página de testes]
prop=imageinfo (ii)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve informação do ficheiro e o historial de carregamentos.
- iiprop
As informações do ficheiro que devem ser obtidas:
- timestamp
- Adiciona a data e hora da versão carregada.
- user
- Adiciona o utilizador que carregou cada versão do ficheiro. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- Adiciona o identificador do utilizador que carregou cada versão do ficheiro. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- comment
- O comentário da versão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- Fazer a análise sintática do comentário da versão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- canonicaltitle
- Adiciona o título canónico do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- url
- Devolve URL para o ficheiro e a página de descrição. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- size
- Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
- dimensions
- Nome alternativo para size.
- sha1
- Adiciona o resumo criptográfico SHA-1 do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- mime
- Adiciona o tipo MIME do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- thumbmime
- Adiciona o tipo MIME da miniatura (requer URL e o parâmetro iiurlwidth). Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- mediatype
- Adiciona o tipo de multimédia do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- metadata
- Lista os metadados Exif para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- commonmetadata
- Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- extmetadata
- Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- archivename
- Adiciona o nome de ficheiro da versão arquivada das versões anteriores à última. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- bitdepth
- Adiciona a profundidade em bits da versão. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- uploadwarning
- Usado pela página Special:Upload para obter informação sobre um ficheiro existente. Não se destina a ser usado fora do núcleo central do MediaWiki.
- badfile
- Indica se o ficheiro está na lista MediaWiki:Bad image list
- Valores (separados com | ou alternativas): archivename, badfile, bitdepth, canonicaltitle, comment, commonmetadata, dimensions, extmetadata, mediatype, metadata, mime, parsedcomment, sha1, size, thumbmime, timestamp, uploadwarning, url, user, userid
- Padrão: timestamp|user
- iilimit
O número de revisões a serem devolvidas por ficheiro.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 1
- iistart
Data e hora a partir da qual será começada a listagem.
- Tipo: data e hora (formatos permitidos)
- iiend
Data e hora na qual será terminada a listagem.
- Tipo: data e hora (formatos permitidos)
- iiurlwidth
Se iiprop=url está definido, será devolvido um URL para uma imagem redimensionada com este comprimento. Por razões de desempenho, se esta opção for usada não serão devolvidas mais de 50 imagens redimensionadas.
- Tipo: inteiro
- Padrão: -1
- iiurlheight
Semelhante a iiurlwidth.
- Tipo: inteiro
- Padrão: -1
- iimetadataversion
Versão de metadados a ser usada. Se for especificado o valor latest, usar a versão mais recente. Por omissão tem o valor 1 para compatibilidade com versões anteriores.
- Padrão: 1
- iiextmetadatalanguage
Em que língua obter extmetadata. Isto afeta tanto a tradução que será obtida, caso existam várias, como a formatação de números e vários outros valores.
- Padrão: pt
- iiextmetadatamultilang
Se estiverem disponíveis traduções para a propriedade extmetadata, obtê-las todas.
- Tipo: booliano (detalhes)
- iiextmetadatafilter
Se for especificado e não estiver vazio, só serão devolvidas estas chaves para iiprop=extmetadata.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- iiurlparam
Um parâmetro de texto específico do objeto. Por exemplo, ficheiros PDF podem usar page15-100px. iiurlwidth tem de ser usado e ser consistente com iiurlparam.
- Padrão: (vazio)
- iibadfilecontexttitle
Se badfilecontexttitleprop=badfile estiver definido, este é o título da página usado ao calcular a MediaWiki:Bad image list
- iicontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- iilocalonly
Procurar ficheiros só no repositório local.
- Tipo: booliano (detalhes)
- Obter informação sobre a versão atual do ficheiro File:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo [abrir na página de testes]
- Obter informação sobre as versões de File:Test.jpg desde 2008.
- api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url [abrir na página de testes]
prop=images (im)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todos os ficheiros contidos nas páginas indicadas.
- imlimit
O número de ficheiros a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- imcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- imimages
Listar só estes ficheiros. Útil para verificar se uma determinada página tem um determinado ficheiro.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- imdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter uma lista dos ficheiros usados na página Main Page.
- api.php?action=query&prop=images&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre todos os ficheiros usados na página Main Page.
- api.php?action=query&generator=images&titles=Main%20Page&prop=info [abrir na página de testes]
prop=info (in)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter a informação básica da página.
- inprop
As propriedades adicionais que devem ser obtidas:
- protection
- Listar o nível de proteção de cada página.
- talkid
- O identificador da página de discussão de cada página que não seja de discussão.
- watched
- Listar o estado de vigilância de cada página.
- watchers
- O número de vigilantes, se for permitido.
- visitingwatchers
- O número de vigilantes de cada página que visitaram edições recentes dessa página, se permitido.
- notificationtimestamp
- A data e hora das notificações de alterações de cada página vigiada.
- subjectid
- O identificador da página progenitora de cada página de discussão.
- url
- Fornece um URL completo, um URL de edição e o URL canónico, para cada página.
- readable
- Obsoleto. Indica se o utilizador pode ler esta página. Em vez deste parâmetro, use intestactions=read.
- preload
- Fornece o texto devolvido por EditFormPreloadText.
- displaytitle
- Fornece a forma como o título da página é apresentado.
- varianttitles
- Fornece o título de apresentação em todas as variantes da língua de conteúdo da wiki.
- Valores (separados com | ou alternativas): displaytitle, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
- intestactions
Testar se o utilizador pode realizar certas operações na página.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- intestactionsdetail
Nível de detalhe de intestactions. Use os parâmetros errorformat e errorlang do módulo principal para controlar o formato das mensagens devolvidas.
- boolean
- Devolver um valor booliano para cada ação.
- full
- Devolver mensagens que descrevem porque a ação não é permitida, ou uma matriz vazia se ela for permitida.
- quick
- Como full mas saltando verificações exigentes.
- Um dos seguintes valores: boolean, full, quick
- Padrão: boolean
- intoken
- Obsoleto.
Em substituição, usar action=query&meta=tokens.
- Valores (separados com | ou alternativas): block, delete, edit, email, import, move, protect, unblock, watch
- incontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter informações sobre a página Main Page.
- api.php?action=query&prop=info&titles=Main%20Page [abrir na página de testes]
- Obter informação geral e de proteção sobre a página Main Page.
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [abrir na página de testes]
prop=iwlinks (iw)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todas as hiperligações interwikis das páginas indicadas.
- iwprop
As propriedades adicionais que devem ser obtidas para cada hiperligação interlínguas:
- url
- Adiciona o URL completo.
- Valores (separados com | ou alternativas): url
- iwprefix
Devolver só as hiperligações interwikis com este prefixo.
- iwtitle
Hiperligação interwikis a ser procurada. Tem de ser usado em conjunto com iwprefix.
- iwdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- iwlimit
O número de hiperligações interwikis a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- iwcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- iwurl
- Obsoleto.
Indica se deve ser obtido o URL completo (não pode ser usado com iwprop).
- Tipo: booliano (detalhes)
- Obter as hiperligações interwikis da página Main Page.
- api.php?action=query&prop=iwlinks&titles=Main%20Page [abrir na página de testes]
prop=langlinks (ll)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todas as hiperligações interlínguas das páginas indicadas.
- llprop
As propriedades adicionais que devem ser obtidas para cada hiperligação interlínguas:
- url
- Adiciona o URL completo.
- langname
- Adiciona o nome da língua localizado (melhor esforço). Usar llinlanguagecode para controlar a língua.
- autonym
- Adiciona o nome nativo da língua.
- Valores (separados com | ou alternativas): autonym, langname, url
- lllang
Devolver só as hiperligações interlínguas com este código de língua.
- lltitle
A hiperligação a ser procurada. Tem de ser usado com lllang.
- lldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- llinlanguagecode
O código de língua para os nomes de língua localizados.
- Padrão: pt
- lllimit
O número de hiperligações interlínguas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- llcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- llurl
- Obsoleto.
Indica se deve ser obtido o URL completo (não pode ser usado com llprop).
- Tipo: booliano (detalhes)
- Obter as hiperligações interlínguas da página Main Page.
- api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [abrir na página de testes]
prop=links (pl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todas as hiperligações das páginas indicadas.
- plnamespace
Mostrar apenas as hiperligações destes espaços nominais.
- Valores (separados com | ou alternativas): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- pllimit
O número de hiperligações a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- plcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- pltitles
Listar só as hiperligações para estes títulos. Útil para verificar se uma determinada página contém hiperligações para um determinado título.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter as hiperligações da página Main Page.
- api.php?action=query&prop=links&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre as páginas ligadas na página Main Page.
- api.php?action=query&generator=links&titles=Main%20Page&prop=info [abrir na página de testes]
- Obter as hiperligações da página Main Page nos espaços nominais Utilizador e Predefinição.
- api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [abrir na página de testes]
prop=linkshere (lh)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- lhprop
As propriedades a serem obtidas:
- pageid
- O identificador de cada página.
- title
- O título de cada página.
- redirect
- Indicar se a página é um redirecionamento.
- Valores (separados com | ou alternativas): pageid, redirect, title
- Padrão: pageid|title|redirect
- lhnamespace
Incluir só as páginas nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- lhshow
Mostrar só as páginas que correspondem a estes critérios:
- redirect
- Mostrar só os redirecionamentos.
- !redirect
- Mostrar só os não redirecionamentos.
- Valores (separados com | ou alternativas): !redirect, redirect
- lhlimit
O número de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- lhcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter uma lista das páginas com hiperligações para a página Main Page.
- api.php?action=query&prop=linkshere&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre as páginas com hiperligações para a página Main Page.
- api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info [abrir na página de testes]
prop=pageprops (pp)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter várias propriedades de página definidas no conteúdo da página.
- ppcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- ppprop
Listar só estas propriedades de página (action=query&list=pagepropnames devolve os nomes das propriedades de página em uso). Útil para verificar se as páginas usam uma determinada propriedade de página.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Obter as propriedades das páginas Main Page e MediaWiki.
- api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [abrir na página de testes]
prop=redirects (rd)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todos os redirecionamentos para as páginas indicadas.
- rdprop
As propriedades a serem obtidas:
- pageid
- O identificador de página de cada redirecionamento.
- title
- O título de cada redirecionamento.
- fragment
- O fragmento de cada redirecionamento, se existir.
- Valores (separados com | ou alternativas): fragment, pageid, title
- Padrão: pageid|title
- rdnamespace
Incluir só as páginas destes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- rdshow
Mostrar só as páginas que correspondem a estes critérios:
- fragment
- Mostrar só os redirecionamentos com um fragmento.
- !fragment
- Mostrar só os redirecionamentos sem um fragmento.
- Valores (separados com | ou alternativas): !fragment, fragment
- rdlimit
O número de redirecionamentos a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- rdcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter uma lista dos redirecionamentos para a página Main Page.
- api.php?action=query&prop=redirects&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre todos os redirecionamentos para a página Main Page.
- api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [abrir na página de testes]
prop=revisions (rv)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informação da revisão.
Pode ser usado de várias maneiras:
- Obter dados sobre um conjunto de páginas (última revisão), definindo títulos ou identificadores de páginas.
- Obter as revisões de uma página indicada, usando títulos ou identificadores de páginas, com start, end ou limit.
- Obter dados sobre um conjunto de revisões definindo os respetivos identificadores de revisões.
- rvprop
As propriedades a serem obtidas para cada revisão:
- ids
- O identificador da revisão.
- flags
- As etiquetas da revisão (menor).
- timestamp
- A data e hora da revisão.
- user
- O utilizador que fez a revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- O identificador de utilizador do criador da revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- size
- O comprimento (em bytes) da revisão.
- slotsize
- O comprimento (em bytes) de cada segmento de revisão.
- sha1
- O resumo criptográfico SHA-1 (na base 16) da revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- slotsha1
- O resumo criptográfico SHA-1 (base 16) de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- contentmodel
- O identificador do modelo de conteúdo de cada segmento de revisão.
- comment
- O comentário do utilizador para a revisão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- O comentário do utilizador para a revisão, após a análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- content
- Conteúdo de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade textthidden.
- tags
- As etiquetas para a revisão.
- roles
- Listar as funções dos segmentos de conteúdo que existem na revisão.
- parsetree
- Obsoleto. Usar antes action=expandtemplates ou action=parse. A árvore XML da análise sintática do conteúdo da revisão
wikitext
.
- Valores (separados com | ou alternativas): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
- Padrão: ids|timestamp|flags|comment|user
- rvslots
Quais os segmentos de revisão cujos dados devem ser devolvidos quando propriedades relacionadas com segmentos são incluídas em rvprops. Se for omitido, serão devolvidos dados do segmento principal (main) num formato compatível com versões anteriores.
- Valores (separados com | ou alternativas): main
- Para especificar todos os valores, use *.
- rvlimit
Limitar o número de revisões que serão devolvidas.
- Só pode ser usado com uma única página (modo #2)
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- rvexpandtemplates
- Obsoleto.
Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer rvprop=content).
- Tipo: booliano (detalhes)
- rvgeneratexml
- Obsoleto.
Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer rvprop=content).
- Tipo: booliano (detalhes)
- rvparse
- Obsoleto.
Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer rvprop=content). Por motivos de desempenho, se esta opção for usada rvlimit é forçado a ser 1.
- Tipo: booliano (detalhes)
- rvsection
Obter apenas o conteúdo da secção que tem este número.
- rvdiffto
- Obsoleto.
Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).
- rvdifftotext
- Obsoleto.
Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre rvdiffto. Se rvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.
- rvdifftotextpst
- Obsoleto.
Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com rvdifftotext.
- Tipo: booliano (detalhes)
- rvcontentformat
- Obsoleto.
O formato de seriação usado para rvdifftotext e esperado para o conteúdo produzido.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- rvstartid
Iniciar a enumeração a partir da data e hora desta revisão. A revisão tem de existir, mas não precisa de pertencer a esta página.
- Só pode ser usado com uma única página (modo #2)
- Tipo: inteiro
- rvendid
Terminar a enumeração na data e hora desta revisão. A revisão tem de existir, mas não precisa de pertencer a esta página.
- Só pode ser usado com uma única página (modo #2)
- Tipo: inteiro
- rvstart
A data e hora da revisão a partir da qual será começada a enumeração.
- Só pode ser usado com uma única página (modo #2)
- Tipo: data e hora (formatos permitidos)
- rvend
A data e hora da revisão na qual será terminada a enumeração.
- Só pode ser usado com uma única página (modo #2)
- Tipo: data e hora (formatos permitidos)
- rvdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: rvstart tem de estar antes de rvend.
- older
- Listar o mais recente primeiro (padrão). Nota: rvstart tem de estar depois de rvend.
- Só pode ser usado com uma única página (modo #2)
- Um dos seguintes valores: newer, older
- Padrão: older
- rvuser
Incluir só as revisões deste utilizador.
- Só pode ser usado com uma única página (modo #2)
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- rvexcludeuser
Excluir as revisões deste utilizador.
- Só pode ser usado com uma única página (modo #2)
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- rvtag
Listar só as revisões marcadas com esta etiqueta.
- rvtoken
- Obsoleto.
Que chaves obter para cada revisão.
- Valores (separados com | ou alternativas): rollback
- rvcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter dados com o conteúdo da última revisão dos títulos API e Main Page.
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvslots=*&rvprop=timestamp|user|comment|content [abrir na página de testes]
- Obter as últimas 5 revisões da página Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [abrir na página de testes]
- Obter as primeiras 5 revisões da página Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [abrir na página de testes]
- Obter as primeiras 5 revisões da página Main Page feitas após 2006-05-01.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [abrir na página de testes]
- Obter as primeiras 5 revisões da página Main Page que não foram feitas pelo utilizador anónimo 127.0.0.1.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [abrir na página de testes]
- Obter as primeiras 5 revisões da página Main Page feitas pelo utilizador MediaWiki default.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [abrir na página de testes]
prop=stashimageinfo (sii)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve informações dos ficheiros escondidos.
- siifilekey
Chave que identifica um carregamento anterior que foi escondido temporariamente.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- siisessionkey
- Obsoleto.
Nome alternativo de siifilekey, para compatibilidade com versões anteriores.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- siiprop
As informações do ficheiro que devem ser obtidas:
- timestamp
- Adiciona a data e hora da versão carregada.
- canonicaltitle
- Adiciona o título canónico do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- url
- Devolve URL para o ficheiro e a página de descrição. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- size
- Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
- dimensions
- Nome alternativo para size.
- sha1
- Adiciona o resumo criptográfico SHA-1 do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- mime
- Adiciona o tipo MIME do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- thumbmime
- Adiciona o tipo MIME da miniatura (requer URL e o parâmetro siiurlwidth). Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- metadata
- Lista os metadados Exif para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- commonmetadata
- Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- extmetadata
- Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- bitdepth
- Adiciona a profundidade em bits da versão. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- badfile
- Indica se o ficheiro está na lista MediaWiki:Bad image list
- Valores (separados com | ou alternativas): badfile, bitdepth, canonicaltitle, commonmetadata, dimensions, extmetadata, metadata, mime, sha1, size, thumbmime, timestamp, url
- Padrão: timestamp|url
- siiurlwidth
Se siiprop=url está definido, será devolvido um URL para uma imagem redimensionada com este comprimento. Por razões de desempenho, se esta opção for usada não serão devolvidas mais de 50 imagens redimensionadas.
- Tipo: inteiro
- Padrão: -1
- siiurlheight
Semelhante a siiurlwidth.
- Tipo: inteiro
- Padrão: -1
- siiurlparam
Um parâmetro de texto específico do objeto. Por exemplo, ficheiros PDF podem usar page15-100px. siiurlwidth tem de ser usado e ser consistente com siiurlparam.
- Padrão: (vazio)
- Devolve informação sobre um ficheiro escondido.
- api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567 [abrir na página de testes]
- Devolve as miniaturas de dois ficheiros escondidos.
- api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url [abrir na página de testes]
prop=templates (tl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolve todas as páginas que são transcluídas nas páginas indicadas.
- tlnamespace
Mostrar só as predefinições nestes espaços nominais.
- Valores (separados com | ou alternativas): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- tllimit
O número de predefinições a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- tlcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- tltemplates
Listar só estas predefinições. Útil para verificar se uma determinada página contém uma determinada predefinição.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- tldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter as predefinições usadas na página Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre as páginas das predefinições usadas na página Main Page.
- api.php?action=query&generator=templates&titles=Main%20Page&prop=info [abrir na página de testes]
- Obter as páginas dos espaços nominais Utilizador e Predefinição que são transcluídas na página Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [abrir na página de testes]
prop=transcludedin (ti)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter todas as páginas que transcluem as páginas indicadas.
- tiprop
As propriedades a serem obtidas:
- pageid
- O identificador de cada página.
- title
- O título de cada página.
- redirect
- Indicar se a página é um redirecionamento.
- Valores (separados com | ou alternativas): pageid, redirect, title
- Padrão: pageid|title|redirect
- tinamespace
Incluir só as páginas nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- tishow
Mostrar só as entradas que correspondem a estes critérios:
- redirect
- Mostrar só os redirecionamentos.
- !redirect
- Mostrar só as que não são redirecionamentos.
- Valores (separados com | ou alternativas): !redirect, redirect
- tilimit
O número de entradas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- ticontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter uma lista das páginas que transcluem Main Page.
- api.php?action=query&prop=transcludedin&titles=Main%20Page [abrir na página de testes]
- Obter informação sobre as páginas que transcluem Main Page.
- api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [abrir na página de testes]
list=allcategories (ac)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar todas as categorias.
- acfrom
A categoria a partir da qual será começada a enumeração.
- accontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- acto
A categoria na qual será terminada a enumeração.
- acprefix
Procurar todos os títulos de categorias que começam por este valor.
- acdir
A direção da ordenação.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- acmin
Só devolver as categorias que tenham no mínimo este número de membros.
- Tipo: inteiro
- acmax
Só devolver as categorias que tenham no máximo este número de membros.
- Tipo: inteiro
- aclimit
O número de categorias a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- acprop
As propriedades a serem obtidas:
- size
- Adiciona o número de páginas na categoria.
- hidden
- Etiqueta as categorias ocultadas com
__HIDDENCAT__
.
- Valores (separados com | ou alternativas): hidden, size
- Padrão: (vazio)
- Lista as categorias com informação sobre o número de páginas em cada uma delas.
- api.php?action=query&list=allcategories&acprop=size [abrir na página de testes]
- Obter informação sobre a própria página de categoria, para as categorias que começam por List.
- api.php?action=query&generator=allcategories&gacprefix=List&prop=info [abrir na página de testes]
list=alldeletedrevisions (adr)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- adrprop
As propriedades a serem obtidas para cada revisão:
- ids
- O identificador da revisão.
- flags
- As etiquetas da revisão (menor).
- timestamp
- A data e hora da revisão.
- user
- O utilizador que fez a revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- O identificador de utilizador do criador da revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- size
- O comprimento (em bytes) da revisão.
- slotsize
- O comprimento (em bytes) de cada segmento de revisão.
- sha1
- O resumo criptográfico SHA-1 (na base 16) da revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- slotsha1
- O resumo criptográfico SHA-1 (base 16) de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- contentmodel
- O identificador do modelo de conteúdo de cada segmento de revisão.
- comment
- O comentário do utilizador para a revisão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- O comentário do utilizador para a revisão, após a análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- content
- Conteúdo de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade textthidden.
- tags
- As etiquetas para a revisão.
- roles
- Listar as funções dos segmentos de conteúdo que existem na revisão.
- parsetree
- Obsoleto. Usar antes action=expandtemplates ou action=parse. A árvore XML da análise sintática do conteúdo da revisão
wikitext
.
- Valores (separados com | ou alternativas): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
- Padrão: ids|timestamp|flags|comment|user
- adrslots
Quais os segmentos de revisão cujos dados devem ser devolvidos quando propriedades relacionadas com segmentos são incluídas em adrprops. Se for omitido, serão devolvidos dados do segmento principal (main) num formato compatível com versões anteriores.
- Valores (separados com | ou alternativas): main
- Para especificar todos os valores, use *.
- adrlimit
Limitar o número de revisões que serão devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- adrexpandtemplates
- Obsoleto.
Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer adrprop=content).
- Tipo: booliano (detalhes)
- adrgeneratexml
- Obsoleto.
Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer adrprop=content).
- Tipo: booliano (detalhes)
- adrparse
- Obsoleto.
Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer adrprop=content). Por motivos de desempenho, se esta opção for usada adrlimit é forçado a ser 1.
- Tipo: booliano (detalhes)
- adrsection
Obter apenas o conteúdo da secção que tem este número.
- adrdiffto
- Obsoleto.
Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).
- adrdifftotext
- Obsoleto.
Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre adrdiffto. Se adrsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.
- adrdifftotextpst
- Obsoleto.
Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com adrdifftotext.
- Tipo: booliano (detalhes)
- adrcontentformat
- Obsoleto.
O formato de seriação usado para adrdifftotext e esperado para o conteúdo produzido.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- adruser
Listar só as revisões feitas por este utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- adrnamespace
Listar só as páginas neste espaço nominal.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- adrstart
A data e hora da revisão a partir da qual será começada a enumeração.
- Só pode ser usado com adruser.
- Tipo: data e hora (formatos permitidos)
- adrend
A data e hora na qual será terminada a enumeração.
- Só pode ser usado com adruser.
- Tipo: data e hora (formatos permitidos)
- adrdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: adrstart tem de estar antes de adrend.
- older
- Listar o mais recente primeiro (padrão). Nota: adrstart tem de estar depois de adrend.
- Um dos seguintes valores: newer, older
- Padrão: older
- adrfrom
Começar a listagem neste título.
- Não pode ser usado com adruser.
- adrto
Terminar a listagem neste título.
- Não pode ser usado com adruser.
- adrprefix
Procurar todos os títulos de página que começam por este valor.
- Não pode ser usado com adruser.
- adrexcludeuser
Não listar as revisões feitas por este utilizador.
- Não pode ser usado com adruser.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- adrtag
Listar só as revisões marcadas com esta etiqueta.
- adrcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- adrgeneratetitles
Ao ser usado como gerador, gerar títulos em vez de identificadores de revisões.
- Tipo: booliano (detalhes)
- Listar as últimas 50 contribuições eliminadas do utilizador Example.
- api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [abrir na página de testes]
- Listar as primeiras 50 revisões eliminadas no espaço nominal principal.
- api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [abrir na página de testes]
list=allfileusages (af)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- afcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- affrom
O título do ficheiro a partir do qual será começada a enumeração.
- afto
O título do ficheiro no qual será terminada a enumeração.
- afprefix
Procurar todos os títulos de ficheiro que começam por este valor.
- afunique
Mostrar só nomes de ficheiro únicos. Não pode ser usado com afprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.
- Tipo: booliano (detalhes)
- afprop
As informações que devem ser incluídas:
- ids
- Adiciona os identificadores das páginas que utilizam (não pode ser usado com afunique).
- title
- Adiciona o título do ficheiro.
- Valores (separados com | ou alternativas): ids, title
- Padrão: title
- aflimit
O número total de elementos a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- afdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Listar os títulos de ficheiros, incluindo aqueles em falta, com os identificadores das páginas de onde provêm, começando no B.
- api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [abrir na página de testes]
- Listar os títulos de ficheiro únicos.
- api.php?action=query&list=allfileusages&afunique=&affrom=B [abrir na página de testes]
- Obtém todos os títulos de ficheiros, marcando aqueles em falta.
- api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [abrir na página de testes]
- Obtém as páginas que contêm os ficheiros.
- api.php?action=query&generator=allfileusages&gaffrom=B [abrir na página de testes]
list=allimages (ai)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar todas as imagens sequencialmente.
- aisort
Propriedade pela qual fazer a ordenação.
- Um dos seguintes valores: name, timestamp
- Padrão: name
- aidir
A direção de listagem.
- Um dos seguintes valores: ascending, descending, newer, older
- Padrão: ascending
- aifrom
O título da imagem a partir do qual será começada a enumeração. Só pode ser usado com aisort=name.
- aito
O título da imagem no qual será terminada a enumeração. Só pode ser usado com aisort=name.
- aicontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- aistart
A data e hora da imagem a partir da qual será começada a enumeração. Só pode ser usado com aisort=timestamp.
- Tipo: data e hora (formatos permitidos)
- aiend
A data e hora da imagem na qual será terminada a enumeração. Só pode ser usado com aisort=timestamp.
- Tipo: data e hora (formatos permitidos)
- aiprop
As informações do ficheiro que devem ser obtidas:
- timestamp
- Adiciona a data e hora da versão carregada.
- user
- Adiciona o utilizador que carregou cada versão do ficheiro. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- Adiciona o identificador do utilizador que carregou cada versão do ficheiro. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- comment
- O comentário da versão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- Fazer a análise sintática do comentário da versão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- canonicaltitle
- Adiciona o título canónico do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- url
- Devolve URL para o ficheiro e a página de descrição. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- size
- Adiciona o tamanho do ficheiro em bytes e a altura, largura e contagem de páginas (se aplicável).
- dimensions
- Nome alternativo para size.
- sha1
- Adiciona o resumo criptográfico SHA-1 do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- mime
- Adiciona o tipo MIME do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- mediatype
- Adiciona o tipo de multimédia do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- metadata
- Lista os metadados Exif para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- commonmetadata
- Lista os metadados genéricos do formato de ficheiro para a versão do ficheiro. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- extmetadata
- Lista os metadados formatados, combinados de várias fontes. Os resultados estão no formato HTML. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- bitdepth
- Adiciona a profundidade em bits da versão. Se o ficheiro é de uma revisão suprimida, será devolvida uma propriedade filehidden.
- badfile
- Indica se o ficheiro está na lista MediaWiki:Bad image list
- Valores (separados com | ou alternativas): badfile, bitdepth, canonicaltitle, comment, commonmetadata, dimensions, extmetadata, mediatype, metadata, mime, parsedcomment, sha1, size, timestamp, url, user, userid
- Padrão: timestamp|url
- aiprefix
Procurar todos os títulos de imagem que começam por este valor. Só pode ser usado com aisort=name.
- aiminsize
Limitar só às imagens com este número mínimo de bytes.
- Tipo: inteiro
- aimaxsize
Limitar só às imagens com este número máximo de bytes.
- Tipo: inteiro
- aisha1
Resumo criptográfico SHA1 da imagem. Tem precedência sobre aisha1base36.
- aisha1base36
Resumo criptográfico SHA1 da imagem em base 36 (usado no MediaWiki).
- aiuser
Devolver só os ficheiros carregados por este utilizador. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aifilterbots.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- aifilterbots
Como filtrar os ficheiros carregados por robôs. Só pode ser usado com aisort=timestamp. Não pode ser usado em conjunto com aiuser.
- Um dos seguintes valores: all, bots, nobots
- Padrão: all
- aimime
Tipos MIME a procurar; por exemplo, image/jpeg.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- ailimit
O número total de imagens a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- Mostrar uma lista dos ficheiros que começam com a letra B.
- api.php?action=query&list=allimages&aifrom=B [abrir na página de testes]
- Mostrar uma lista dos ficheiros carregados recentemente, semelhante a Special:NewFiles.
- api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [abrir na página de testes]
- Mostrar uma lista dos ficheiros com os tipos MIME image/png ou image/gif.
- api.php?action=query&list=allimages&aimime=image/png|image/gif [abrir na página de testes]
- Mostrar informação sobre 4 ficheiros, começando pela letra T.
- api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [abrir na página de testes]
list=alllinks (al)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- alcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- alfrom
O título da hiperligação a partir da qual será começada a enumeração.
- alto
O título da hiperligação na qual será terminada a enumeração.
- alprefix
Procurar todos os títulos ligados que começam por este valor.
- alunique
Mostrar só títulos ligados únicos. Não pode ser usado com alprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.
- Tipo: booliano (detalhes)
- alprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página que contém a hiperligação (não pode ser usado com alunique).
- title
- Adiciona o título da hiperligação.
- Valores (separados com | ou alternativas): ids, title
- Padrão: title
- alnamespace
O espaço nominal a ser enumerado.
- Um dos seguintes valores: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Padrão: 0
- allimit
O número total de entradas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- aldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Listar os títulos para os quais existem ligações, incluindo títulos em falta, com os identificadores das páginas que contêm as respetivas ligações, começando pela letra B.
- api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [abrir na página de testes]
- Listar os títulos únicos para os quais existem hiperligações.
- api.php?action=query&list=alllinks&alunique=&alfrom=B [abrir na página de testes]
- Obtém todos os títulos para os quais existem hiperligações, marcando aqueles em falta.
- api.php?action=query&generator=alllinks&galunique=&galfrom=B [abrir na página de testes]
- Obtém as páginas que contêm as hiperligações.
- api.php?action=query&generator=alllinks&galfrom=B [abrir na página de testes]
list=allpages (ap)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- apfrom
O título de página a partir do qual será começada a enumeração.
- apcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- apto
O título de página no qual será terminada a enumeração.
- apprefix
Procurar todos os títulos de páginas que comecem com este valor.
- apnamespace
O espaço nominal a ser enumerado.
- Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Padrão: 0
- apfilterredir
As páginas a serem listadas.
- Um dos seguintes valores: all, nonredirects, redirects
- Padrão: all
- apminsize
Limitar só às páginas com este número mínimo de bytes.
- Tipo: inteiro
- apmaxsize
Limitar só às páginas com este número máximo de bytes.
- Tipo: inteiro
- apprtype
Limitar só às páginas protegidas.
- Valores (separados com | ou alternativas): edit, move, upload
- apprlevel
Filtrar as proteções com base no nível de proteção (tem de ser usado com o parâmetro apprtype=).
- Valores (separados com | ou alternativas): Can be empty, or autoconfirmed, sysop
- apprfiltercascade
Filtrar as proteções com base na proteção em cascata (ignorado se apprtype não estiver presente).
- Um dos seguintes valores: all, cascading, noncascading
- Padrão: all
- aplimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- apdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- apfilterlanglinks
Filtrar dependo de uma página conter hiperligações interlínguas. Note que isto pode não ter em consideração hiperligações interlínguas adicionadas por extensões.
- Um dos seguintes valores: all, withlanglinks, withoutlanglinks
- Padrão: all
- apprexpiry
O tipo de expiração pelo qual as páginas serão filtradas:
- indefinite
- Obter só páginas com um período de expiração indefinido.
- definite
- Obter só páginas com um período de expiração definido (específico).
- all
- Obter páginas com qualquer período de expiração.
- Um dos seguintes valores: all, definite, indefinite
- Padrão: all
- Mostrar uma lista de páginas, começando na letra B.
- api.php?action=query&list=allpages&apfrom=B [abrir na página de testes]
- Mostrar informação sobre 4 páginas, começando na letra T.
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [abrir na página de testes]
- Mostrar o conteúdo das primeiras 2 páginas que não sejam redirecionamentos, começando na página Re.
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [abrir na página de testes]
list=allredirects (ar)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todos os redirecionamentos para um espaço nominal.
- arcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- arfrom
O título do redirecionamento a partir do qual será começada a enumeração.
- arto
O título do redirecionamento no qual será terminada a enumeração.
- arprefix
Procurar todas as páginas de destino que começam por este valor.
- arunique
Mostrar só páginas de destino únicas. Não pode ser usado com arprop=ids|fragment|interwiki. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.
- Tipo: booliano (detalhes)
- arprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página que contém o redirecionamento (não pode ser usado com arunique).
- title
- Adiciona o título do redirecionamento.
- fragment
- Adiciona o fragmento do redirecionamento, se existir (não pode ser usado com arunique).
- interwiki
- Adiciona o prefixo interwikis do redirecionamento, se existir (não pode ser usado em conjunto com arunique).
- Valores (separados com | ou alternativas): fragment, ids, interwiki, title
- Padrão: title
- arnamespace
O espaço nominal a ser enumerado.
- Um dos seguintes valores: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Padrão: 0
- arlimit
O número total de elementos a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- ardir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Listar as páginas de destino, incluindo aquelas em falta, com os identificadores da página de origem, começando na B.
- api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [abrir na página de testes]
- Listar as páginas de destino únicas.
- api.php?action=query&list=allredirects&arunique=&arfrom=B [abrir na página de testes]
- Obtém todas as páginas de destino, marcando aquelas em falta.
- api.php?action=query&generator=allredirects&garunique=&garfrom=B [abrir na página de testes]
- Obtém as páginas que contêm os redirecionamentos.
- api.php?action=query&generator=allredirects&garfrom=B [abrir na página de testes]
list=allrevisions (arv)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as revisões.
- arvprop
As propriedades a serem obtidas para cada revisão:
- ids
- O identificador da revisão.
- flags
- As etiquetas da revisão (menor).
- timestamp
- A data e hora da revisão.
- user
- O utilizador que fez a revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- O identificador de utilizador do criador da revisão. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- size
- O comprimento (em bytes) da revisão.
- slotsize
- O comprimento (em bytes) de cada segmento de revisão.
- sha1
- O resumo criptográfico SHA-1 (na base 16) da revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- slotsha1
- O resumo criptográfico SHA-1 (base 16) de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- contentmodel
- O identificador do modelo de conteúdo de cada segmento de revisão.
- comment
- O comentário do utilizador para a revisão. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- O comentário do utilizador para a revisão, após a análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- content
- Conteúdo de cada segmento de revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade textthidden.
- tags
- As etiquetas para a revisão.
- roles
- Listar as funções dos segmentos de conteúdo que existem na revisão.
- parsetree
- Obsoleto. Usar antes action=expandtemplates ou action=parse. A árvore XML da análise sintática do conteúdo da revisão
wikitext
.
- Valores (separados com | ou alternativas): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
- Padrão: ids|timestamp|flags|comment|user
- arvslots
Quais os segmentos de revisão cujos dados devem ser devolvidos quando propriedades relacionadas com segmentos são incluídas em arvprops. Se for omitido, serão devolvidos dados do segmento principal (main) num formato compatível com versões anteriores.
- Valores (separados com | ou alternativas): main
- Para especificar todos os valores, use *.
- arvlimit
Limitar o número de revisões que serão devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- arvexpandtemplates
- Obsoleto.
Em substituição, use action=expandtemplates. Expandir predefinições no conteúdo da revisão (requer arvprop=content).
- Tipo: booliano (detalhes)
- arvgeneratexml
- Obsoleto.
Em substituição, use action=expandtemplates ou action=parse. Gerar a árvore de análise sintática em XML do conteúdo da revisão (requer arvprop=content).
- Tipo: booliano (detalhes)
- arvparse
- Obsoleto.
Em substituição, use action=parse. Fazer a análise sintática do conteúdo da revisão (requer arvprop=content). Por motivos de desempenho, se esta opção for usada arvlimit é forçado a ser 1.
- Tipo: booliano (detalhes)
- arvsection
Obter apenas o conteúdo da secção que tem este número.
- arvdiffto
- Obsoleto.
Em substituição, use action=compare. O identificador da revisão contra a qual será tirada uma lista de diferenças de cada revisão. Usar prev (anterior), next (seguinte) e cur (atual).
- arvdifftotext
- Obsoleto.
Em substituição, use action=compare. O texto contra o qual será tirada uma lista de diferenças de cada revisão. Só produz as diferenças para um número limitado de revisões. Tem precedência sobre arvdiffto. Se arvsection estiver definido, só o conteúdo dessa secção será comparado contra o texto.
- arvdifftotextpst
- Obsoleto.
Em substituição, use action=compare. Fazer uma transformação anterior à gravação do texto, antes de calcular as diferenças. Só é válido quando usado com arvdifftotext.
- Tipo: booliano (detalhes)
- arvcontentformat
- Obsoleto.
O formato de seriação usado para arvdifftotext e esperado para o conteúdo produzido.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- arvuser
Listar só as revisões deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- arvnamespace
Listar só as páginas neste espaço nominal.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- arvstart
A data e hora a partir da qual será começada a enumeração.
- Tipo: data e hora (formatos permitidos)
- arvend
A data e hora na qual será terminada a enumeração.
- Tipo: data e hora (formatos permitidos)
- arvdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: arvstart tem de estar antes de arvend.
- older
- Listar o mais recente primeiro (padrão). Nota: arvstart tem de estar depois de arvend.
- Um dos seguintes valores: newer, older
- Padrão: older
- arvexcludeuser
Não listar as revisões deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- arvcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- arvgeneratetitles
Ao ser usado como gerador, gerar títulos em vez de identificadores de revisões.
- Tipo: booliano (detalhes)
- Listar as últimas 50 contribuições do utilizador Example.
- api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [abrir na página de testes]
- Listar as primeiras 50 revisões em todos os espaços nominais.
- api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [abrir na página de testes]
list=alltransclusions (at)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- atcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- atfrom
O título da transclusão a partir do qual será começada a enumeração.
- atto
O título da transclusão no qual será terminada a enumeração.
- atprefix
Procurar todos os títulos transcluídos que começam por este valor.
- atunique
Mostrar só títulos transcluídos únicos. Não pode ser usado com atprop=ids. Ao ser usado como gerador, produz páginas de destino em vez de páginas de origem.
- Tipo: booliano (detalhes)
- atprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página onde é feita a transclusão (não pode ser usado com atunique).
- title
- Adiciona o título da transclusão.
- Valores (separados com | ou alternativas): ids, title
- Padrão: title
- atnamespace
O espaço nominal a enumerar.
- Um dos seguintes valores: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Padrão: 10
- atlimit
O número total de elementos a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- atdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Listar os títulos transcluídos, incluindo aqueles em falta, com os identificadores das páginas de origem, começando no B.
- api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [abrir na página de testes]
- Listar os títulos transcluídos únicos.
- api.php?action=query&list=alltransclusions&atunique=&atfrom=B [abrir na página de testes]
- Obtém todos os títulos transcluídos, marcando aqueles em falta.
- api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [abrir na página de testes]
- Obtém as páginas que contêm as transclusões.
- api.php?action=query&generator=alltransclusions&gatfrom=B [abrir na página de testes]
list=allusers (au)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar todos os utilizadores registados.
- aufrom
O nome de utilizador a partir do qual será começada a enumeração.
- auto
O nome de utilizador no qual será terminada a enumeração.
- auprefix
Procurar todos os nomes de utilizador que começam por este valor.
- audir
A direção da ordenação.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- augroup
Incluir só os utilizadores nos grupos indicados.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- auexcludegroup
Excluir os utilizadores nos grupos indicados.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- aurights
Incluir só os utilizadores com as permissões indicadas. Não inclui as permissões atribuídas por grupos implícitos ou de promoção automática como *, utilizador, ou autoconfirmado.
- Valores (separados com | ou alternativas): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, confirmaccount, confirmaccount-notify, createaccount, createpage, createtalk, delete, deletebatch, deletebatch-spoof, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, hideuser, import, importupload, ipblock-exempt, lookupcredentials, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, requestips, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, skipcaptcha, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, usermerge, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- auprop
As informações que devem ser incluídas:
- blockinfo
- Adiciona a informação sobre um bloqueio atual do utilizador.
- groups
- Lista os grupos a que o utilizador pertence. Isto usa mais recursos do servidor e pode devolver menos resultados do que o limite.
- implicitgroups
- Lista todos os grupos a que o utilizador pertence de forma automática.
- rights
- Lista as permissões que o utilizador tem.
- editcount
- Adiciona a contagem de edições do utilizador.
- registration
- Adiciona a data e hora de registo do utilizador, se estiver disponível (pode estar vazia).
- centralids
- Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
- Valores (separados com | ou alternativas): blockinfo, centralids, editcount, groups, implicitgroups, registration, rights
- aulimit
O número total de nomes de utilizador a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- auwitheditsonly
Listar só os utilizadores que realizaram edições.
- Tipo: booliano (detalhes)
- auactiveusers
Listar só os utilizadores ativos nos últimos 30 dias.
- Tipo: booliano (detalhes)
- auattachedwiki
Com auprop=centralids, indicar também se o utilizador tem ligação com a wiki designada por este identificador.
- Listar utilizadores, começando pelo Y.
- api.php?action=query&list=allusers&aufrom=Y [abrir na página de testes]
list=backlinks (bl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que contêm hiperligações para a página indicada.
- bltitle
O título a ser procurado. Não pode ser usado em conjunto com blpageid.
- blpageid
O identificador do título a ser procurado. Não pode ser usado em conjunto com bltitle.
- Tipo: inteiro
- blcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- blnamespace
O espaço nominal a ser enumerado.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- bldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- blfilterredir
Como filtrar os redirecionamentos. Se definido como nonredirects quando blredirect está ativado, isto só é aplicado ao segundo nível.
- Um dos seguintes valores: all, nonredirects, redirects
- Padrão: all
- bllimit
O número total de páginas a serem devolvidas. Se blredirect estiver ativado, o limite aplica-se a cada nível em separado (o que significa que até 2 * bllimit resultados podem ser devolvidos).
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- blredirect
Se a página que contém a hiperligação é um redirecionamento, procurar também todas as páginas que contêm hiperligações para esse redirecionamento. O limite máximo é reduzido para metade.
- Tipo: booliano (detalhes)
- Mostrar as hiperligações para Main page.
- api.php?action=query&list=backlinks&bltitle=Main%20Page [abrir na página de testes]
- Obter informações sobre as páginas com hiperligações para Main page.
- api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [abrir na página de testes]
list=blocks (bk)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todos os utilizadores e endereços IP bloqueados.
- bkstart
A data e hora a partir da qual será começada a enumeração.
- Tipo: data e hora (formatos permitidos)
- bkend
A data e hora na qual será terminada a enumeração.
- Tipo: data e hora (formatos permitidos)
- bkdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: bkstart tem de estar antes de bkend.
- older
- Listar o mais recente primeiro (padrão). Nota: bkstart tem de estar depois de bkend.
- Um dos seguintes valores: newer, older
- Padrão: older
- bkids
Lista dos identificadores de bloqueios a serem listados (opcional).
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- bkusers
Lista dos utilizadores a serem procurados (opcional).
- Tipo: lista de utilizadores, por um de entre nome de utilizador, IP e gama de endereços IP
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- bkip
Obter todos os bloqueios aplicáveis a este endereço IP ou intervalo CIDR, incluindo bloqueios de intervalos. Não pode ser usado em conjunto com bkusers. Não são aceites intervalos CIDR maiores que IPv4/16 ou IPv6/19.
- bklimit
O número máximo de bloqueios a listar.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- bkprop
As propriedades a serem obtidas:
- id
- Adiciona o identificador do bloqueio.
- user
- Adiciona o nome do utilizador bloqueado.
- userid
- Adiciona o identificador do utilizador bloqueado.
- by
- Adiciona o nome do utilizador que fez o bloqueio.
- byid
- Adiciona o identificador do utilizador que fez o bloqueio.
- timestamp
- Adiciona a data e hora de realização do bloqueio.
- expiry
- Adiciona a data e hora de expiração do bloqueio.
- reason
- Adiciona o motivo apresentado para o bloqueio.
- range
- Adiciona o intervalo de endereços IP afetado pelo bloqueio.
- flags
- Etiqueta o bloqueio com (autoblock, anononly, etc.).
- restrictions
- Adiciona as restrições parciais do bloqueio se este não for para todo o site.
- Valores (separados com | ou alternativas): by, byid, expiry, flags, id, range, reason, restrictions, timestamp, user, userid
- Padrão: id|user|by|timestamp|expiry|reason|flags
- bkshow
Mostrar só os bloqueios que preenchem estes critérios. Por exemplo, para ver só bloqueios indefinidos de endereços IP, defina bkshow=ip|!temp.
- Valores (separados com | ou alternativas): !account, !ip, !range, !temp, account, ip, range, temp
- bkcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Listar bloqueios.
- api.php?action=query&list=blocks [abrir na página de testes]
- Listar os bloqueios dos utilizadores Alice e Bob.
- api.php?action=query&list=blocks&bkusers=Alice|Bob [abrir na página de testes]
list=categorymembers (cm)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as páginas numa categoria específica.
- cmtitle
A categoria que será enumerada (obrigatório). Tem de incluir o prefixo Categoria:. Não pode ser usado em conjunto com cmpageid.
- cmpageid
Identificador da categoria a ser enumerada. Não pode ser usado em conjunto com cmtitle.
- Tipo: inteiro
- cmprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página.
- title
- Adiciona o título e o identificador do espaço nominal da página.
- sortkey
- Adiciona a chave usada para a ordenação da categoria (string hexadecimal).
- sortkeyprefix
- Adiciona o prefixo da chave usada para a ordenação da categoria (parte legível da chave de ordenação).
- type
- Adiciona o tipo com que a página foi categorizada (page, subcat ou file).
- timestamp
- Adiciona a data e hora de inclusão da página.
- Valores (separados com | ou alternativas): ids, sortkey, sortkeyprefix, timestamp, title, type
- Padrão: ids|title
- cmnamespace
Incluir só as páginas destes espaços nominais. Note que pode usar cmtype=subcat ou cmtype=file em vez de cmnamespace=14 ou 6.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- cmtype
O tipo de membros de categoria que devem ser incluídos. Ignorado se cmsort=timestamp estiver definido.
- Valores (separados com | ou alternativas): file, page, subcat
- Padrão: page|subcat|file
- cmcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- cmlimit
O número máximo de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- cmsort
Propriedade pela qual fazer a ordenação.
- Um dos seguintes valores: sortkey, timestamp
- Padrão: sortkey
- cmdir
A direção da ordenação.
- Um dos seguintes valores: asc, ascending, desc, descending, newer, older
- Padrão: ascending
- cmstart
A data e hora da página a partir da qual será começada a listagem. Só pode ser usado em conjunto com cmsort=timestamp.
- Tipo: data e hora (formatos permitidos)
- cmend
A data e hora da página na qual será terminada a listagem. Só pode ser usado em conjunto com cmsort=timestamp.
- Tipo: data e hora (formatos permitidos)
- cmstarthexsortkey
A chave de ordenação a partir da qual a listagem será começada, como devolvida por cmprop=sortkey. Só pode ser usado com cmsort=sortkey.
- cmendhexsortkey
A chave de ordenação na qual a listagem será terminada, como devolvida por cmprop=sortkey. só pode ser usado com cmsort=sortkey.
- cmstartsortkeyprefix
O prefixo da chave de ordenação a partir do qual a listagem será começada. Só pode ser usado com cmsort=sortkey. Tem precedência sobre cmstarthexsortkey.
- cmendsortkeyprefix
O prefixo da chave de ordenação antes do qual a listagem será terminada (não no qual; se este valor ocorrer não será incluído!). Só pode ser usado com cmsort=sortkey. Tem precedência sobre cmstarthexsortkey.
- cmstartsortkey
- Obsoleto.
Em vez dele, usar cmstarthexsortkey.
- cmendsortkey
- Obsoleto.
Em vez dele, usar cmendhexsortkey.
- Obter as primeiras 10 páginas na categoria Category:Physics.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [abrir na página de testes]
- Obter informações sobre as primeiras 10 páginas na categoria Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [abrir na página de testes]
list=deletedrevs (dr)
- Este módulo foi descontinuado.
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar as revisões eliminadas.
Opera em três modos:
- Listar as revisões eliminadas dos títulos indicados, ordenadas por data e hora.
- Listar as contribuições eliminadas do utilizador indicado, ordenadas por data e hora (sem especificar títulos).
- Listar todas as revisões eliminadas no espaço nominal indicado, ordenadas por título e por data e hora (sem especificar títulos, sem definir druser).
Alguns parâmetros só se aplicam a alguns modos e são ignorados noutros.
- drstart
A data e hora da revisão a partir da qual será começada a enumeração.
- Modos: 1, 2
- Tipo: data e hora (formatos permitidos)
- drend
A data e hora da revisão na qual será terminada a enumeração.
- Modos: 1, 2
- Tipo: data e hora (formatos permitidos)
- drdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: drstart tem de estar antes de drend.
- older
- Listar o mais recente primeiro (padrão). Nota: drstart tem de estar depois de drend.
- Modos: 1, 3
- Um dos seguintes valores: newer, older
- Padrão: older
- drfrom
Começar a listagem neste título.
- Modo: 3
- drto
Terminar a listagem neste título.
- Modo: 3
- drprefix
Procurar todos os títulos de página que começam por este valor.
- Modo: 3
- drunique
Listar só uma revisão para cada página.
- Modo: 3
- Tipo: booliano (detalhes)
- drnamespace
Listar só as páginas deste espaço nominal/domínio.
- Modo: 3
- Um dos seguintes valores: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Padrão: 0
- drtag
Listar só as revisões marcadas com esta etiqueta.
- druser
Listar só as revisões deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- drexcludeuser
Não listar edições deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- drprop
As propriedades a serem obtidas:
- revid
- Adiciona o identificador da revisão eliminada.
- parentid
- Adiciona o identificador da revisão anterior da página.
- user
- Adiciona o utilizador que fez a revisão.
- userid
- Adiciona o identificador do utilizador que fez a revisão.
- comment
- Adiciona o comentário da revisão.
- parsedcomment
- Adiciona o comentário da revisão após passagem pelo analisador sintático.
- minor
- Etiqueta a revisão como uma revisão menor.
- len
- Adiciona o comprimento (em bytes) da revisão.
- sha1
- Adiciona o SHA-1 da revisão (na base 16).
- content
- Adiciona o conteúdo da revisão.
- token
- Obsoleto. Fornece a chave da edição.
- tags
- Etiquetas da revisão.
- Valores (separados com | ou alternativas): comment, content, len, minor, parentid, parsedcomment, revid, sha1, tags, token, user, userid
- Padrão: user|comment
- drlimit
O número máximo de revisões a serem listadas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- drcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Listar só as últimas revisões eliminadas das páginas Main Page e Talk:Main Page, com o conteúdo (modo 1).
- api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [abrir na página de testes]
- Listar as últimas 50 contribuições eliminadas do utilizador Bob (modo 2).
- api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [abrir na página de testes]
- Listar as primeiras 50 revisões eliminadas no espaço nominal principal (modo 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [abrir na página de testes]
- Listar as primeiras 50 páginas eliminadas no espaço nominal Discussão (modo 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [abrir na página de testes]
list=embeddedin (ei)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- eititle
O título a procurar. Não pode ser usado em conjunto com eipageid.
- eipageid
O identificador da página a procurar. Não pode ser usado em conjunto com eititle.
- Tipo: inteiro
- eicontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- einamespace
O espaço nominal a ser enumerado.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- eidir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- eifilterredir
Como filtrar os redirecionamentos.
- Um dos seguintes valores: all, nonredirects, redirects
- Padrão: all
- eilimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- Mostrar as páginas que transcluem Template:Stub.
- api.php?action=query&list=embeddedin&eititle=Template:Stub [abrir na página de testes]
- Obter informação sobre as páginas que transcluem Template:Stub.
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [abrir na página de testes]
list=exturlusage (eu)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar as páginas que contêm um determinado URL.
- euprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página.
- title
- Adiciona o título e o identificador do espaço nominal da página.
- url
- Adiciona o URL usado na página.
- Valores (separados com | ou alternativas): ids, title, url
- Padrão: ids|title|url
- eucontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- euprotocol
Protocolo do URL. Se vazio e euquery está definido, o protocolo é http. Deixe este parâmetro e euquery vazios para listar todas as hiperligações externas.
- Um dos seguintes valores: Can be empty, or bitcoin, ftp, ftps, geo, git, gopher, http, https, irc, ircs, magnet, mailto, mms, news, nntp, redis, sftp, sip, sips, sms, ssh, svn, tel, telnet, urn, worldwind, xmpp
- Padrão: (vazio)
- euquery
Texto da pesquisa sem um protocolo. Ver Special:LinkSearch. Deixar vazio para listar todas as hiperligações externas.
- eunamespace
Os espaços nominais a serem enumerados.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- eulimit
O número de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- euexpandurl
Expandir os URL relativos a protocolo com o protocolo canónico.
- Tipo: booliano (detalhes)
- Mostrar as páginas com hiperligações para https://www.mediawiki.org.
- api.php?action=query&list=exturlusage&euquery=www.mediawiki.org [abrir na página de testes]
list=filearchive (fa)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar todos os ficheiros eliminados sequencialmente.
- fafrom
O título da imagem a partir do qual será começada a enumeração.
- fato
O título da imagem no qual será terminada a enumeração.
- faprefix
Procurar todos os títulos de imagem que começam por este valor.
- fadir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- fasha1
O resumo criptográfico SHA-1 da imagem. Tem precedência sobre fasha1base36.
- fasha1base36
O resumo criptográfico da imagem na base 36 (usado no MediaWiki).
- faprop
As informações da imagem que devem ser obtidas:
- sha1
- Adiciona o resumo criptográfico SHA-1 da imagem.
- timestamp
- Adiciona a data e hora da versão carregada.
- user
- Adiciona o utilizador que carregou a versão da imagem.
- size
- Adiciona o tamanho da imagem em bytes e a altura, largura e contagem de páginas (se aplicável).
- dimensions
- Nome alternativo para size.
- description
- Adiciona a descrição da versão da imagem.
- parseddescription
- Fazer a análise sintática da descrição da versão.
- mime
- Adiciona o tipo MIME da imagem.
- mediatype
- Adiciona o tipo de multimédia da imagem.
- metadata
- Lista os metadados Exif para a versão da imagem.
- bitdepth
- Adiciona a profundidade em bits da versão.
- archivename
- Adiciona o nome de ficheiro da versão arquivada das versões anteriores à última.
- Valores (separados com | ou alternativas): archivename, bitdepth, description, dimensions, mediatype, metadata, mime, parseddescription, sha1, size, timestamp, user
- Padrão: timestamp
- falimit
O número total de imagens a devolver.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- facontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Mostrar uma lista de todos os ficheiros eliminados.
- api.php?action=query&list=filearchive [abrir na página de testes]
list=imageusage (iu)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que utilizam o título da imagem indicada.
- iutitle
O título a procurar. Não pode ser usado em conjunto com iupageid.
- iupageid
O identificador da página a procurar. Não pode ser usado em conjunto com iutitle.
- Tipo: inteiro
- iucontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- iunamespace
O espaço nominal a ser enumerado.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- iudir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- iufilterredir
Como filtrar redirecionamentos. Se definido como nonredirects quando iuredirect está ativado, isto só é aplicado ao segundo nível.
- Um dos seguintes valores: all, nonredirects, redirects
- Padrão: all
- iulimit
O número total de páginas a serem devolvidas. Se iuredirect estiver ativado, o nível aplica-se a cada nível em separado (o que significa que até 2 * iulimit resultados podem ser devolvidos).
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- iuredirect
Se a página que contém a hiperligação é um redirecionamento, procurar também todas as páginas que contêm hiperligações para esse redirecionamento. O limite máximo é reduzido para metade.
- Tipo: booliano (detalhes)
- Mostrar as páginas que usam File:Albert Einstein Head.jpg.
- api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg [abrir na página de testes]
- Obter informações sobre as páginas que usam o ficheiro File:Albert Einstein Head.jpg.
- api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info [abrir na página de testes]
list=iwbacklinks (iwbl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
Pode ser usado para encontrar todas as hiperligações com um prefixo, ou todas as hiperligações para um título (com um prefixo especificado). Se nenhum dos parâmetros for usado, isso efetivamente significa "todas as hiperligações interwikis".
- iwblprefix
O prefixo interwikis.
- iwbltitle
A hiperligação interwikis a ser procurada. Tem de ser usado em conjunto com iwblblprefix.
- iwblcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- iwbllimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- iwblprop
As propriedades a serem obtidas:
- iwprefix
- Adiciona o prefixo da hiperligação interwikis.
- iwtitle
- Adiciona o título da hiperligação interwikis.
- Valores (separados com | ou alternativas): iwprefix, iwtitle
- Padrão: (vazio)
- iwbldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter as páginas que contêm hiperligações para wikibooks:Test.
- api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks [abrir na página de testes]
- Obter informação sobre as páginas que contêm hiperligações para wikibooks:Test.
- api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info [abrir na página de testes]
list=langbacklinks (lbl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
Pode ser usado para encontrar todas as hiperligações para um determinado código de língua, ou todas as hiperligações para um determinado título (de uma língua). Se nenhum dos parâmetros for usado, isso efetivamente significa "todas as hiperligações interlínguas".
Note que as hiperligações interlínguas adicionadas por extensões podem não ser consideradas.
- lbllang
A língua da hiperligação da língua.
- lbltitle
Hiperligação interlínguas a ser procurada. Tem de ser usado com lbllang.
- lblcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- lbllimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- lblprop
As propriedades a serem obtidas:
- lllang
- Adiciona o código de língua da hiperligação interlínguas.
- lltitle
- Adiciona o título da hiperligação interlínguas.
- Valores (separados com | ou alternativas): lllang, lltitle
- Padrão: (vazio)
- lbldir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Obter as páginas que contêm hiperligações para fr:Test.
- api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr [abrir na página de testes]
- Obter informações sobre as páginas que contêm hiperligações para fr:Test.
- api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info [abrir na página de testes]
list=logevents (le)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter eventos dos registos.
- leprop
As propriedades a serem obtidas:
- ids
- Adiciona o identificador do evento do registo.
- title
- Adiciona o título da página do evento do registo.
- type
- Adiciona o tipo do evento do registo.
- user
- Adiciona o utilizador responsável pelo evento do registo.
- userid
- Adiciona o identificador do utilizador responsável pelo evento do registo.
- timestamp
- Adiciona a data e hora do evento do registo.
- comment
- Adiciona o comentário do evento do registo.
- parsedcomment
- Adiciona o comentário do evento do registo, após análise sintática.
- details
- Lista detalhes adicionais sobre o evento do registo.
- tags
- Lista as etiquetas do evento do registo.
- Valores (separados com | ou alternativas): comment, details, ids, parsedcomment, tags, timestamp, title, type, user, userid
- Padrão: ids|title|type|user|timestamp|comment|details
- letype
Filtrar as entradas do registo para produzir só as deste tipo.
- Um dos seguintes valores: Can be empty, or block, contentmodel, create, delete, import, managetags, merge, move, newusers, patrol, protect, rights, suppress, tag, upload, usermerge
- leaction
Filtrar as entradas do registo para produzir só as desta operação. Tem precedência sobre letype. Na lista dos valores possíveis, os valores com o carácter de substituição asterisco action/* podem conter outros valores após a barra (/).
- Um dos seguintes valores: block/block, block/reblock, block/unblock, contentmodel/change, contentmodel/new, create/create, delete/delete, delete/delete_redir, delete/event, delete/restore, delete/revision, import/interwiki, import/upload, managetags/activate, managetags/create, managetags/deactivate, managetags/delete, merge/merge, move/move, move/move_redir, newusers/autocreate, newusers/byemail, newusers/create, newusers/create2, newusers/newusers, patrol/autopatrol, patrol/patrol, protect/modify, protect/move_prot, protect/protect, protect/unprotect, rights/autopromote, rights/rights, suppress/block, suppress/delete, suppress/event, suppress/reblock, suppress/revision, tag/update, upload/overwrite, upload/revert, upload/upload, usermerge/*
- lestart
A data e hora a partir da qual será começada a enumeração.
- Tipo: data e hora (formatos permitidos)
- leend
A data e hora na qual será terminada a enumeração.
- Tipo: data e hora (formatos permitidos)
- ledir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: lestart tem de estar antes de leend.
- older
- Listar o mais recente primeiro (padrão). Nota: lestart tem de estar depois de leend.
- Um dos seguintes valores: newer, older
- Padrão: older
- leuser
Filtrar as entradas para produzir só as criadas pelo utilizador indicado.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- letitle
Filtrar as entradas para produzir só as relacionadas com uma página.
- lenamespace
Filtrar as entradas para produzir só as que estão no espaço nominal indicado.
- Um dos seguintes valores: -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- leprefix
Filtrar as entradas para produzir só as que começam por este prefixo.
- letag
Listar só as entradas de eventos marcadas com esta etiqueta.
- lelimit
O número total de entradas de eventos a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- lecontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Listar os eventos recentes do registo.
- api.php?action=query&list=logevents [abrir na página de testes]
list=mystashedfiles (msf)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter uma lista dos ficheiros que estão na área de ficheiros escondidos do utilizador atual.
- msfprop
As propriedades a serem obtidas para os ficheiros.
- size
- Obter o tamanho do ficheiro e as dimensões da imagem.
- type
- Obter o tipo MIME e o tipo de multimédia do ficheiro.
- Valores (separados com | ou alternativas): size, type
- Padrão: (vazio)
- msflimit
Quantos ficheiros a serem obtidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- msfcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter a chave, o tamanho e as dimensões em píxeis dos ficheiros na área de ficheiros escondidos do utilizador.
- api.php?action=query&list=mystashedfiles&msfprop=size [abrir na página de testes]
list=pagepropnames (ppn)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todos os nomes de propriedades de páginas em uso nesta wiki.
- ppncontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- ppnlimit
O número máximo de nomes a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- Obter os primeiros 10 nomes de propriedades.
- api.php?action=query&list=pagepropnames [abrir na página de testes]
list=pageswithprop (pwp)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todas as páginas que usam uma determinada propriedade.
- pwppropname
A propriedade de página a partir da qual as páginas serão enumeradas (action=query&list=pagepropnames devolve os nomes das propriedades de página que estão a ser usadas).
- Este parâmetro é obrigatório.
- pwpprop
As informações que devem ser incluídas:
- ids
- Adiciona o identificador da página.
- title
- Adiciona o título e o identificador do espaço nominal da página.
- value
- Adiciona o valor da propriedade da página.
- Valores (separados com | ou alternativas): ids, title, value
- Padrão: ids|title
- pwpcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- pwplimit
O número máximo de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- pwpdir
A direção da ordenação.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- Listar as primeiras 10 páginas que usam a propriedade
{{DISPLAYTITLE:}}
. - api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [abrir na página de testes]
- Obter informação adicional sobre as primeiras 10 páginas que usam
__NOTOC__
. - api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [abrir na página de testes]
list=prefixsearch (ps)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Realizar uma procura de prefixo nos títulos de página.
Apesar da semelhança de nomes, este módulo não pretende ser equivalente a Special:PrefixIndex; para este, consulte action=query&list=allpages com o parâmetro apprefix. O propósito deste módulo é semelhante a action=opensearch: receber dados introduzidos pelo utilizador e devolver os títulos com melhor correspondência. Dependendo do motor de busca do servidor, isto pode incluir correções de erros ortográficos, evitar redirecionamentos, e outras heurísticas.
- pssearch
O texto a ser pesquisado.
- Este parâmetro é obrigatório.
- psnamespace
Os espaços nominais onde realizar a pesquisa. Ignorados se pssearch começar com um prefixo de espaço nominal válido.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- Padrão: 0
- pslimit
O número máximo de resultados a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- psoffset
Quando houver mais resultados disponíveis, usar isto para continuar
- Tipo: inteiro
- Padrão: 0
- Procurar os títulos de página que começam por meaning.
- api.php?action=query&list=prefixsearch&pssearch=meaning [abrir na página de testes]
list=protectedtitles (pt)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar todos os títulos cuja criação está impedida.
- ptnamespace
Listar só os títulos nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- ptlevel
Listar só os títulos com estes níveis de proteção.
- Valores (separados com | ou alternativas): autoconfirmed, sysop
- ptlimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- ptdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: ptstart tem de estar antes de ptend.
- older
- Listar o mais recente primeiro (padrão). Nota: ptstart tem de estar depois de ptend.
- Um dos seguintes valores: newer, older
- Padrão: older
- ptstart
Começar a listagem pelo título que tem esta data e hora de proteção.
- Tipo: data e hora (formatos permitidos)
- ptend
Terminar a listagem no título que tem esta data e hora de proteção.
- Tipo: data e hora (formatos permitidos)
- ptprop
As propriedades a serem obtidas:
- timestamp
- Adiciona a data e hora a que a proteção foi adicionada.
- user
- Adiciona o utilizador que fez a proteção.
- userid
- Adiciona o identificador do utilizador que fez a proteção.
- comment
- Adiciona o comentário da proteção.
- parsedcomment
- Adiciona o comentário da proteção após a análise sintática.
- expiry
- Adiciona a data e hora a que a proteção será removida.
- level
- Adiciona o nível de proteção.
- Valores (separados com | ou alternativas): comment, expiry, level, parsedcomment, timestamp, user, userid
- Padrão: timestamp|level
- ptcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Lista os títulos protegidos.
- api.php?action=query&list=protectedtitles [abrir na página de testes]
- Encontrar as hiperligações para os títulos protegidos que pertencem ao espaço nominal principal.
- api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere [abrir na página de testes]
list=querypage (qp)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- qppage
O nome da página especial. Note que este é sensível a maiúsculas e minúsculas.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: Ancientpages, BrokenRedirects, Deadendpages, DoubleRedirects, Fewestrevisions, ListDuplicatedFiles, Listredirects, Lonelypages, Longpages, MediaStatistics, Mostcategories, Mostimages, Mostinterwikis, Mostlinked, Mostlinkedcategories, Mostlinkedtemplates, Mostrevisions, Shortpages, Uncategorizedcategories, Uncategorizedimages, Uncategorizedpages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Unusedtemplates, Unwatchedpages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Withoutinterwiki
- qpoffset
Quando houver mais resultados disponíveis, usar isto para continuar
- Tipo: inteiro
- Padrão: 0
- qplimit
O número de resultados a serem devolvidos.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- Devolver os resultados da página Special:Ancientpages.
- api.php?action=query&list=querypage&qppage=Ancientpages [abrir na página de testes]
list=random (rn)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter um conjunto de páginas aleatórias.
As páginas são listadas em sequência fixa, só o ponto de início da listagem é aleatório. Isto significa, por exemplo, que se a primeira página aleatória na lista é Main Page, a página List of fictional monkeys será sempre a segunda, a página List of people on stamps of Vanuatu a terceira, etc.
- rnnamespace
Devolver só as páginas que estão nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- rnfilterredir
Como filtrar redirecionamentos.
- Um dos seguintes valores: all, nonredirects, redirects
- Padrão: nonredirects
- rnredirect
- Obsoleto.
Em vez dele, usar rnfilterredir=redirects.
- Tipo: booliano (detalhes)
- rnlimit
Limitar o número de páginas aleatórias que serão devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 1
- rncontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Devolver duas páginas aleatórias do espaço nominal principal.
- api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [abrir na página de testes]
- Devolver informação de página sobre duas páginas aleatórias do espaço nominal principal.
- api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [abrir na página de testes]
list=recentchanges (rc)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enumerar as mudanças recentes.
- rcstart
A data e hora a partir da qual será começada a enumeração.
- Tipo: data e hora (formatos permitidos)
- rcend
A data e hora na qual será terminada a enumeração.
- Tipo: data e hora (formatos permitidos)
- rcdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: rcstart tem de estar antes de rcend.
- older
- Listar o mais recente primeiro (padrão). Nota: rcstart tem de estar depois de rcend.
- Um dos seguintes valores: newer, older
- Padrão: older
- rcnamespace
Filtrar as mudanças para produzir só as destes espaços nominais.
- Valores (separados com | ou alternativas): -1, -2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- rcuser
Listar só as mudanças feitas por este utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- rcexcludeuser
Não listar as mudanças feitas por este utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- rctag
Listar só as mudanças marcadas com esta etiqueta.
- rcprop
Incluir informações adicionais:
- user
- Adiciona o utilizador responsável pela edição e marca se o utilizador é um endereço IP. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- Adiciona o identificador do utilizador responsável pela edição. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- comment
- Adiciona o comentário da edição. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- Adiciona o comentário da edição, após análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- flags
- Adiciona as etiquetas da edição.
- timestamp
- Adiciona a data e hora da edição.
- title
- Adiciona o título de página da edição.
- ids
- Adiciona o identificadores da página, das mudanças recentes, e das revisões nova e antiga.
- sizes
- Adiciona os tamanhos antigo e novo da página em bytes.
- redirect
- Etiqueta a página se esta for um redirecionamento.
- patrolled
- Etiqueta as edições que podem ser patrulhadas, marcando-as como patrulhadas ou não patrulhadas.
- loginfo
- Adiciona informação de registo (identificador do registo, tipo de entrada, etc.) às entradas do registo.
- tags
- Lista as etiquetas da entrada.
- sha1
- Adiciona a soma de controlo do conteúdo para as entradas associadas com uma revisão. Se o conteúdo é de uma revisão suprimida, será devolvida uma propriedade sha1hidden.
- Valores (separados com | ou alternativas): comment, flags, ids, loginfo, parsedcomment, patrolled, redirect, sha1, sizes, tags, timestamp, title, user, userid
- Padrão: title|timestamp|ids
- rctoken
- Obsoleto.
Em substituição, usar action=query&meta=tokens.
- Valores (separados com | ou alternativas): patrol
- rcshow
Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, defina rcshow=minor|!anon.
- Valores (separados com | ou alternativas): !anon, !autopatrolled, !bot, !minor, !patrolled, !redirect, anon, autopatrolled, bot, minor, patrolled, redirect, unpatrolled
- rclimit
O número total de mudanças a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- rctype
Os tipos de mudanças a serem mostradas.
- Valores (separados com | ou alternativas): categorize, edit, external, log, new
- Padrão: edit|new|log|categorize
- rctoponly
Listar só as alterações que são a revisão mais recente.
- Tipo: booliano (detalhes)
- rctitle
Filtrar as entradas para produzir só as relacionadas com uma página.
- rccontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- rcgeneraterevisions
Ao ser usado como gerador, gerar identificadores de revisões em vez de títulos. As entradas das mudanças recentes que não tenham identificadores de revisão associados (por exemplo, a maioria das entradas do registo) não geram nada.
- Tipo: booliano (detalhes)
- rcslot
Listar só as mudanças que afetam o segmento de revisão nomeado.
- Um dos seguintes valores: main
- Listar as mudanças recentes.
- api.php?action=query&list=recentchanges [abrir na página de testes]
- Obter informação de página acerca das mudanças recentes não patrulhadas.
- api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info [abrir na página de testes]
list=search (sr)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Efetuar uma pesquisa do texto integral.
- srsearch
Procurar os títulos de página ou o conteúdo que corresponda a este valor. Pode usar o texto da pesquisa para invocar funcionalidades de pesquisa especiais, dependendo dos meios de pesquisa do servidor da wiki.
- Este parâmetro é obrigatório.
- srnamespace
Pesquisar só nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- Padrão: 0
- srlimit
O número total de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- sroffset
Quando houver mais resultados disponíveis, usar isto para continuar
- Tipo: inteiro
- Padrão: 0
- srwhat
O tipo de pesquisa a executar.
- Um dos seguintes valores: nearmatch, text, title
- srinfo
Quais os metadados a serem devolvidos.
- Valores (separados com | ou alternativas): rewrittenquery, suggestion, totalhits
- Padrão: totalhits|suggestion|rewrittenquery
- srprop
As propriedades a serem devolvidas:
- size
- Adiciona o tamanho da página em bytes.
- wordcount
- Adiciona o número de palavras da página.
- timestamp
- Adiciona a data e hora a que a página foi editada pela última vez.
- snippet
- Adiciona um fragmento de código com a página, após análise sintática.
- titlesnippet
- Adiciona um fragmento de código com o título da página, após análise sintática.
- redirecttitle
- Adiciona o título do redirecionamento correspondente.
- redirectsnippet
- Adiciona um fragmento de código com o título redirecionado, após análise sintática.
- sectiontitle
- Adiciona o título da secção correspondente.
- sectionsnippet
- Adiciona um fragmento de código com o título da secção correspondente, após análise sintática.
- isfilematch
- Adiciona um valor booliano que indica se a pesquisa encontrou correspondência no conteúdo de ficheiros.
- categorysnippet
- Adiciona um fragmento de código com a categoria correspondente, após análise sintática.
- score
- Obsoleto. Ignorado.
- hasrelated
- Obsoleto. Ignorado.
- extensiondata
- Acrescenta dados adicionais gerados por extensões.
- Valores (separados com | ou alternativas): categorysnippet, extensiondata, isfilematch, redirectsnippet, redirecttitle, sectionsnippet, sectiontitle, size, snippet, timestamp, titlesnippet, wordcount, hasrelated, score
- Padrão: size|wordcount|timestamp|snippet
- srinterwiki
Incluir resultados interwikis na pesquisa, se disponíveis.
- Tipo: booliano (detalhes)
- srenablerewrites
Ativar a reescrita da pesquisa interna. Alguns motores de pesquisa podem reescrever a pesquisa substituindo-a por outra que consideram que dará melhores resultados, por exemplo, por corrigir erros de ortografia.
- Tipo: booliano (detalhes)
- srsort
Definir o ordenamento dos resultados devolvidos.
- Um dos seguintes valores: relevance
- Padrão: relevance
- Pesquisar meaning.
- api.php?action=query&list=search&srsearch=meaning [abrir na página de testes]
- Pesquisar meaning nos textos.
- api.php?action=query&list=search&srwhat=text&srsearch=meaning [abrir na página de testes]
- Obter informação sobre as páginas devolvidas por uma pesquisa do termo meaning.
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info [abrir na página de testes]
list=tags (tg)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Listar as etiquetas de modificação.
- tgcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- tglimit
O número máximo de etiquetas a serem listadas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- tgprop
As propriedades a serem obtidas:
- displayname
- Adiciona a mensagem de sistema para a etiqueta.
- description
- Adiciona a descrição da etiqueta.
- hitcount
- Adiciona o número de revisões e de entradas no registo que têm esta etiqueta.
- defined
- Indicar se a etiqueta está definida.
- source
- Obter as fontes da etiqueta, que podem incluir extension para etiquetas definidas por extensões e manual para etiquetas que podem ser manualmente aplicadas pelos utilizadores.
- active
- Indica se a etiqueta ainda está a ser aplicada.
- Valores (separados com | ou alternativas): active, defined, description, displayname, hitcount, source
- Padrão: (vazio)
- Listar as etiquetas disponíveis.
- api.php?action=query&list=tags&tgprop=displayname|description|hitcount|defined [abrir na página de testes]
list=usercontribs (uc)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter todas as edições de um utilizador.
- uclimit
O número máximo de contribuições a serem devolvidas.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- ucstart
A data e hora da contribuição pela qual será começada a devolução de resultados.
- Tipo: data e hora (formatos permitidos)
- ucend
A data e hora da contribuição na qual será terminada a devolução de resultados.
- Tipo: data e hora (formatos permitidos)
- uccontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- ucuser
Os utilizadores cujas contribuições serão obtidas. Não pode ser usado em conjunto com ucuserids ou ucuserprefix.
- Tipo: lista de utilizadores, por um de entre nome de utilizador, IP e nome interwikis (p. ex. "prefixo>NomeDeExemplo")
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- ucuserids
Os identificadores dos utilizadores cujas contribuições serão obtidas. Não pode ser usado em conjunto com ucuser ou ucuserprefix.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- ucuserprefix
Obter as contribuições de todos os utilizadores cujos nomes começam por este valor. Não pode ser usado em conjunto com ucuser ou ucuserids.
- ucdir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: ucstart tem de estar antes de ucend.
- older
- Listar o mais recente primeiro (padrão). Nota: ucstart tem de estar depois de ucend.
- Um dos seguintes valores: newer, older
- Padrão: older
- ucnamespace
Listar só as contribuições nestes espaços nominais.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- ucprop
Incluir informações adicionais:
- ids
- Adiciona os identificadores da página e da revisão.
- title
- Adiciona o título e o identificador do espaço nominal da página.
- timestamp
- Adiciona a data e hora da edição.
- comment
- Adiciona o comentário da edição. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- Adiciona o comentário da edição, após análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- size
- Adiciona o novo tamanho da edição.
- sizediff
- Adiciona a diferença de tamanho entre a edição e a sua progenitora.
- flags
- Adiciona as etiquetas da edição.
- patrolled
- Etiqueta as edições patrulhadas.
- tags
- Lista as etiquetas da edição.
- Valores (separados com | ou alternativas): comment, flags, ids, parsedcomment, patrolled, size, sizediff, tags, timestamp, title
- Padrão: ids|title|timestamp|comment|size|flags
- ucshow
Mostrar só as contribuições que correspondem a estes critérios; por exemplo, só as edições não menores: ucshow=!minor.
Se um dos valores ucshow=patrolled ou ucshow=!patrolled estiver definido, as revisões feitas há mais de $wgRCMaxAge (7776000 segundos) não serão mostradas.
- Valores (separados com | ou alternativas): !autopatrolled, !minor, !new, !patrolled, !top, autopatrolled, minor, new, patrolled, top
- uctag
Listar só as revisões marcadas com esta etiqueta.
- uctoponly
- Obsoleto.
Listar só as alterações que são a revisão mais recente.
- Tipo: booliano (detalhes)
- Mostrar as contribuições do utilizador Example.
- api.php?action=query&list=usercontribs&ucuser=Example [abrir na página de testes]
- Mostrar as contribuições de todos os endereços IP com o prefixo 192.0.2..
- api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [abrir na página de testes]
list=users (us)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informações sobre uma lista de utilizadores.
- usprop
As informações que devem ser incluídas:
- blockinfo
- Etiquetas que indicam se o utilizador está bloqueado, por quem, e qual o motivo.
- groups
- Lista todos os grupos aos quais cada utilizador pertence.
- groupmemberships
- Lista os grupos aos quais cada utilizador foi explicitamente atribuído, incluindo a data de expiração da sua pertença a cada grupo.
- implicitgroups
- Lista todos os grupos aos quais um utilizador pertence automaticamente.
- rights
- Lista todas as permissões que cada utilizador tem.
- editcount
- Adiciona a contagem de edições do utilizador.
- registration
- Adiciona a data e hora de registo do utilizador.
- emailable
- Etiqueta que indica se o utilizador pode e quer receber correio eletrónico através de Special:Emailuser.
- gender
- Etiqueta que indica o sexo do utilizador. Devolve "male" (masculino), "female" (feminino) ou "unknown" (desconhecido).
- centralids
- Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
- cancreate
- Indica se pode ser criada uma conta para os nomes de utilizador não registados, mas válidos.
- Valores (separados com | ou alternativas): blockinfo, cancreate, centralids, editcount, emailable, gender, groupmemberships, groups, implicitgroups, registration, rights
- usattachedwiki
Com usprop=centralids, indicar se o utilizador tem ligação com a wiki designada por este identificador.
- ususers
Uma lista de utilizadores dos quais serão obtidas informações.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- ususerids
Uma lista de identificadores dos utilizadores de que serão obtidas informações.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- ustoken
- Obsoleto.
Em substituição, usar action=query&meta=tokens.
- Valores (separados com | ou alternativas): userrights
- Devolver informações sobre o utilizador Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [abrir na página de testes]
list=watchlist (wl)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter mudanças recentes das páginas vigiadas do utilizador atual.
- wlallrev
Incluir revisões múltiplas da mesma página dentro do intervalo de tempo indicado.
- Tipo: booliano (detalhes)
- wlstart
A data e hora da mudança recente a partir da qual será começada a enumeração.
- Tipo: data e hora (formatos permitidos)
- wlend
A data e hora da mudança recente na qual será terminada a enumeração.
- Tipo: data e hora (formatos permitidos)
- wlnamespace
Filtrar as mudanças para produzir só as dos espaços nominais indicados.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- wluser
Listar só as mudanças deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- wlexcludeuser
Não listar as mudanças deste utilizador.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- wldir
A direção da enumeração:
- newer
- Listar o mais antigo primeiro. Nota: wlstart tem de estar antes de wlend.
- older
- Listar o mais recente primeiro (padrão). Nota: wlstart tem de estar depois de wlend.
- Um dos seguintes valores: newer, older
- Padrão: older
- wllimit
O número total de resultados a serem devolvidos por pedido.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- wlprop
As propriedades adicionais que devem ser obtidas:
- ids
- Adiciona identificadores de revisões e de páginas.
- title
- Adiciona o título da página.
- flags
- Adiciona as etiquetas da edição.
- user
- Adiciona o utilizador que fez a edição. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- userid
- Adiciona o identificador do utilizador que realizou a edição. Se o utilizador é de uma revisão suprimida, será devolvida uma propriedade userhidden.
- comment
- Adiciona o comentário da edição. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- parsedcomment
- Adiciona o comentário da edição, após análise sintática. Se o comentário é de uma revisão suprimida, será devolvida uma propriedade commenthidden.
- timestamp
- Adiciona a data e hora da edição.
- patrol
- Etiqueta que indica as edições que são patrulhadas.
- sizes
- Adiciona o tamanho novo e antigo da página.
- notificationtimestamp
- Adiciona a data e hora da última vez em que o utilizador foi notificado da edição.
- loginfo
- Adiciona informação do registo quando apropriado.
- tags
- Lista as etiquetas da entrada.
- Valores (separados com | ou alternativas): comment, flags, ids, loginfo, notificationtimestamp, parsedcomment, patrol, sizes, tags, timestamp, title, user, userid
- Padrão: ids|title|flags
- wlshow
Mostrar só as entradas que correspondem a estes critérios. Por exemplo, para ver só as edições menores feitas por utilizadores autenticados, definir wlshow=minor|!anon.
- Valores (separados com | ou alternativas): !anon, !autopatrolled, !bot, !minor, !patrolled, !unread, anon, autopatrolled, bot, minor, patrolled, unread
- wltype
Os tipos de alterações a serem mostradas:
- edit
- Edições normais.
- new
- Criações de páginas.
- log
- Entradas do registo.
- external
- Mudanças externas.
- categorize
- Alterações de pertença a categorias.
- Valores (separados com | ou alternativas): categorize, edit, external, log, new
- Padrão: edit|new|log|categorize
- wlowner
Usado com wltoken para aceder à lista de páginas vigiadas de outro utilizador.
- Tipo: utilizador, por nome de utilizador
- wltoken
Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.
- wlcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Listar a revisão mais recente das páginas com mudanças recentes na lista de páginas vigiadas do utilizador atual.
- api.php?action=query&list=watchlist [abrir na página de testes]
- Obter informação adicional sobre a revisão mais recente das páginas vigiadas do utilizador atual que tenham sido alteradas.
- api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [abrir na página de testes]
- Obter informações sobre todas as mudanças recentes às páginas vigiadas do utilizador atual.
- api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [abrir na página de testes]
- Obter informações das páginas na lista de páginas vigiadas do utilizador atual que tenham sido recentemente alteradas.
- api.php?action=query&generator=watchlist&prop=info [abrir na página de testes]
- Obter informações de revisão para as mudanças recentes às páginas vigiadas do utilizador atual.
- api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [abrir na página de testes]
- Listar a revisão mais recente das páginas na lista de páginas vigiadas do utilizador Example que tenham sido recentemente alteradas.
- api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [abrir na página de testes]
list=watchlistraw (wr)
- Este módulo requer direitos de leitura.
- Este módulo pode ser usado como gerador.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- wrcontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- wrnamespace
Listar só as páginas nos espaços nominais indicados.
- Valores (separados com | ou alternativas): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Para especificar todos os valores, use *.
- wrlimit
O número total de resultados a serem devolvidos por pedido.
- Tipo: inteiro ou max
- O valor deve estar entre 1 e 500.
- Padrão: 10
- wrprop
As propriedades adicionais que devem ser obtidas:
- changed
- Adiciona a data e hora da última vez em que o utilizador foi notificado da edição.
- Valores (separados com | ou alternativas): changed
- wrshow
Listar só os elementos que preenchem estes critérios.
- Valores (separados com | ou alternativas): !changed, changed
- wrowner
Usado em conjunto com o parâmetro wrtoken para aceder à lista de páginas vigiadas de outro utilizador.
- Tipo: utilizador, por nome de utilizador
- wrtoken
Uma chave de segurança (disponível nas preferências do utilizador) para permitir acesso à lista de páginas vigiadas de outro utilizador.
- wrdir
A direção de listagem.
- Um dos seguintes valores: ascending, descending
- Padrão: ascending
- wrfromtitle
O título (com o prefixo do espaço nominal) a partir do qual será começada a enumeração.
- wrtotitle
O título (com o prefixo do espaço nominal) no qual será terminada a enumeração.
- Listar as páginas na lista de páginas vigiadas do utilizador atual.
- api.php?action=query&list=watchlistraw [abrir na página de testes]
- Obter informações das páginas na lista de páginas vigiadas do utilizador atual.
- api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [abrir na página de testes]
meta=allmessages (am)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolver as mensagens deste sítio.
- ammessages
Mensagens a serem produzidas no resultado. * (o valor por omissão) significa todas as mensagens.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Padrão: *
- amprop
As propriedades a serem obtidas:
- Valores (separados com | ou alternativas): default
- amenableparser
Definir para ativar o analisador sintático; irá pré-processar o texto wiki da mensagem (substituir palavras mágicas, processar predefinições, etc.).
- Tipo: booliano (detalhes)
- amnocontent
Se definido, não incluir o conteúdo das mensagens no resultado de saída.
- Tipo: booliano (detalhes)
- amincludelocal
Incluir também as mensagens locais, isto é, mensagens que não existem no software mas existem como uma página no espaço nominal MediaWiki. Isto lista todas as páginas do espaço nominal MediaWiki, portanto, também irá listar aquelas que não são verdadeiramente mensagens, como Common.js.
- Tipo: booliano (detalhes)
- amargs
Os argumentos a serem substituídos na mensagem.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- amfilter
Devolver só as mensagens cujos nomes contêm este texto.
- amcustomised
Devolver só as mensagens neste estado de personalização.
- Um dos seguintes valores: all, modified, unmodified
- Padrão: all
- amlang
Devolver as mensagens nesta língua.
- amfrom
Devolver as mensagens, a partir desta mensagem.
- amto
Devolver as mensagens, até esta mensagem.
- amtitle
Nome da página a utilizar como contexto ao fazer a análise sintática da mensagem (para a opção amenableparser).
- amprefix
Devolver as mensagens com este prefixo.
- Mostrar mensagens que começam por ipb-.
- api.php?action=query&meta=allmessages&refix=ipb- [abrir na página de testes]
- Mostrar as mensagens august e mainpage em Alemão.
- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [abrir na página de testes]
meta=authmanagerinfo (ami)
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informação sobre o atual estado de autenticação.
- amisecuritysensitiveoperation
Testar se o estado atual de autenticação do utilizador é suficiente para a operação especificada, que exige condições seguras.
- amirequestsfor
Obter informação sobre os pedidos de autenticação que são necessários para a operação de autenticação especificada.
- Um dos seguintes valores: change, create, create-continue, link, link-continue, login, login-continue, remove, unlink
- amimergerequestfields
Combinar a informação de todos os pedidos de autenticação numa única matriz.
- Tipo: booliano (detalhes)
- amimessageformat
Formato a usar nas mensagens de saída.
- Um dos seguintes valores: html, none, raw, wikitext
- Padrão: wikitext
- Obter os pedidos que podem ser usados ao iniciar uma sessão.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [abrir na página de testes]
- Obter os pedidos que podem ser usados ao iniciar uma sessão, com os campos combinados.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [abrir na página de testes]
- Testar se a autenticação é suficiente para a operação foo.
- api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [abrir na página de testes]
meta=filerepoinfo (fri)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolver meta informação sobre os repositórios de imagens configurados na wiki.
- friprop
As propriedades do repositório que devem ser obtidas (as propriedades disponíveis podem variar noutras wikis).
- canUpload
- Indica se podem ser carregados ficheiros neste repositório, por exemplo, via CORS e autenticação partilhada.
- displayname
- O nome legível da wiki do repositório.
- favicon
- O URL da favicon da wiki do repositório, de $wgFavicon.
- initialCapital
- Indica se os nomes de ficheiros começam implicitamente com letra maiúscula.
- local
- Indica se o repositório em questão é o local ou não.
- name
- A chave do repositório - usada, por exemplo, nos valores devolvidos em $wgForeignFileRepos e imageinfo.
- rootUrl
- Caminho do URL de raiz para os caminhos de imagens.
- scriptDirUrl
- Caminho do URL de raiz para a instalação MediaWiki da wiki do repositório.
- thumbUrl
- Caminho do URL de raiz para os caminhos das miniaturas.
- url
- Caminho do URL da zona pública.
- Valores (separados com | ou alternativas): canUpload, displayname, favicon, initialCapital, local, name, rootUrl, scriptDirUrl, thumbUrl, url
- Padrão: canUpload|displayname|favicon|initialCapital|local|name|rootUrl|scriptDirUrl|thumbUrl|url
- Obter informações sobre os repositórios de ficheiros.
- api.php?action=query&meta=filerepoinfo&friprop=name|displayname [abrir na página de testes]
meta=languageinfo (li)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolver informações sobre as línguas disponíveis.
Pode ser aplicada uma continuação se a obtenção das informações demorar demasiado tempo para um só pedido.
- liprop
A informação a ser obtida para cada língua.
- code
- O código da língua (este código é específico do MediaWiki, embora tenha semelhanças com outros padrões).
- bcp47
- O código de língua BCP-47.
- dir
- A direção de escrita da língua (
ltr
, da esquerda para a direita, ourtl
, da direita para a esquerda). - autonym
- O autónimo da língua, isto é, o seu nome nessa língua.
- name
- O nome da língua na língua especificada pelo parâmetro uselang, com a aplicação de línguas de recurso se necessário.
- fallbacks
- Os códigos de língua das línguas de recurso configuradas para esta língua. O recurso final implícito para 'en' não é incluído (mas algumas línguas podem especificar 'en' como último recurso explicitamente).
- variants
- Os códigos de língua das variantes suportadas por esta língua.
- Valores (separados com | ou alternativas): autonym, bcp47, code, dir, fallbacks, name, variants
- Padrão: code
- licode
Códigos de língua das línguas que devem ser devolvidas, ou
*
para todas as línguas.- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Padrão: *
- licontinue
Quando houver mais resultados disponíveis, usar isto para continuar
- Obter os códigos de língua de todas as línguas suportadas.
- api.php?action=query&meta=languageinfo [abrir na página de testes]
- Obter os autónimos e nomes em alemão de todas as línguas suportadas.
- api.php?action=query&meta=languageinfo&liprop=autonym|name&uselang=de [abrir na página de testes]
- Obter as línguas de recurso e as variantes de occitânico.
- api.php?action=query&meta=languageinfo&liprop=fallbacks|variants&licode=oc [abrir na página de testes]
- Obter o código de língua BCP-47 e a direção de escrita de todas as línguas suportadas.
- api.php?action=query&meta=languageinfo&liprop=bcp47|dir [abrir na página de testes]
meta=siteinfo (si)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Devolver informação geral sobre o sítio.
- siprop
A informação a ser obtida:
- general
- Informação global do sistema.
- namespaces
- Uma lista dos espaços nominais registados e dos seus nomes canónicos.
- namespacealiases
- Uma lista dos nomes alternativos dos espaços nominais registados.
- specialpagealiases
- Uma lista dos nomes alternativos das páginas especiais.
- magicwords
- Uma lista das palavras mágicas e dos seus nomes alternativos.
- interwikimap
- Devolve o mapa de interwikis (opcionalmente filtrado, opcionalmente localizado usando siinlanguagecode).
- dbrepllag
- Devolve o servidor da base de dados com o maior atraso de replicação.
- statistics
- Devolve as estatísticas do sítio.
- usergroups
- Devolve os grupos de utilizadores e as permissões associadas.
- libraries
- Devolve as bibliotecas instaladas na wiki.
- extensions
- Devolve as extensões instaladas na wiki.
- fileextensions
- Devolve uma lista das extensões (tipos) dos ficheiros que podem ser carregados.
- rightsinfo
- Devolve informação sobre os direitos (a licença) da wiki, se disponível.
- restrictions
- Devolve informação sobre os tipos de restrição (proteção) disponíveis.
- languages
- Devolve uma lista das línguas que o MediaWiki suporta (opcionalmente localizada, usando siinlanguagecode).
- languagevariants
- Devolve uma lista dos códigos de língua para os quais o LanguageConverter está ativado, e as variantes suportadas para cada código.
- skins
- Devolve uma lista de todos os temas ativados (opcionalmente localizada, usando siinlanguagecode, ou então na língua do conteúdo).
- extensiontags
- Devolve uma lista dos elementos de extensões do analisador sintático.
- functionhooks
- Devolve uma lista dos hooks de funções do analisador sintático.
- showhooks
- Devolve uma lista de todos os hooks subscritos (conteúdo de $wgHooks).
- variables
- Devolve uma lista de identificadores de variáveis.
- protocols
- Devolve uma lista dos protocolos permitidos nas hiperligações externas.
- defaultoptions
- Devolve os valores padrão para as preferências dos utilizadores.
- uploaddialog
- Devolve a configuração do diálogo de carregamento.
- Valores (separados com | ou alternativas): dbrepllag, defaultoptions, extensions, extensiontags, fileextensions, functionhooks, general, interwikimap, languages, languagevariants, libraries, magicwords, namespacealiases, namespaces, protocols, restrictions, rightsinfo, showhooks, skins, specialpagealiases, statistics, uploaddialog, usergroups, variables
- Padrão: general
- sifilteriw
Devolver só as entradas locais, ou só as não locais, do mapa de interwikis.
- Um dos seguintes valores: !local, local
- sishowalldb
Listar todos os servidores da base de dados, não só aquele que tem maior atraso.
- Tipo: booliano (detalhes)
- sinumberingroup
Lista o número de utilizadores nos grupos de utilizadores.
- Tipo: booliano (detalhes)
- siinlanguagecode
O código de língua dos nomes localizados (o melhor possível) das línguas e dos temas.
- Obter as informações do sítio.
- api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics [abrir na página de testes]
- Obter uma lista dos prefixos interwikis locais.
- api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local [abrir na página de testes]
- Verificar o atraso de replicação atual.
- api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb= [abrir na página de testes]
meta=tokens
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obtém chaves para operações de modificação de dados.
- type
Tipos de chave a pedir.
- Valores (separados com | ou alternativas): createaccount, csrf, login, patrol, rollback, userrights, watch
- Padrão: csrf
- Obter uma chave csfr (padrão).
- api.php?action=query&meta=tokens [abrir na página de testes]
- Obter uma chave de vigilância e uma chave de patrulha.
- api.php?action=query&meta=tokens&type=watch|patrol [abrir na página de testes]
meta=userinfo (ui)
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter informações sobre o utilizador atual.
- uiprop
As informações que devem ser incluídas:
- blockinfo
- Etiquetas que indicam se o utilizador atual está bloqueado, por quem, e qual o motivo.
- hasmsg
- Adiciona uma etiqueta messages se o utilizador atual tem mensagens pendentes.
- groups
- Lista todos os grupos aos quais o utilizador atual pertence.
- groupmemberships
- Lista os grupos aos quais o utilizador atual foi explicitamente atribuído, incluindo a data de expiração da sua pertença a cada grupo.
- implicitgroups
- Lista todos os grupos aos quais o utilizador atual pertence automaticamente.
- rights
- Lista todas as permissões que o utilizador atual tem.
- changeablegroups
- Lista os grupos aos quais o utilizador atual pode ser adicionado ou de onde pode ser removido.
- options
- Lista todas as preferências que o utilizador atual definiu.
- editcount
- Adiciona a contagem de edições do utilizador atual.
- ratelimits
- Lista todas as frequências limite do utilizador atual.
- Adicionar o correio eletrónico do utilizador e a data de autenticação do correio eletrónico.
- realname
- Adiciona o nome real do utilizador.
- acceptlang
- Faz eco do cabeçalho
Accept-Language
enviado pelo cliente num formato estruturado. - registrationdate
- Adiciona a data de registo do utilizador.
- unreadcount
- Adiciona a contagem de páginas não lidas da lista de páginas vigiadas do utilizador (máximo 999; devolve 1000+ se forem mais).
- centralids
- Adiciona os identificadores centrais e o estado de ligação central (attachment) do utilizador.
- preferencestoken
- Obsoleto. Obter uma chave para alterar as preferências do utilizador atual.
- latestcontrib
- Adiciona a data da última contribuição do utilizador.
- Valores (separados com | ou alternativas): acceptlang, blockinfo, centralids, changeablegroups, editcount, email, groupmemberships, groups, hasmsg, implicitgroups, latestcontrib, options, ratelimits, realname, registrationdate, rights, unreadcount, preferencestoken
- Para especificar todos os valores, use *.
- uiattachedwiki
Com uiprop=centralids, indicar se o utilizador tem ligação com a wiki designada por este identificador.
- Obter informações sobre o utilizador atual.
- api.php?action=query&meta=userinfo [abrir na página de testes]
- Obter informações adicionais sobre o utilizador atual.
- api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [abrir na página de testes]
action=removeauthenticationdata
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Remover os dados de autenticação do utilizador atual.
- request
Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=remove.
- Este parâmetro é obrigatório.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Tentar remover os dados do utilizador atual para o pedido de autenticação FooAuthenticationRequest.
- api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [abrir na página de testes]
action=resetpassword
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Enviar a um utilizador uma mensagem eletrónica de reinício da palavra-passe.
- user
O utilizar cuja palavra-passe será reiniciada.
- Tipo: utilizador, por nome de utilizador
O correio eletrónico do utilizador cuja palavra-passe será reiniciada.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Enviar uma mensagem eletrónica para reinício da palavra-passe ao utilizador Example.
- api.php?action=resetpassword&user=Example&token=123ABC [abrir na página de testes]
- Enviar uma mensagem eletrónica para reinício da palavra-passe a todos os utilizadores com o correio eletrónico user@example.com.
- api.php?action=resetpassword&user=user@example.com&token=123ABC [abrir na página de testes]
action=revisiondelete
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Eliminar e restaurar revisões.
- type
O tipo de eliminação de revisão que está a ser feito.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: archive, filearchive, logging, oldimage, revision
- target
O título de página para a eliminação da revisão, se for necessário para o tipo de eliminação.
- ids
Os identificadores das revisões a serem eliminadas.
- Este parâmetro é obrigatório.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- hide
O que deve ser ocultado para cada revisão.
- Valores (separados com | ou alternativas): comment, content, user
- show
O que deve ser mostrado para cada revisão.
- Valores (separados com | ou alternativas): comment, content, user
- suppress
Indica se devem ser suprimidos os dados aos administradores como a todos os restantes utilizadores.
- Um dos seguintes valores: no, nochange, yes
- Padrão: nochange
- reason
O motivo da eliminação ou restauro.
- tags
Etiquetas a aplicar à entrada no registo de eliminações.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Ocultar o conteúdo da revisão 12345 na página Main Page.
- api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC [abrir na página de testes]
- Ocultar todos os dados na entrada 67890 do registo com o motivo BLP violation.
- api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC [abrir na página de testes]
action=rollback
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Desfazer a última edição da página.
Se o último utilizador que editou a página tiver realizado várias edições consecutivas, elas serão todas revertidas.
- title
O título da página a reverter. Não pode ser usado em conjunto com pageid.
- pageid
O identificador da página a reverter. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- tags
As etiquetas a aplicar à reversão.
- Valores (separados com | ou alternativas):
- user
O nome do utilizador cujas edições vão ser revertidas.
- Este parâmetro é obrigatório.
- Tipo: utilizador, por um de entre nome de utilizador, IP, nome interwikis (p. ex. "prefixo>NomeDeExemplo") e identificador de utilizador (p. ex. "#12345")
- summary
Resumo personalizado da edição. Se estiver vazio, será utilizado o resumo por omissão.
- Padrão: (vazio)
- markbot
Marcar as edições revertidas e a reversão como edições de robôs.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- token
Uma chave "rollback" obtida de action=query&meta=tokens
Para efeitos de compatibilidade, a chave usada na interface da Internet também é aceite.
- Este parâmetro é obrigatório.
- Reverter as últimas edições da página Main Page pelo utilizador Example.
- api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [abrir na página de testes]
- Reverter as últimas edições da página Main Page pelo utilizador IP 192.0.2.5 com o resumo Reverting vandalism, e marcar essas edições e a reversão como edições de robôs.
- api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [abrir na página de testes]
action=rsd
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Exportar um esquema (schema) RSD (Really Simple Discovery).
- Exportar o esquema RSD.
- api.php?action=rsd [abrir na página de testes]
action=setnotificationtimestamp
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Atualizar a data e hora de notificação de alterações às páginas vigiadas.
Isto afeta o realce das páginas alteradas, na lista de páginas vigiadas e no histórico, e o envio de mensagens de correio quando a preferência "Notificar-me por correio eletrónico quando uma página ou ficheiro vigiado for alterado" está ativada.
- entirewatchlist
Trabalhar em todas as páginas vigiadas.
- Tipo: booliano (detalhes)
- timestamp
A data e hora a definir como data e hora da notificação.
- Tipo: data e hora (formatos permitidos)
- torevid
A revisão para a qual definir a data e hora de notificação (só uma página).
- Tipo: inteiro
- newerthanrevid
A revisão da qual definir que a data e hora de notificação é mais recente (só uma página).
- Tipo: inteiro
- continue
Quando houver mais resultados disponíveis, usar isto para continuar
- titles
Uma lista dos títulos a serem trabalhados.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revids
Uma lista dos identificadores de revisões a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- generator
Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.
Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categorymembers
- Listar todas as páginas numa categoria específica.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- search
- Efetuar uma pesquisa do texto integral.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.
- Tipo: booliano (detalhes)
- converttitles
Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Reiniciar o estado de notificação de todas as páginas vigiadas.
- api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [abrir na página de testes]
- Reiniciar o estado de notificação da página Main page.
- api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [abrir na página de testes]
- Definir a data e hora de notificação para a página Main page de forma a que todas as edições desde 1 de janeiro de 2012 passem a ser consideradas não vistas
- api.php?action=setnotificationtimestamp&titles=Main_page×tamp=2012-01-01T00:00:00Z&token=123ABC [abrir na página de testes]
- Reiniciar o estado de notificação das páginas no espaço nominal Utilizador.
- api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [abrir na página de testes]
action=setpagelanguage
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar a língua de uma página.
Não é permitido alterar a língua de uma página nesta wiki.
Ativar $wgPageLanguageUseDB para usar esta operação.
- title
O título da página cuja língua pretende alterar. Não pode ser usado em conjunto com pageid.
- pageid
O identificador da página cuja língua pretende alterar. Não pode ser usado em conjunto com title.
- Tipo: inteiro
- lang
O código de língua, da língua para a qual a página será alterada. Usar default para redefinir a língua da página para a língua padrão de conteúdo da wiki.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: ab, abs, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, alt, am, ami, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, ban, bar, bbc, bbc-latn, bcc, bcl, be, be-tarask, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, btm, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, default, din, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, es-formal, et, eu, ext, fa, ff, fi, fit, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gcr, gd, gl, glk, gn, gom, gom-deva, gom-latn, gor, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, hr, hrx, hsb, ht, hu, hu-formal, hy, hyw, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kg, khw, ki, kiu, kjp, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lld, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mhr, mi, min, mk, ml, mn, mni, mnw, mo, mr, mrj, ms, mt, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, niu, nl, nl-informal, nn, nov, nqo, nrm, nso, nv, ny, nys, oc, olo, om, or, os, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qu, qug, rgn, rif, rm, rmy, ro, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shn, shy-latn, si, sk, skr, skr-arab, sl, sli, sm, sma, smn, sn, so, sq, sr, sr-ec, sr-el, srn, ss, st, stq, sty, su, sv, sw, szl, szy, ta, tay, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tpi, tr, tru, trv, ts, tt, tt-cyrl, tt-latn, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, xsy, yi, yo, yue, za, zea, zgh, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu
- reason
Motivo da alteração.
- tags
As etiquetas de modificação a aplicar à entrada no registo que resultar desta operação.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Alterar a língua da página Main Page para basco.
- api.php?action=setpagelanguage&title=Main%20Page&lang=eu&token=123ABC [abrir na página de testes]
- Alterar a língua da página com o identificador 123 para a língua padrão de conteúdo da wiki.
- api.php?action=setpagelanguage&pageid=123&lang=default&token=123ABC [abrir na página de testes]
action=stashedit
- Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Preparar uma edição na cache partilhada.
É pretendido que isto seja usado através de AJAX a partir do formulário de edição, para melhorar o desempenho da gravação da página.
- title
Título da página que está a ser editada.
- Este parâmetro é obrigatório.
- section
Número da secção. 0 para a secção do topo, new para uma secção nova.
- sectiontitle
O título para uma secção nova.
- text
O conteúdo da página.
- stashedtexthash
O resumo criptográfico do conteúdo da página, resultante de uma colocação anterior na área de ficheiros escondidos, a ser usado em vez de outro.
- summary
O resumo da mudança.
- Padrão: (vazio)
- contentmodel
O modelo de conteúdo do novo conteúdo.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: css, javascript, json, text, wikitext
- contentformat
O formato de seriação do conteúdo usado para o texto de entrada.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: application/json, text/css, text/javascript, text/plain, text/x-wiki
- baserevid
O identificador de revisão da revisão de base.
- Este parâmetro é obrigatório.
- Tipo: inteiro
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
action=tag
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.
- rcid
Um ou mais identificadores de mudanças recentes às quais adicionar ou remover a etiqueta.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revid
Um ou mais identificadores de revisões às quais adicionar ou remover a etiqueta.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- logid
Um ou mais identificadores de entradas do registo às quais adicionar ou remover a etiqueta.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- add
As etiquetas a serem adicionadas. Só podem ser adicionadas as etiquetas definidas manualmente.
- Valores (separados com | ou alternativas):
- remove
As etiquetas a serem removidas. Só podem ser removidas as etiquetas definidas manualmente ou completamente indefinidas.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- reason
O motivo da alteração.
- Padrão: (vazio)
- tags
As etiquetas de modificação a aplicar à entrada no registo que será criada em resultado desta operação.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Adicionar a etiqueta vandalism à revisão com o identificador 123, sem especificar um motivo.
- api.php?action=tag&revid=123&add=vandalism&token=123ABC [abrir na página de testes]
- Remover a etiqueta spam da entrada do registo com o identificador 123, com o motivo Wrongly applied.
- api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [abrir na página de testes]
action=tokens
- Este módulo foi descontinuado.
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Obter chaves para operações de modificação de dados.
Este módulo foi descontinuado e substituído por action=query&meta=tokens.
- type
Tipos de chave a pedir.
- Valores (separados com | ou alternativas): block, createaccount, csrf, delete, edit, email, import, login, move, options, patrol, protect, rollback, unblock, userrights, watch
- Padrão: edit
- Obter uma chave de edição (padrão).
- api.php?action=tokens [abrir na página de testes]
- Obter uma chave de correio eletrónico e uma chave de movimentação.
- api.php?action=tokens&type=email|move [abrir na página de testes]
action=unblock
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Desbloquear um utilizador.
- id
Identificador do bloqueio a desfazer (obtido com list=blocks). Não pode ser usado em conjunto com user.
- Tipo: inteiro
- user
O utilizador a desbloquear. Não pode ser usado em conjunto com id.
- Tipo: utilizador, por um de entre nome de utilizador, IP, gama de endereços IP e identificador de utilizador (p. ex. "#12345")
- userid
- Obsoleto.
Especificar antes user=#ID.
- Tipo: inteiro
- reason
Motivo para o desbloqueio.
- Padrão: (vazio)
- tags
As etiquetas de modificação a aplicar à entrada no registo de bloqueios.
- Valores (separados com | ou alternativas):
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Desfazer o bloqueio com o identificador #105.
- api.php?action=unblock&id=105 [abrir na página de testes]
- Desbloquear o utilizador Bob com o motivo Sorry Bob.
- api.php?action=unblock&user=Bob&reason=Sorry%20Bob [abrir na página de testes]
action=undelete
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Restaurar revisões de uma página eliminada.
Pode obter-se uma lista de revisões eliminadas (incluindo as datas e horas de eliminação) com prop=deletedrevisions e uma lista de identificadores de ficheiros eliminados com list=filearchive.
- title
Título da página a restaurar.
- Este parâmetro é obrigatório.
- reason
Motivo para restaurar a página.
- Padrão: (vazio)
- tags
Etiquetas de modificação a aplicar à entrada no registo de eliminações.
- Valores (separados com | ou alternativas):
- timestamps
As datas e horas das revisões a serem restauradas. Se ambos os parâmetros timestamps e fileids estiverem vazios, serão restauradas todas as revisões.
- Tipo: lista de datas e horas (formatos permitidos)
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- fileids
Os identificadores das revisões a serem restauradas. Se ambos os parâmetros timestamps e fileids estiverem vazios, serão restauradas todas as revisões.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, unwatch, watch
- Padrão: preferences
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Restaurar a página Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page [abrir na página de testes]
- Restaurar duas revisões da página Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC×tamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z [abrir na página de testes]
action=unlinkaccount
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Remover do utilizador atual uma conta ligada de uma wiki terceira.
- request
Usar este pedido de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=unlink.
- Este parâmetro é obrigatório.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Tentar remover a ligação do utilizador atual ao fornecedor associado com FooAuthenticationRequest.
- api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [abrir na página de testes]
action=upload
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Carregar um ficheiro, ou obter o estado dos carregamentos pendentes.
Estão disponíveis vários métodos:
- Carregar diretamente o conteúdo do ficheiro, usando o parâmetro file.
- Carregar o ficheiro por segmentos, usando os parâmetros filesize, chunk e offset.
- Instruir o servidor do MediaWiki para obter o ficheiro a partir de um URL, usando o parâmetro url.
- Terminar um carregamento anterior que falhou devido a avisos, usando o parâmetro filekey.
Note que o POST do HTTP tem de ser feito como um carregamento de ficheiro (isto é, usando multipart/form-data
) ao enviar o file.
- filename
O nome de destino do ficheiro.
- comment
O comentário do carregamento. Também é usado como texto da página inicial para ficheiros novos se text não for especificado.
- Padrão: (vazio)
- tags
Etiquetas de modificação a aplicar à entrada do carregamento no registo e à revisão da página de ficheiro.
- Valores (separados com | ou alternativas):
- text
Texto inicial da página para ficheiros novos.
- watch
- Obsoleto.
Vigiar a página.
- Tipo: booliano (detalhes)
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- Um dos seguintes valores: nochange, preferences, watch
- Padrão: preferences
- ignorewarnings
Ignorar todos os avisos.
- Tipo: booliano (detalhes)
- file
O conteúdo do ficheiro.
- Deve ser postado como um upload de arquivo usando multipart/form-data.
- url
O URL de onde obter o ficheiro.
- filekey
Chave que identifica um carregamento prévio que está temporariamente na área de ficheiros escondidos.
- sessionkey
- Obsoleto.
O mesmo que filekey, mantido para compatibilidade com versões anteriores.
- stash
Se definido, o servidor irá colocar temporariamente o ficheiro na área de ficheiros escondidos em vez de o adicionar ao repositório.
- Tipo: booliano (detalhes)
- filesize
O tamanho do carregamento completo.
- Tipo: inteiro
- O valor deve estar entre 0 e 104 857 600.
- offset
Posição do segmento em bytes.
- Tipo: inteiro
- O valor não pode ser inferior a 0.
- chunk
O conteúdo do segmento.
- Deve ser postado como um upload de arquivo usando multipart/form-data.
- async
Tornar assíncronas as operações sobre ficheiros possivelmente grandes, quando possível.
- Tipo: booliano (detalhes)
- checkstatus
Obter só o estado de carregamento para a chave de ficheiro indicada.
- Tipo: booliano (detalhes)
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Carregar de um URL.
- api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC [abrir na página de testes]
- Prosseguir um carregamento que falhou devido a avisos.
- api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC [abrir na página de testes]
action=userrights
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar os grupos a que um utilizador pertence.
- user
Utilizador.
- Tipo: utilizador, por um de entre nome de utilizador e identificador de utilizador (p. ex. "#12345")
- userid
- Obsoleto.
Especificar antes user=#ID.
- Tipo: inteiro
- add
Adicionar o utilizador a estes grupos ou, se já for membro de um grupo, atualizar a data de expiração da sua pertença a esse grupo.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- expiry
Datas e horas de expiração. Podem ser relativas (por exemplo, 5 meses ou 2 semanas) ou absolutas (p. ex., 2014-09-18T12:34:56Z). Se só estiver definida uma data e hora, ela será usada para todos os grupos passados ao parâmetro add. Use infinite, indefinite, infinity ou never quando a pertença a um grupo não tem expiração.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- Padrão: infinite
- remove
Remover o utilizador destes grupos.
- Valores (separados com | ou alternativas): bot, bureaucrat, emailconfirmed, interface-admin, suppress, sysop
- reason
O motivo da alteração.
- Padrão: (vazio)
- token
Uma chave "userrights" obtida de action=query&meta=tokens
Para efeitos de compatibilidade, a chave usada na interface da Internet também é aceite.
- Este parâmetro é obrigatório.
- tags
Etiquetas de modificação a aplicar à entrada no registo de privilégios de utilizadores.
- Valores (separados com | ou alternativas):
- Adicionar o utilizador FooBot ao grupo bot e removê-lo dos grupos sysop e bureaucrat.
- api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [abrir na página de testes]
- Adicionar o utilizador com o identificador 123 ao grupo bot e removê-lo dos grupos sysop e bureaucrat.
- api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [abrir na página de testes]
- Adicionar o utilizador SometimeSysop ao grupo sysop por 1 mês.
- api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [abrir na página de testes]
action=validatepassword
- Este módulo requer direitos de leitura.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Validar uma palavra-passe face às regras para palavras-passe da wiki.
A validade é reportada Good (Boa) se a palavra-passe é aceitável, Change (Alterar) se a palavra-passe pode ser usada para iniciar uma sessão mas terá de ser alterada, ou Invalid (Inválida) se a palavra-passe não é utilizável.
- password
A palavra-passe a ser validada.
- Este parâmetro é obrigatório.
- user
O nome de utilizador, para ser usado ao testar a criação de conta. O nome de utilizador não pode existir.
- Tipo: utilizador, por um de entre nome de utilizador e identificador de utilizador (p. ex. "#12345")
O endereço de correio eletrónico, para ser usado ao testar a criação de conta.
- realname
O nome verdadeiro, para ser usado ao testar a criação de conta.
- Validar a palavra-passe foobar para o utilizador atual.
- api.php?action=validatepassword&password=foobar [abrir na página de testes]
- Validar a palavra-passe qwerty para a criação do utilizador Example.
- api.php?action=validatepassword&password=querty&user=Example [abrir na página de testes]
action=visualeditor
- Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
- Este módulo requer direitos de leitura.
- Fonte: VisualEditor
- Licença: MIT
Devolve o HTML5 para uma página a partir do serviço Parsoid.
- page
A página na qual serão realizadas as operações.
- Este parâmetro é obrigatório.
- badetag
Se a consulta RESTBase devolveu uma ETag aparentemente inválida, passe-a aqui para fins de registo.
- format
O formato do resultado.
- Um dos seguintes valores: json, jsonfm
- Padrão: jsonfm
- paction
Operação a executar.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: metadata, parse, parsedoc, parsefragment, templatesused, wikitext
- wikitext
Texto wiki a enviar ao Parsoid, para converter em HTML (paction=parsefragment).
- section
A secção na qual serão realizadas as operações.
- stash
Ao gravar, defina este parâmetro como verdadeiro para usar a API da área de ficheiros escondidos.
- oldid
O número da revisão (por omissão, a revisão mais recente).
- editintro
Editar a introdução para adicionar aos avisos.
- pst
Gravar o texto wiki transformado, antes de enviá-lo ao Parsoid (paction=parsefragment).
- Tipo: booliano (detalhes)
- preload
A página cujo conteúdo será utilizado se a página obtida ainda não tem conteúdo.
- preloadparams
Parâmetros a substituir na página pré-carregada, se estiverem presentes.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
action=visualeditoredit
- Este módulo é interno ou instável. O seu funcionamento pode ser alterado sem aviso prévio.
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: VisualEditor
- Licença: MIT
Gravar no MediaWiki uma página HTML5 (convertida para texto wiki através do serviço Parsoid).
- paction
Operação a executar.
- Este parâmetro é obrigatório.
- Um dos seguintes valores: diff, save, serialize, serializeforcache
- page
A página na qual serão realizadas as operações.
- Este parâmetro é obrigatório.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- wikitext
O texto wiki para ser utilizado.
- section
A secção na qual serão realizadas as operações.
- sectiontitle
Título para a nova secção.
- basetimestamp
Ao gravar, defina aqui a data e hora da revisão editada. Usado para detetar conflitos de edição.
- starttimestamp
Ao gravar, defina aqui a data e hora em que a página foi carregada. Usado para detetar conflitos de edição.
- oldid
O número de revisão a utilizar. Por padrão, é a última revisão. Use 0 para uma página nova.
- minor
Sinalização para edição menor.
- watchlist
Adicionar ou remover incondicionalmente a página da lista de páginas vigiadas do utilizador atual, usar as preferências ou não alterar o estado de vigilância.
- html
HTML a enviar ao Parsoid, para obter o texto wiki equivalente.
- etag
ETag para enviar.
- summary
Resumo da edição.
- captchaid
Identificador do captcha (ao gravar a resposta a um captcha).
- captchaword
Resposta ao captcha (ao gravar a resposta a um captcha).
- cachekey
Use o resultado de um pedido "serializeforcache" prévio com esta chave. Substitui html.
- tags
Altere as etiquetas para aplicar à edição.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
action=watch
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.
- title
- Obsoleto.
A página a vigiar ou deixar de ser vigiada. Em vez disto, usar titles.
- unwatch
Se definido, a página deixará de ser vigiada, em vez de o ser.
- Tipo: booliano (detalhes)
- continue
Quando houver mais resultados disponíveis, usar isto para continuar
- titles
Uma lista dos títulos a serem trabalhados.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- pageids
Uma lista dos identificadores de página a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- revids
Uma lista dos identificadores de revisões a serem trabalhados.
- Tipo: lista de inteiros
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes permitidos limites mais altos).
- generator
Obter a lista de páginas nas quais trabalhar, executando o módulo de consulta especificado.
Nota: Os nomes dos parâmetros de geradores têm de ser prefixados com um "g", veja os exemplos.
- allcategories
- Enumerar todas as categorias.
- alldeletedrevisions
- Listar todas as revisões eliminadas por um utilizador ou de um espaço nominal.
- allfileusages
- Listar todas as utilizações de ficheiros, incluindo ficheiros que não existam.
- allimages
- Enumerar todas as imagens sequencialmente.
- alllinks
- Enumerar todas as hiperligações que apontam para um determinado espaço nominal.
- allpages
- Enumerar sequencialmente todas as páginas de um determinado espaço nominal.
- allredirects
- Listar todos os redirecionamentos para um espaço nominal.
- allrevisions
- Listar todas as revisões.
- alltransclusions
- Listar todas as transclusões (páginas incorporadas utilizando {{x}}), incluindo as que estejam em falta.
- backlinks
- Encontrar todas as páginas que contêm hiperligações para a página indicada.
- categories
- Listar todas as categorias às quais as páginas pertencem.
- categorymembers
- Listar todas as páginas numa categoria específica.
- deletedrevisions
- Obter informações sobre as revisões eliminadas.
- duplicatefiles
- Listar todos os ficheiros que são duplicados dos ficheiros indicados com base no seu resumo criptográfico.
- embeddedin
- Encontrar todas as páginas que incorporam (transcluem) o título indicado.
- exturlusage
- Enumerar as páginas que contêm um determinado URL.
- fileusage
- Encontrar todas as páginas que usam os ficheiros indicados.
- images
- Devolve todos os ficheiros contidos nas páginas indicadas.
- imageusage
- Encontrar todas as páginas que utilizam o título da imagem indicada.
- iwbacklinks
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- langbacklinks
- Encontrar todas as páginas que contêm hiperligações para a hiperligação interlínguas indicada.
- links
- Devolve todas as hiperligações das páginas indicadas.
- linkshere
- Encontrar todas as páginas que contêm hiperligações para as páginas indicadas.
- pageswithprop
- Listar todas as páginas que usam uma determinada propriedade.
- prefixsearch
- Realizar uma procura de prefixo nos títulos de página.
- protectedtitles
- Listar todos os títulos cuja criação está impedida.
- querypage
- Obter uma lista fornecida por uma página especial baseada em consultas (QueryPage).
- random
- Obter um conjunto de páginas aleatórias.
- recentchanges
- Enumerar as mudanças recentes.
- redirects
- Devolve todos os redirecionamentos para as páginas indicadas.
- revisions
- Obter informação da revisão.
- search
- Efetuar uma pesquisa do texto integral.
- templates
- Devolve todas as páginas que são transcluídas nas páginas indicadas.
- transcludedin
- Obter todas as páginas que transcluem as páginas indicadas.
- watchlist
- Obter mudanças recentes das páginas vigiadas do utilizador atual.
- watchlistraw
- Obter todas as páginas na lista de páginas vigiadas do utilizador atual.
- Um dos seguintes valores: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
Resolver automaticamente os redirecionamentos listados nos parâmetros titles, pageids e revids, e nas páginas devolvidas por generator.
- Tipo: booliano (detalhes)
- converttitles
Converter os títulos noutras variantes de língua, se necessário. Só funciona se a língua de conteúdo da wiki suporta a conversão entre variantes. As línguas que suportam conversão entre variantes incluem en, crh, gan, iu, kk, ku, shi, sr, tg, uz e zh.
- Tipo: booliano (detalhes)
- token
Uma chave "watch" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Vigiar a página Main Page.
- api.php?action=watch&titles=Main_Page&token=123ABC [abrir na página de testes]
- Deixar de vigiar a página Main Page.
- api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC [abrir na página de testes]
- Vigiar as primeiras páginas do espaço nominal principal.
- api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC [abrir na página de testes]
format=json
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída no formato JSON.
- callback
Se especificado, envolve o resultado de saída na forma de uma chamada para uma função. Por segurança, todos os dados específicos do utilizador estarão restringidos.
- utf8
Se especificado, codifica a maioria dos caracteres não ASCII (mas não todos) em UTF-8, em vez de substitui-los por sequências de escape hexadecimais. É o comportamento padrão quando formatversion não tem o valor 1.
- Tipo: booliano (detalhes)
- ascii
Se especificado, codifica todos caracteres não ASCII usando sequências de escape hexadecimais. É o comportamento padrão quando formatversion tem o valor 1.
- Tipo: booliano (detalhes)
- formatversion
Formatação do resultado de saída:
- 1
- Formato compatível com versões anteriores (boolianos ao estilo XML, * chaves para nodos de conteúdo, etc.).
- 2
- Formato moderno.
- latest
- Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
- Um dos seguintes valores: 1, 2, latest
- Padrão: 1
- Devolver o resultado da consulta no formato JSON.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=json [abrir na página de testes]
format=jsonfm
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída em formato JSON (realce sintático em HTML).
- wrappedhtml
Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.
- Tipo: booliano (detalhes)
- callback
Se especificado, envolve o resultado de saída na forma de uma chamada para uma função. Por segurança, todos os dados específicos do utilizador estarão restringidos.
- utf8
Se especificado, codifica a maioria dos caracteres não ASCII (mas não todos) em UTF-8, em vez de substitui-los por sequências de escape hexadecimais. É o comportamento padrão quando formatversion não tem o valor 1.
- Tipo: booliano (detalhes)
- ascii
Se especificado, codifica todos caracteres não ASCII usando sequências de escape hexadecimais. É o comportamento padrão quando formatversion tem o valor 1.
- Tipo: booliano (detalhes)
- formatversion
Formatação do resultado de saída:
- 1
- Formato compatível com versões anteriores (boolianos ao estilo XML, * chaves para nodos de conteúdo, etc.).
- 2
- Formato moderno.
- latest
- Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
- Um dos seguintes valores: 1, 2, latest
- Padrão: 1
- Devolver o resultado da consulta no formato JSON.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm [abrir na página de testes]
format=none
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Não produzir nada.
- Devolver o resultado da consulta no formato NONE.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=none [abrir na página de testes]
format=php
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída em formato PHP seriado.
- formatversion
Formatação do resultado de saída:
- 1
- Formato compatível com versões anteriores (boolianos ao estilo XML, * chaves para nodos de conteúdo, etc.).
- 2
- Formato moderno.
- latest
- Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
- Um dos seguintes valores: 1, 2, latest
- Padrão: 1
- Devolver o resultado da consulta no formato PHP.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=php [abrir na página de testes]
format=phpfm
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída em formato PHP seriado (realce sintático em HTML).
- wrappedhtml
Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.
- Tipo: booliano (detalhes)
- formatversion
Formatação do resultado de saída:
- 1
- Formato compatível com versões anteriores (boolianos ao estilo XML, * chaves para nodos de conteúdo, etc.).
- 2
- Formato moderno.
- latest
- Usar o formato mais recente (atualmente 2), mas pode ser alterado sem aviso prévio.
- Um dos seguintes valores: 1, 2, latest
- Padrão: 1
- Devolver o resultado da consulta no formato PHP.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm [abrir na página de testes]
format=rawfm
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída, incluindo elementos para despiste de erros, em formato JSON (realce sintático em HTML).
- wrappedhtml
Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.
- Tipo: booliano (detalhes)
- Devolver o resultado da consulta no formato RAW.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm [abrir na página de testes]
format=xml
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída em formato XML.
- xslt
Se especificado, adiciona a página nomeada como uma folha de estilo XSL. O valor tem de ser um título no espaço nominal MediaWiki e acabar em
.xsl
.- includexmlnamespace
Se especificado, adiciona um espaço nominal XML.
- Tipo: booliano (detalhes)
- Devolver o resultado da consulta no formato XML.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml [abrir na página de testes]
format=xmlfm
- Este módulo requer direitos de leitura.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Produzir os dados de saída em formato XML (realce sintático em HTML).
- wrappedhtml
Devolver o HTML com realce sintático e os módulos ResourceLoader associados, na forma de um objeto JSON.
- Tipo: booliano (detalhes)
- xslt
Se especificado, adiciona a página nomeada como uma folha de estilo XSL. O valor tem de ser um título no espaço nominal MediaWiki e acabar em
.xsl
.- includexmlnamespace
Se especificado, adiciona um espaço nominal XML.
- Tipo: booliano (detalhes)
- Devolver o resultado da consulta no formato XML.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm [abrir na página de testes]
Tipo de dados
Os dados de entrada do MediaWiki devem estar no formato UTF-8 na forma normalizada NFC. O MediaWiki pode tentar converter outros formatos, mas esta conversão pode causar a falha de algumas operações (tais como edições com verificações MD5).
Os parâmetros que aceitam mais do que um valor são normalmente fornecidos com os valores separados por uma barra vertical (pipe), por exemplo parâmetro=valor1|valor2 ou parâmetro=valor1%7Cvalor2. Se um valor tiver de conter a barra vertical, use U+001F (separador de unidades) como separador e prefixe o valor com U+001F, por exemplo parâmetro=%1Fvalor1%1Fvalor2.
Alguns tipos de parâmetros nos pedidos da API requerem mais explicações.
- boolean
Os parâmetros boolianos funcionam tal como as caixas de seleção em HTML: se o parâmetro for especificado, independentemente do seu valor, é considerado verdadeiro. Para especificar um valor falso, omita completamente o parâmetro.
- expiry
Os valores de expiração podem ser relativos (p. ex. 5 meses ou 2 semanas) ou absolutos (p. ex. 2014-09-18T12:34:56Z). Para não haver expiração use infinite (infinito), indefinite (indefinido), infinity (infinidade) ou never (nunca).
- timestamp
Datas e horas podem ser especificadas em vários formatos (consulte os formatos de entrada para datas e horas documentados em mediawiki.org para obter mais detalhes). É recomendada a utilização do formato de data e hora ISO 8601: 2001-01-15T14:56:00Z. Adicionalmente, pode ser usado o texto now para especificar a data e hora atual.
Parâmetros modelados
Os parâmetros modelados usam-se nos casos em que um módulo da API necessita de um valor para cada valor de um outro parâmetro. Por exemplo, se existisse um módulo da API para encomendar fruta, poderia ter um parâmetro frutas para especificar as frutas que estão a ser encomendadas e um parâmetro modelado quantidade-de-{fruta} para especificar quanto de cada fruta. Um cliente da API que pretenda 1 maçã, 5 bananas e 20 morangos pode então fazer um pedido como frutas=maçãs|bananas|morangos&quantidade-de-maçãs=1&quantidade-de-bananas=5&quantidade-de-morangos=20.
Créditos
Programadores da API:
- Yuri Astrakhan (criador, programador principal, set 2006–set 2007)
- Roan Kattouw (programador principal, set 2007–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (programador principal, 2013–presente)
Pode enviar os seus comentários, sugestões e perguntas para o endereço mediawiki-api@lists.wikimedia.org, ou reportar quaisquer defeitos que encontre em https://phabricator.wikimedia.org/.