API:Deletedrevisions
Deletedrevisions | ||
---|---|---|
Get deleted revision information. This module can be used as a Generator . |
||
Prefix | drv | |
Required rights | deletedhistory | |
Post only? | No | |
Generated help | Current | |
Version added |
|
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 source]
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).
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).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.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.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.drvdifftotextpst
: Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext. 1.27+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
.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.
Example[edit source]
Get a list of deleted revisions for Talk:Main Page.
Result |
---|
{
"query": {
"pages": [
{
"ns": 1,
"title": "Talk:Main Page",
"missing": "",
"deletedrevisions": [
{
"user": "192.168.0.193",
"anon": "",
"comment": "I iz in yer wiki, blanking yer talk pages",
"contentformat": "text/x-wiki",
"contentmodel": "wikitext",
"content": ""
},
]
},
]
}
}
|
Possible warnings[edit source]
- 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 orgeneratexml
parameter is used and the content model (as returned by thecontent
property) is not set to wikitext
- Thrown when the
- 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 thecontent
property) is not set to wikitext
- Thrown when the
- 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 source]
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 |
The following documentation is the output of Special:ApiHelp/query+deletedrevisions, generated from query+deletedrevisions's source code. |
prop=deletedrevisions (drv)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get deleted revision information.
May be used in several ways:
- Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
- Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
- 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.
- 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
).
- Values (separate with | or alternative): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
- Default: ids|timestamp|flags|comment|user
- drvlimit
-
Limit how many revisions will be returned.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- drvexpandtemplates
-
Expand templates in revision content (requires drvprop=content).
- Type: boolean (details)
- drvgeneratexml
- Deprecated.
-
Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).
- Type: boolean (details)
- drvparse
-
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
-
Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- 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.
- drvdifftotextpst
-
Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.
- Type: boolean (details)
- drvcontentformat
-
Serialization format used for drvdifftotext and expected for output of content.
- One of the following values: application/json, text/x-wiki, text/javascript, text/css, text/plain
- 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.
- 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&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]