MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
prop=stashimageinfo (sii)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
Returns file information for stashed files.
Parameters:
- siifilekey
Key that identifies a previous upload that was stashed temporarily.
- Separate values with | or alternative.
- Maximum number of values is ५० (५०० for clients that are allowed higher limits).
- siisessionkey
- Deprecated.
Alias for siifilekey, for backward compatibility.
- Separate values with | or alternative.
- Maximum number of values is ५० (५०० for clients that are allowed higher limits).
- siiprop
Which file information to get:
- timestamp
- Adds timestamp for the uploaded version.
- canonicaltitle
- Adds the canonical title of the file. If the file has been revision deleted, a filehidden property will be returned.
- url
- Gives URL to the file and the description page. If the file has been revision deleted, a filehidden property will be returned.
- size
- Adds the size of the file in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- sha1
- Adds SHA-1 hash for the file. If the file has been revision deleted, a filehidden property will be returned.
- mime
- Adds MIME type of the file. If the file has been revision deleted, a filehidden property will be returned.
- thumbmime
- Adds MIME type of the image thumbnail (requires url and param siiurlwidth). If the file has been revision deleted, a filehidden property will be returned.
- metadata
- Lists Exif metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
- commonmetadata
- Lists file format generic metadata for the version of the file. If the file has been revision deleted, a filehidden property will be returned.
- extmetadata
- Lists formatted metadata combined from multiple sources. Results are HTML formatted. If the file has been revision deleted, a filehidden property will be returned.
- bitdepth
- Adds the bit depth of the version. If the file has been revision deleted, a filehidden property will be returned.
- badfile
- Adds whether the file is on the MediaWiki:Bad image list
- Values (separate with | or alternative): badfile, bitdepth, canonicaltitle, commonmetadata, dimensions, extmetadata, metadata, mime, sha1, size, thumbmime, timestamp, url
- Default: timestamp|url
- siiurlwidth
If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.
- Type: integer
- Default: -1
- siiurlheight
Similar to siiurlwidth.
- Type: integer
- Default: -1
- siiurlparam
A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.
- Default: (empty)
Examples:
- Returns information for a stashed file.
- api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567 [open in sandbox]
- Returns thumbnails for two stashed files.
- api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url [open in sandbox]