API:Allrevisions

From MediaWiki.org
Jump to navigation Jump to search
This page is part of the MediaWiki action API documentation.


MediaWiki action API

v · d · e
Allrevisions
List all revisions.
This module can be used as a GeneratorAPI:generator.
Prefix arv
Required rights none
Post only? No
Generated help Current
Version added
≥ 1.27

List all revisions by a user or in a namespace.

Parameters[edit]

  • arvprop: Which properties to get for each revision: (Default: ids|timestamp|flags|comment|user)
    • ids: The ID of the revision.
    • flags: Revision flags (minor).
    • timestamp: The timestamp of the revision.
    • user: User that made the revision.
    • userid: User ID of the revision creator.
    • size: Length (bytes) of the revision.
    • sha1: SHA-1 (base 16) of the revision.
    • contentmodel: Content model ID of the revision.
    • comment: Comment by the user for the revision.
    • parsedcomment: Parsed comment by the user for the revision.
    • content: Text of the revision.
    • tags: Tags for the revision.
    • parsetree: The XML parse tree of revision content (requires content model wikitext). (Deprecated in 1.30)
  • arvlimit: Limit how many revisions will be returned. No more than 500 (5000 for bots) allowed. (Default: 10 (1 with content property))
  • arvexpandtemplates: Expand templates in revision content (requires arvprop=content). (Deprecated in 1.30)
  • arvgeneratexml: Deprecated. Generate XML parse tree for revision content (requires arvprop=content; replaced by arvprop=parsetree). (Deprecated in 1.26)
  • arvparse: Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1. (Deprecated in 1.30)
  • arvsection: Only retrieve the content of this section number.
  • arvdiffto: Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively. (Deprecated in 1.30)
  • arvdifftotext: Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text. (Deprecated in 1.30)
  • arvdifftotextpst: Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext. 1.27+ (Deprecated in 1.30)
  • arvcontentformat: Serialization format used for arvdifftotext and expected for output of content. Possible values: application/json, text/x-wiki, text/javascript, text/css, text/plain.
  • arvuser: Only list revisions by this user.
  • arvnamespace: Only list pages in this namespace.
  • arvstart: The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
  • arvend: The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
  • arvdir: In which direction to enumerate: (Default: older)
    • newer: List oldest first. Note: arvstart has to be before arvend.
    • older: List newest first. Note: arvstart has to be later than arvend.
  • arvexcludeuser: Don't list revisions by this user.
  • arvcontinue: When more results are available, use this to continue.
  • arvgeneratetitles: When being used as a generator, generate titles rather than revision IDs. For example, if looking at the edits a particular user made, prop=revisions would, by default, return the latest revision from the pages that user edited, rather than the specific revisions they made.

Example[edit]

Get a list of all revisions by user Place holder on the English Wikipedia.

api.php?action=query&list=allrevisions&arvuser=Place%20holder&arvprop=ids|flags|timestamp [try in ApiSandbox]
Result 
{
    "batchcomplete": "",
    "query": {
        "allrevisions": [
            {
                "pageid": 36757881,
                "revisions": [
                    {
                        "revid": 679803046,
                        "parentid": 656413943,
                        "timestamp": "2015-09-06T21:35:42Z"
                    },
                    {
                        "revid": 159361827,
                        "parentid": 0,
                        "timestamp": "2007-09-21T10:35:22Z"
                    }
                ],
                "ns": 3,
                "title": "User talk:Place holder"
            },
            {
                "pageid": 352651,
                "revisions": [
                    {
                        "revid": 453775311,
                        "parentid": 453769432,
                        "timestamp": "2011-10-03T21:23:36Z"
                    }
                ],
                "ns": 4,
                "title": "Wikipedia:Requests for page protection"
            },
            {
                "pageid": 36757883,
                "revisions": [
                    {
                        "revid": 159361714,
                        "parentid": 0,
                        "timestamp": "2007-09-21T10:34:37Z"
                    }
                ],
                "ns": 2,
                "title": "User:Place holder"
            }
        ]
    }
}

Possible warnings[edit]

  • Couldn't diff to r######: content is hidden
    • Thrown when the revision has been hidden (e.g., using RevisionDelete or Oversight).
  • Conversion to XML is supported for wikitext only, title uses content model content model
    • Thrown when the parsetree property or generatexml parameter is used and the content model (as returned by the content property) is not set to wikitext
  • Template expansion is supported for wikitext only, title uses content model content model
    • Thrown when the expandtemplates parameter is used and the content model (as returned by the content property) is not set to wikitext
  • The requested format contentFormat is not supported for content model model used by name
    • Thrown when the content of either the current revision or one being diffed to is not supported (typically, not text).

Possible errors[edit]

Code Info
arvdiffto arvdiffto must be set to a non-negative number, "prev", "next" or "cur"
arvnosuchrevid There is no revision with ID ID
arvnosuchsection There is no section section in rID



list=allrevisions (arv)

(main | query | allrevisions)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all revisions.

Parameters:
arvprop

Which properties to get for each revision:

ids

The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision.
userid
User ID of the revision creator.
size
Length (bytes) of the revision.
sha1
SHA-1 (base 16) of the revision.
contentmodel
Content model ID of the revision.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Text of the revision.
tags
Tags for the revision.
parsetree

Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
Default: ids|timestamp|flags|comment|user
arvlimit

Limit how many revisions will be returned.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
arvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires arvprop=content).

Type: boolean (details)
arvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires arvprop=content).

Type: boolean (details)
arvparse
Deprecated.

Use action=parse instead. Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.

Type: boolean (details)
arvsection

Only retrieve the content of this section number.

arvdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

arvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.

arvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.

Type: boolean (details)
arvcontentformat

Serialization format used for arvdifftotext and expected for output of content.

One of the following values: application/json, text/css, text/plain, text/x-wiki, text/javascript
arvuser

Only list revisions by this user.

Type: user name
arvnamespace

Only list pages in this namespace.

Note: Due to miser mode, using this may result in fewer than arvlimit results returned before continuing; in extreme cases, zero results may be returned.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600, 5500, 5501
To specify all values, use *.
arvstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
arvend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
arvdir

In which direction to enumerate:

newer
List oldest first. Note: arvstart has to be before arvend.
older
List newest first (default). Note: arvstart has to be later than arvend.
One of the following values: newer, older
Default: older
arvexcludeuser

Don't list revisions by this user.

Type: user name
arvcontinue

When more results are available, use this to continue.

arvgeneratetitles

When being used as a generator, generate titles rather than revision IDs.

Type: boolean (details)
Examples:
List the last 50 contributions by user Example.
api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [open in sandbox]
List the first 50 revisions in the main namespace.
api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [open in sandbox]
Retrieved from "https://www.mediawiki.org/w/index.php?title=API:Allrevisions&oldid=2673287"