Aide de l’API MediaWiki

Ceci est une page d’aide de l’API de MediaWiki générée automatiquement.

Documentation et exemples : https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

prop=info (in)

  • Ce module nécessite des droits de lecture.
  • Source : MediaWiki
  • Licence : GPL-2.0-or-later

Obtenir les informations de base sur la page.

Paramètres :
inprop

Quelles propriétés supplémentaires récupérer :

protection
Lister le niveau de protection de chaque page.
talkid
L’ID de la page de discussion de chaque page qui n’est pas de discussion.
watched
Lister l’état de suivi de chaque page.
watchers
Le nombre d’observateurs, si c’est autorisé.
visitingwatchers
Le nombre de personnes suivant chaque page qui ont regardé les modifications récentes de cette page, si c’est autorisé.
notificationtimestamp
L’horodatage de notification de la liste de suivi de chaque page.
subjectid
L’identifiant de page de la page parente de chaque page de discussion.
associatedpage
Le titre préfixé du sujet ou de la page de discussion associé.
url
Fournit une URL complète, une URL de modification, et l’URL canonique de chaque page.
readable
Obsolète. Si l’utilisateur peut lire cette page. Utiliser plutôt intestactions=read.
preload
Fournit le texte renvoyé par EditFormPreloadText.
displaytitle
Fournit la manière dont le titre de la page est réellement affiché.
varianttitles
Donne le titre affiché dans toutes les variantes de la langue de contenu du site.
linkclasses
Fournit des classes CSS supplémentaires (par ex. des couleurs de lien) utilisées pour les liens vers cette page s’ils doivent apparaître sur la page nommée par inlinkcontext.
Valeurs (séparées par | ou autre) : associatedpage, displaytitle, linkclasses, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
inlinkcontext

Le titre du contexte à utiliser pour déterminer les classes CSS supplémentaires (par ex. les couleurs de lien) quand inprop contient linkclasses.

Type : titre de page
Accepte les pages inexistantes.
Par défaut : Accueil
intestactions

Tester si l’utilisateur actuel peut effectuer certaines actions sur la page.

Valeurs séparées par | ou autre.
Le nombre maximal de valeurs est 50 (ou 500 pour les clients ayant droit aux limites plus élevées).
intestactionsdetail

Niveau de détail pour intestactions. Utiliser les paramètres errorformat et errorlang du module principal pour contrôler la mise en forme des messages renvoyés.

boolean
Renvoyer une valeur booléenne pour chaque action.
full
Renvoyer des messages décrivant pourquoi l’action est interdite, ou un tableau vide si elle est autorisée.
quick
Comme full mais en sautant les contrôles coûteux.
Une des valeurs suivantes : boolean, full, quick
Par défaut : boolean
incontinue

Quand plus de résultats sont disponibles, utiliser cela pour continuer.

Exemples :
Obtenir des informations sur la page Main Page.
api.php?action=query&prop=info&titles=Main%20Page [ouvrir dans le bac à sable]
Obtenir des informations générales et de protection sur la page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [ouvrir dans le bac à sable]

list=categorymembers (cm)

  • Ce module nécessite des droits de lecture.
  • Ce module peut être utilisé comme générateur.
  • Source : MediaWiki
  • Licence : GPL-2.0-or-later

Lister toutes les pages d’une catégorie donnée.

Paramètres :
cmtitle

Quelle catégorie énumérer (obligatoire). Doit comprendre le préfixe Catégorie:. Incompatible avec cmpageid.

cmpageid

Identifiant de la page de la catégorie à énumérer. Incompatible avec cmtitle.

Type: entier
cmprop

Quelles informations inclure :

ids
Ajoute l’ID de la page.
title
Ajoute le titre et l’ID de l’espace de noms de la page.
sortkey
Ajoute la clé de tri utilisée pour trier dans la catégorie (chaîne hexadécimale).
sortkeyprefix
Ajoute le préfixe de la clé de tri utilisé pour trier dans la catégorie (partie lisible de la clé de tri).
type
Ajoute le type sous lequel a été catégorisée la page (page, subcat ou file).
timestamp
Ajoute l’horodatage de l’inclusion de la page.
Valeurs (séparées par | ou autre) : ids, sortkey, sortkeyprefix, timestamp, title, type
Par défaut : ids|title
cmnamespace

Inclure uniquement les pages dans ces espaces de nom. Remarquez que cmtype=subcat ou cmtype=file peuvent être utilisés à la place de cmnamespace=14 ou 6.

Valeurs (séparées par | ou autre) : 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
Pour spécifier toutes les valeurs, utiliser *.
cmtype

Quel type de membres de la catégorie inclure. Ignoré quand cmsort=timestamp est défini.

Valeurs (séparées par | ou autre) : file, page, subcat
Par défaut : page|subcat|file
cmcontinue

Quand plus de résultats sont disponibles, utiliser cela pour continuer.

cmlimit

Le nombre maximal de pages à renvoyer.

Type : entier ou max
La valeur doit être entre 1 et 500.
Par défaut : 10
cmsort

Propriété par laquelle trier.

Une des valeurs suivantes : sortkey, timestamp
Par défaut : sortkey
cmdir

Dans quelle direction trier.

Une des valeurs suivantes : asc, ascending, desc, descending, newer, older
Par défaut : ascending
cmstart

Horodatage auquel démarrer la liste. Peut être utilisé uniquement avec cmsort=timestamp.

Type : horodatage (formats autorisés)
cmend

Horodatage auquel terminer la liste. Peut être utilisé uniquement avec cmsort=timestamp.

Type : horodatage (formats autorisés)
cmstarthexsortkey

Clé de tri à laquelle démarrer le listage, telle que renvoyée par cmprop=sortkey. Utilisable uniquement avec cmsort=sortkey.

cmendhexsortkey

Clé de tri à laquelle arrêter le listage, telle que renvoyée par cmprop=sortkey. Utilisable uniquement avec cmsort=sortkey.

cmstartsortkeyprefix

Préfixe de la clé de tri à laquelle démarrer le listage. Utilisable uniquement avec cmsort=sortkey. Écrase cmstarthexsortkey.

cmendsortkeyprefix

Préfixe de la clé de tri avant laquelle se termine le listage (et non pas à ; si cette valeur existe elle ne sera pas incluse !). Utilisable uniquement avec cmsort=sortkey. Écrase cmendhexsortkey.

cmstartsortkey
Obsolète.

Utiliser plutôt cmstarthexsortkey.

cmendsortkey
Obsolète.

Utiliser plutôt cmendhexsortkey.

Exemples :
Obtenir les 10 premières pages de Category:Physics.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics [ouvrir dans le bac à sable]
Obtenir des informations sur les 10 premières pages de Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [ouvrir dans le bac à sable]