API:Properties: Difference between revisions

Content deleted Content added

Inline

Revision as of 06:58, 6 July 2008

This page is part of the MediaWiki Action API documentation.

Properties are used to get various data about a list of pages specified with either the titles=, pageids=, or revids= parameters, or by using generators.

info / in

MediaWiki version:

1.9

Gets basic page information

Parameters

inprop: Which properties to get
- protection: The protection level
- talkid: The page ID of the talk page for each non-talk page
- subjectid: The page ID of the parent page for each talk page
- By default, the following properties will be listed:
  - page ID (pageid)
  - namespace (ns)
  - title (title)
  - last touched timestamp (touched)
  - last revision ID (lastrevid)
  - number of views (counter)
  - page size (length)
  - whether the page is a redirect (redirect)
  - whether the page has only one revision (new)

Example

Get info about the en:Albert Einstein page

api.php?action=query&titles=Albert%20Einstein&prop=info&inprop=protection|talkid [try in ApiSandbox]

Result

<?xml version="1.0" encoding="utf-8"?>
<api>
  <query>
    <pages>
      <page
       pageid="736" ns="0" title="Albert Einstein"
       touched="2008-03-27T04:42:56Z" lastrevid="201248286"
       counter="4698" length="81826" talkid="2177">
        <protection>
          <pr type="edit" level="autoconfirmed" expiry="infinity" />
          <pr type="move" level="sysop" expiry="infinity" />
        </protection>
      </page>
    </pages>
  </query>
</api>

Possible errors

None

revisions / rv

MediaWiki version:

1.8

Returns revisions for a given page, or the latest revision for each of several pages. When using parameters marked as (enum), titles= must have only one title listed.

Parameters

rvprop: Which properties to get for each revision
- ids: Revision ID (default)
- flags: Whether the revision was a minor edit (default)
- timestamp: The date and time the revision was made (default)
- user: The user who made the revision (default)
- comment: The edit comment (default)
- size: The size of the revision text in bytes
- content: The revision content. If set, the maximum limit will be 10 times as low
rvlimit: The maximum number of revisions to return (enum)
rvstartid: Revision ID to start listing from. (enum)
rvendid: Revision ID to stop listing at. (enum)
rvstart: Timestamp to start listing from. (enum)
rvend: Timestamp to end listing at. (enum)
rvdir: Direction to list in. (enum)
- older: List newest revisions first (default). NOTE: rvstart/rvstartid has to be higher than rvend/rvendid
- newer: List oldest revisions first. NOTE: rvstart/rvstartid has to be lower than rvend/rvendid
rvuser: Only list revisions made by this user
rvexcludeuser: Do not list revisions made by this user
rvexpandtemplates: Expand templates in rvprop=content output
rvsection: If rvprop=content is set, only retrieve the contents of this section. NOTE: Only implemented in MediaWiki versions 1.13 and above.
rvtoken: Tokens to get for each revision
- rollback: Rollback token

Example

Get data including content for the last revision of titles en:API and en:Main Page

api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="1191" ns="0" title="API">
        <revisions>
          <rev user="Harryboyles" timestamp="2006-10-31T05:39:01Z" comment="revert unexplained change: see talk ...">
            ...content...
          </rev>
        </revisions>
      </page>
      <page pageid="11105676" ns="0" title="Main Page">
        <revisions>
          <rev user="Ryan Postlethwaite" timestamp="2007-06-26T19:05:06Z" comment="rv - what was that for?">
            ...content...
          </rev>
        </revisions>
      </page>
    </pages>
  </query>
</api>

Possible errors

code: rvrevids
- info: The revids= parameter may not be used with the list options (limit, startid, endid, dirNewer, start, end).
code: rvmultpages
- info: titles, pageids or a generator was used to supply multiple pages, but the limit, startid, endid, dirNewer, user, excludeuser, start and end parameters may only be used on a single page.
code: rvaccessdenied
- info: The current user is not allowed to read title
code: rvbadparams
- info: start and startid cannot be used together
code: rvbadparams
- info: end and endid cannot be used together
code: rvbadparams
- info: user and excludeuser cannot be used together
code: rvnosuchsection
- info: There is no section section in rrevid

categories / cl

MediaWiki version:

1.11

Gets a list of all categories used on the provided pages. This module can be used as a generator.

Parameters

clprop: Which properties to get (cannot be used with a generator)
- sortkey: The sort key

Example

Get a list of categories en:Albert Einstein belongs to

api.php?action=query&titles=Albert%20Einstein&prop=categories [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <categories>
          <cl ns="14" title="Category:1879 births" />
          <cl ns="14" title="Category:1955 deaths" />
          <cl ns="14" title="Category:Albert Einstein" />
          ...
        </categories>
      </page>
    </pages>
  </query>
</api>

Possible errors

None

imageinfo / ii

MediaWiki version:

1.11

Gets image information for any titles in the image namespace

Parameters

iiprop: Which properties to get
- timestamp: The time and date of the revision (default)
- user: The user who made the revision (default)
- comment: The edit comment
- url: URL of the image
- size: The image's size in bytes
- sha1: The image's SHA-1 hash
- mime: The image's MIME type
- metadata: Image metadata, if available
- archivename: Archive name (old images only)
iilimit: How many image revisions to return (1 by default)
iistart: Timestamp to start listing from
iiend: Timestamp to stop listing at
iiurlwidth: If iiprop=url is set, a URL to an image scaled to this width will be returned as well. Old versions of images can't be scaled
iiurlheight: Similar to iiurlwidth

Example

Get image information for the en:Image:Albert Einstein Head.jpg. Note that the image page might be missing when the image exists on commons.

api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo [try in ApiSandbox]

Result

<?xml version="1.0" encoding="utf-8"?>
<api>
  <query>
    <pages>
      <page ns="6" title="Image:Albert Einstein Head.jpg" missing="" imagerepository="shared">
        <imageinfo>
          <ii timestamp="2007-10-20T02:29:04Z" user="Rocket000" />
        </imageinfo>
      </page>
    </pages>
  </query>
  <query-continue>
    <imageinfo iistart="20071020022358" />
  </query-continue>
</api>

langlinks / ll

MediaWiki version:

1.9

Gets a list of all language links from the provided pages to other languages.

Parameters

None

Example

Get a list of language links en:Albert Einstein has

api.php?action=query&titles=Albert%20Einstein&prop=langlinks [try in ApiSandbox]

Result

<?xml version="1.0" encoding="utf-8"?>
<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <langlinks>
          <ll lang="af">Albert Einstein</ll>
          <ll lang="als">Albert Einstein</ll>
          <ll lang="an">Albert Einstein</ll>
          <ll lang="ar">ألبرت أينشتاين</ll>
          <ll lang="ast">Albert Einstein</ll>
          <ll lang="az">Albert Eynşteyn</ll>
          ...
        </langlinks>
      </page>
    </pages>
  </query>
</api>

Possible errors

None

links / pl

MediaWiki version:

1.9

Gets a list of all links on the provided pages. This module can be used as a generator.

Parameters

plnamespace: Only list links to pages in these namespaces

Example

Get a list of links on en:Albert Einstein

api.php?action=query&titles=Albert%20Einstein&prop=links [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <links>
          <pl ns="0" title="1879" />
          <pl ns="0" title="1901" />
          ...
          <pl ns="0" title="Albert Einstein: The Practical Bohemian" />
          <pl ns="0" title="Albert Einstein Archives" />
          <pl ns="0" title="Albert Einstein Award" />
          <pl ns="0" title="Albert Einstein Foundation for Higher Learning, Inc." />
          <pl ns="0" title="Albert Einstein Memorial" />
          <pl ns="0" title="Albert Einstein Peace Prize" />
          ...
          <pl ns="0" title="Zurich" />
          <pl ns="4" title="Wikipedia:Citing sources" />
          <pl ns="4" title="Wikipedia:Media help" />
          <pl ns="4" title="Wikipedia:Persondata" />
          <pl ns="4" title="Wikipedia:Protection policy" />
          <pl ns="4" title="Wikipedia:Sister projects" />
          <pl ns="6" title="Image:Albert Einstein german.ogg" />
          <pl ns="10" title="Template:Nobel Prize in Physics" />
          ...
          <pl ns="10" title="Template:Nobel Prize in Physics Laureates 2001-2025" />
          <pl ns="11" title="Template talk:Nobel Prize in Physics Laureates 1901-1925" />
        </links>
      </page>
    </pages>
  </query>
</api>

Possible errors

None

templates / tl

MediaWiki version:

1.9

Gets a list of all pages included in the provided pages. This module can be used as a generator.

Parameters

tlnamespace: Only list pages in these namespaces

Example

Get a list of templates used on en:Albert Einstein's page

api.php?action=query&titles=Albert%20Einstein&prop=templates [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <templates>
          <tl ns="10" title="Template:Academia" />
          <tl ns="10" title="Template:Age at date" />
          <tl ns="10" title="Template:Audio" />
          <tl ns="10" title="Template:Birth date" />
          ...
        </templates>
      </page>
    </pages>
  </query>
</api>

Possible errors

None.

images / im

MediaWiki version:

1.9

In Query API interface, this command found pages that embedded the given image. It has been renamed to imageusage.

Gets a list of all images used on the provided pages. This module can be used as a generator.

Parameters

None.

Example

Get a list of images on en:Albert Einstein's page

api.php?action=query&titles=Albert%20Einstein&prop=images [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <images>
          <im ns="6" title="Image:1919 eclipse positive.jpg" />
          <im ns="6" title="Image:Albert Einstein Head.jpg" />
          <im ns="6" title="Image:Albert Einstein german.ogg" />
          <im ns="6" title="Image:Albert Einstein photo 1921.jpg" />
          ...
        </images>
      </page>
    </pages>
  </query>
</api>

Possible errors

None.

extlinks / el

MediaWiki version:

1.11

Gets a list of all external links on the provided pages

Parameters

None.

Example

Get a list of external links on en:Albert Einstein's page

api.php?action=query&titles=Albert%20Einstein&prop=extlinks [try in ApiSandbox]

Result

<api>
  <query>
    <pages>
      <page pageid="736" ns="0" title="Albert Einstein">
        <extlinks>
          <el>http://albert-einstein.org/</el>
          <el>http://albert-einstein.org/history5.html</el>
          <el>http://ame.epfl.ch/biblio/schlatter1.pdf</el>
          ...
        </extlinks>
      </page>
    </pages>
  </query>
</api>

Possible errors

None.

categoryinfo / ci

MediaWiki version:

1.13

Gets information about categories

Parameters

None

Example

Get info about a few categories

api.php?action=query&titles=Albert%20Einstein&prop=categoryinfo [try in ApiSandbox]

Result

<?xml version="1.0" encoding="utf-8"?>
<api>
  <query>
    <normalized>
      <n from="Category:Templates_using_ParserFunctions" to="Category:Templates using ParserFunctions" />
    </normalized>
    <pages>
      <page ns="14" title="Category:Foo" missing="" />
      <page ns="14" title="Category:Templates using ParserFunctions" missing="">
        <categoryinfo size="8" pages="8" files="0" subcats="0" />
      </page>
      <page pageid="37" ns="14" title="Category:Infobox">
        <categoryinfo size="0" pages="1" files="-1" subcats="0" />
      </page>
    </pages>
  </query>
</api>

Possible errors

None

@@ Line 382: / Line 382: @@
 == categoryinfo / ci ==
-== info / in ==
 {{MW 1.13}}
 Gets information about categories

Beau (talk | contribs)

Revision as of 06:58, 6 July 2008

info / in

Parameters

Example

Possible errors

revisions / rv

Parameters

Example

Possible errors

categories / cl

Parameters

Example

Possible errors

imageinfo / ii

Parameters

Example

langlinks / ll

Parameters

Example

Possible errors

links / pl

Parameters

Example

Possible errors

templates / tl

Parameters

Example

Possible errors

images / im

Parameters

Example

Possible errors

extlinks / el

Parameters

Example

Possible errors

categoryinfo / ci

Parameters

Example

Possible errors