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
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.
- associatedpage
- O título prefixado da página associada de conteúdo ou 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.
- linkclasses
- Fornece as classes CSS adicionais (por exemplo, a cor das hiperligações) usadas em hiperligações para esta página se estas aparecessem na página nomeada em inlinkcontext.
- Valores (separados com | ou alternativas): associatedpage, displaytitle, linkclasses, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
- inlinkcontext
O título de contexto a ser usado ao determinar classes CSS extra (por exemplo, a cor das hiperligações) quando inprop contém linkclasses.
- Tipo: título de página
- Aceita páginas que não existem.
- Valor por omissão: Página principal
- 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 a quem são permitidos limites mais elevados).
- 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
- Valor por omissão: boolean
- incontinue
Quando houver mais resultados disponíveis, usar isto para continuar. Podem ser encontradas na wiki mediawiki.org mais informações sobre a aplicação da continuação a consultas.
- Obter informações sobre a página Main Page.
- api.php?action=query&prop=info&titles=P%C3%A1gina%20principal [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=P%C3%A1gina%20principal [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
- Valor por omissã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
- Valor por omissão: page|subcat|file
- cmcontinue
Quando houver mais resultados disponíveis, usar isto para continuar. Podem ser encontradas na wiki mediawiki.org mais informações sobre a aplicação da continuação a consultas.
- cmlimit
O número máximo de páginas a serem devolvidas.
- Tipo: inteiro ou max
- O valor tem de estar entre 1 e 500.
- Valor por omissão: 10
- cmsort
Propriedade pela qual fazer a ordenação.
- Um dos seguintes valores: sortkey, timestamp
- Valor por omissão: sortkey
- cmdir
A direção da ordenação.
- Um dos seguintes valores: asc, ascending, desc, descending, newer, older
- Valor por omissã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]