API:Deletedrevisions

From MediaWiki.org
Jump to navigation Jump to search

Get deleted revision information. This module can be used as a generator.

This module lists revisions which have been deleted from a page, as you would see in Special:Undelete. It should not be confused with revisions which have been hidden via the Revision Delete feature.

Parameters[edit]

  • drvprop: 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)
    • slotsize: Length (bytes) of each revision slot. 1.32+
    • slotsha1: SHA-1 (base 16) of each revision slot. 1.32+
    • roles: List content slot roles that exist in the revision. 1.32+
  • drvlimit: Limit how many revisions will be returned. No more than 500 (5000 for bots) allowed. (Default: 10 (1 with content property))
  • drvexpandtemplates: Expand templates in revision content (requires drvprop=content). (deprecated in 1.30)
  • drvgeneratexml: Deprecated. Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree). (deprecated in 1.26)
  • drvparse: Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1. (deprecated in 1.30)
  • drvsection: Only retrieve the content of this section number.
  • drvdiffto: Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively. (deprecated in 1.30)
  • drvdifftotext: Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text. (deprecated in 1.30)
  • drvdifftotextpst: Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext. 1.27+ (deprecated in 1.30)
  • drvcontentformat: Serialization format used for drvdifftotext and expected for output of content. Possible values: application/json, text/x-wiki, text/javascript, text/css, text/plain (deprecated in 1.32)
  • drvstart: The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
  • drvend: The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
  • drvdir: In which direction to enumerate: (Default: older)
    • newer: List oldest first. Note: drvstart has to be before drvend.
    • older: List newest first. Note: drvstart has to be later than drvend.
  • drvtag: Only list revisions tagged with this tag.
  • drvuser: Only list revisions by this user.
  • drvexcludeuser: Don't list revisions by this user.
  • drvcontinue: When more results are available, use this to continue.
  • drvslots: Which revision slots to return data for, when slot-related properties are included in drvprops. If omitted, data from the main slot will be returned in a backwards-compatible format. 1.32+

Example[edit]

Get a list of deleted revisions for Talk:Main Page.

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
drvdiffto drvdiffto must be set to a non-negative number, "prev", "next" or "cur"
drvnosuchrevid There is no revision with ID ID
drvnosuchsection There is no section section in rID
drvpermissiondenied You don't have permission to view deleted revision information
adrpermissiondenied You don't have permission to view deleted revision content
drvbadparams user and excludeuser cannot be used together




prop=deletedrevisions (drv)

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

Get deleted revision information.

May be used in several ways:

  1. Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
  2. Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
Parameters:
drvprop

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.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision.
slotsha1
SHA-1 (base 16) of each revision slot.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision.
parsedcomment
Parsed comment by the user for the revision.
content
Content of each revision slot.
tags
Tags for the revision.
roles
List content slot roles that exist in 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, slotsize, sha1, slotsha1, contentmodel, comment, parsedcomment, content, tags, roles, parsetree
Default: ids|timestamp|flags|comment|user
drvslots

Which revision slots to return data for, when slot-related properties are included in drvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
drvlimit

Limit how many revisions will be returned.

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

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

Type: boolean (details)
drvgeneratexml
Deprecated.

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

Type: boolean (details)
drvparse
Deprecated.

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

Type: boolean (details)
drvsection

Only retrieve the content of this section number.

drvdiffto
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.

drvdifftotext
Deprecated.

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

drvdifftotextpst
Deprecated.

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

Type: boolean (details)
drvcontentformat
Deprecated.

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

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

The timestamp to start enumerating from. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvend

The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.

Type: timestamp (allowed formats)
drvdir

In which direction to enumerate:

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

Only list revisions tagged with this tag.

drvuser

Only list revisions by this user.

Type: user name
drvexcludeuser

Don't list revisions by this user.

Type: user name
drvcontinue

When more results are available, use this to continue.

Examples:
List the deleted revisions of the pages Main Page and Talk:Main Page, with content.
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvslots=*&drvprop=user|comment|content [open in sandbox]
List the information for deleted revision 123456.
api.php?action=query&prop=deletedrevisions&revids=123456 [open in sandbox]