View source for API:Query/pt

<languages/>
{{API}}
O módulo <code>action=query</code> permite-lhe obter a informação sobre uma wiki e os dados guardados na mesma, tal como o texto wiki de uma página em particular, as hiperligações e as categorias de um conjunto de páginas, ou o código (''token'') que precisa para {{ll|API:Changing wiki content|alterar o conteúdo da wiki}}.

<div style="overflow:auto">
{{toclimit|limit=3}}
</div>

<span id="API_documentation"></span>
== Documentação da API ==
{{Api help|query|frame=yes}}

<span id="Query_modules"></span>
=== Módulos de consulta ===

O módulo de consulta tem três tipos de submódulos (também chamados módulos de consulta):

* {{ll|API:Meta|Info Meta}} sobre a wiki e o usuário conectado.
* {{ll|API:Properties|Properties}} de páginas, incluídas as revisões de página e o conteúdo.
* {{ll|API:Lists|Lists}} de páginas que coincidem com certos critérios.

<span id="Examples"></span>
== Exemplos ==

{{anchor|Specifying pages}}
<span id="Example_1:_Specifying_pages"></span>
=== Exemplo 1: Especificar as páginas ===

A diferença dos módulos de consulta meta e lista, todos os módulos de consulta de propriedades funcionam num conjunto de páginas que se podem especificar de uma das seguintes maneiras:

* Por nome utilizando o parâmetro <code>titles</code>, por exemplo, <code>titles=Foo|Bar|Main_Page</code>.
* Por Id. de página utilizando o parâmetro <code>pageids</code>, por exemplo, <code>pageids=123|456|75915</code>.
* Por Id. de revisão o parâmetro <code>revids</code>, por exemplo, <code>revids=478198|54872|54894545</code>. A maioria dos módulos de consulta converterão a VÃO de revisão à VÃO de página correspondente. Apenas {{ll|API:Revisions|prop{{=}}revisions}} atualmente utiliza o próprio Id. de revisão.
* Utilizar um [[#Generators|gerador]].

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido OBTER ====
{{ApiEx
|p1=action=query
|p2=revids=347819{{!}}5487{{!}}548945
|p3=format=json
|p4=formatversion=2
}}
<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "pages": [
            {
                "pageid": 1130,
                "ns": 0,
                "title": "Avicenna"
            },
            {
                "pageid": 17412,
                "ns": 0,
                "title": "Klein bottle"
            },
            {
                "pageid": 33642,
                "ns": 0,
                "title": "Warrant"
            }
        ]
    }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

<span id="Example_2:_Title_normalization"></span>
=== Exemplo 2: Normalização do título ===


Normalização de títulos converte títulos de páginas a sua forma canónica.

Isto significa pôr em maiúscula o primeiro carácter, substituir os guiões baixos com espaços e mudar o espaço de nomes à forma localizada definida para essa wiki.

{{note|1=Qualquer salto de linha final nos títulos da página  (\n) causará um comportamento estranho e devem ser eliminados primeiro.}}

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido ''GET'' ====
{{ApiEx
| p1=action=query
| p2=titles=Project:articleA{{!}}article_B
| p3=format=json
| p4=formatversion=2
}}
<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "normalized": [
            {
                "fromencoded": false,
                "from": "Project:articleA",
                "to": "Wikipedia:ArticleA"
            },
            {
                "fromencoded": false,
                "from": "article_B",
                "to": "Article B"
            }
        ],
        "pages": [
            {
                "ns": 0,
                "title": "Article B",
                "missing": true
            },
            {
                "ns": 4,
                "title": "Wikipedia:ArticleA",
                "missing": true
            }
        ]
    }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

<span id="Example_3:_Missing_and_invalid_titles"></span>
=== Exemplo 3: Títulos inválidos e em falta ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Titles that don't exist or are invalid will have a <code>missing</code> or <code>invalid</code> attribute set in the response.
</div>

Em formatos de saída que admitam chaves de matriz numéricas, os títulos faltantes e inválidos terão IDs de página negativas.

<span lang="en" dir="ltr" class="mw-content-ltr">In some cases, a title can be viewed by a user but cannot be accessed by the API, such as pages that mirror content from another wiki.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">These titles will have a <code>known</code> attribute set in the response.</span>

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido ''GET'' ====
{{ApiEx
|p1=action=query
|p2=titles=Doesntexist{{!}}Main%20Page{{!}}Talk:
|p3=format=json
|p4=formatversion=2
}}
<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "pages": [
            {
                "ns": 0,
                "title": "Doesntexist",
                "missing": true
            },
            {
                "title": "Talk:",
                "invalidreason": "The requested page title is empty or contains only the name of a namespace.",
                "invalid": true
            },
            {
                "pageid": 15580374,
                "ns": 0,
                "title": "Main Page"
            }
        ]
    }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

<span id="Example_4:_Continuing_queries"></span>
=== Exemplo 4: Continuar consultas ===

<div lang="en" dir="ltr" class="mw-content-ltr">
When all the data is not returned in the response of a query, there will be a <code>continue</code> attribute to indicate that there is more data.
</div>

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido ''GET'' ====
{{ApiEx
|p1=action=query
|p2=list=allcategories
|p3=acprefix=List%20of
|p4=formatversion=2
}}
<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
    "continue": {
        "accontinue": "List_of_largest_companies_in_Sri_Lanka",
        "continue": "-||"
    },
    "query": {
        "allcategories": [
            {
                "category": "List of BioWare characters"
            },
            {
                "category": "List of Harlequin Romance novels"
            },
            {
                "category": "List of MPs elected in UK elections templates"
            },
            {
                "category": "List of Metamorphoses characters"
            },
            {
                "category": "List of Rockstar Games characters"
            },
            {
                "category": "List of Star Trek awards and nominations"
            },
            {
                "category": "List of Swedish films of the 2020s"
            },
            {
                "category": "List of association football clubs in the Republic of Ireland templates"
            },
            {
                "category": "List of awards and nominations received by Aleksej Pechkuroy"
            },
            {
                "category": "List of cabinet templates"
            }
        ]
    }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

Para obter mais dados, agregue seus valores à solicitação original.

{{TabbedWindowBegin}}
<div lang="en" dir="ltr" class="mw-content-ltr">
==== GET request ====
</div>
{{ApiEx
|p1=action=query
|p2=list=allcategories
|p3=acprefix=List%20of
|p4=formatversion=2
|p5=accontinue=List_of_largest_companies_in_Sri_Lanka
|p6=continue=-{{!}}{{!}}
}}
<div lang="en" dir="ltr" class="mw-content-ltr">
==== Response ====
</div>
<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "allcategories": [
            {
                "category": "List of largest companies in Sri Lanka"
            },
            {
                "category": "List of longest beaches of the world"
            },
            {
                "category": "List of ministers by ministry of Bangladesh"
            },
            {
                "category": "List of people from Palm Beach, Florida"
            },
            {
                "category": "List of video game characters"
            }
        ]
    }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

<span id="Example_5:_Batchcomplete"></span>
=== Exemplo 5: Batchcomplete ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The API returns a <code>batchcomplete</code> element to indicate that all data for the current batch of items has been returned.
</div>
{{MW version-inline|MW 1.25+}}

<div lang="en" dir="ltr" class="mw-content-ltr">
In the response of the sample query below, <code>batchcomplete</code> has been included to indicate that all the data for each of the three images has been returned.
</div>

A próxima continuação começará devolver dado para o seguinte conjunto de 3 imagens.

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido ''GET'' ====
{{ApiEx
|p1=action=query
|p2=list=allimages
|p3=ailimit=3
|p4=format=json
|p5=formatversion=2
}}

<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
  "batchcomplete": true,
  "continue": {
    "aicontinue": "20020822143445|Do_You_Want_to_Know_a_Secret_(Beatles_song_-_sample).ogg",
    "continue": "-||"
  },
  "query": {
    "allimages": [
      {
        "name": "Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
        "timestamp": "2002-08-04T19:55:17Z",
        "url": "https://upload.wikimedia.org/wikipedia/en/6/64/Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
        "descriptionurl": "https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Mrs_Robinson.ogg",
        "descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=67723",
        "ns": 6,
        "title": "File:Simon and Garfunkel - Mrs Robinson.ogg"
      },
      {
        "name": "Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
        "timestamp": "2002-08-04T20:01:36Z",
        "url": "https://upload.wikimedia.org/wikipedia/en/c/c1/Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
        "descriptionurl": "https://en.wikipedia.org/wiki/File:Simon_and_Garfunkel_-_Scarborough_Fair.ogg",
        "descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=67779",
        "ns": 6,
        "title": "File:Simon and Garfunkel - Scarborough Fair.ogg"
      },
      {
        "name": "Beatles_please_me.ogg",
        "timestamp": "2002-08-22T14:34:00Z",
        "url": "https://upload.wikimedia.org/wikipedia/en/e/ee/Beatles_please_me.ogg",
        "descriptionurl": "https://en.wikipedia.org/wiki/File:Beatles_please_me.ogg",
        "descriptionshorturl": "https://en.wikipedia.org/w/index.php?curid=74826",
        "ns": 6,
        "title": "File:Beatles please me.ogg"
      }
    ]
  }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

{{anchor|Generators}}
<span id="Example_6:_Generators"></span>
=== Exemplo 6: Geradores ===

Usa geradores se desejas obter dados sobre um conjunto de páginas

<div lang="en" dir="ltr" class="mw-content-ltr">
For example, to get data about pages in a certain category, instead of querying <code>list=categorymembers</code> and then querying again with <code>pageids</code> set to all the returned pages, combine the two API calls into one by using <code>generator=categorymembers</code>.
</div>

Quando utilizes um módulo de lista como um gerador, não precisas especificar as páginas.

No entanto, para um módulo de propriedades, deves 
[[#Specifying pages|specify the pages]] nas que trabalhará o gerador.

<div lang="en" dir="ltr" class="mw-content-ltr">
For example, to load all pages that are linked to from the main page, use <code>generator=links&titles=Main%20Page</code>.
</div>

Os parâmetros passados a um <code>g</code>erador devem ter o prefixo g. Por exemplo, quando uses 
generator=backlinks, usa <code>gbllimit</code> em lugar de bllimit.

A consulta de mostra abaixo, obtém enlaces e categorias para as primeiras três páginas no espaço de nomes principal que comecem com "Ba".

{{TabbedWindowBegin}}
<span id="GET_request"></span>
==== Pedido ''GET'' ====
{{ApiEx
|p1=action=query
|p2=generator=allpages
|p3=gaplimit=3
|p4=gapfrom=Ba
|p5=prop=links{{!}}categories
|p6=format=json
|p7=formatversion=2
}}
<span id="Response"></span>
==== Resposta ====
<syntaxhighlight lang="json">
{
     "continue": {
         "plcontinue": "14977970|0|Kirkwall_Ba_game",
         "continue": "||categories"
     },
     "query": {
         "pages": [
             {
                 "pageid": 98178,
                 "ns": 0,
                 "title": "Ba",
                 "links": [
                     {
                         "ns": 0,
                         "title": "BA"
                     },
                     {
                         "ns": 4,
                         "title": "Wikipedia:Mainspace"
                     },
                     {
                         "ns": 4,
                         "title": "Wikipedia:Naming conventions (capitalization)"
                     },
                     {
                         "ns": 4,
                         "title": "Wikipedia:Protection policy"
                     },
                     {
                         "ns": 4,
                         "title": "Wikipedia:Redirect"
                     },
                     {
                         "ns": 10,
                         "title": "Template:R from miscapitalisation"
                     },
                     {
                         "ns": 10,
                         "title": "Template:R from modification"
                     },
                     {
                         "ns": 10,
                         "title": "Template:R to disambiguation page"
                     },
                     {
                         "ns": 14,
                         "title": "Category:Redirects from ambiguous terms"
                     },
                     {
                         "ns": 14,
                         "title": "Category:Redirects from other capitalisations"
                     }
                 ],
                 "categories": [
                     {
                         "ns": 14,
                         "title": "Category:Redirects from ambiguous terms"
                     },
                     {
                         "ns": 14,
                         "title": "Category:Redirects from other capitalisations"
                     },
                     {
                         "ns": 14,
                         "title": "Category:Unprintworthy redirects"
                     }
                 ]
             },
             {
                 "pageid": 14977970,
                 "ns": 0,
                 "title": "Ba'"
             },
             {
                 "pageid": 33351890,
                 "ns": 0,
                 "title": "Ba'Al Shem Tov"
             }
         ]
     }
}
</syntaxhighlight>
{{TabbedWindowEnd}}

<div lang="en" dir="ltr" class="mw-content-ltr">
== Continuing queries ==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Queries will often have more results available than are just shown in the original query.</span>
(Often this is because a {{ll|API:Lists|List}} query's result {{ll|API:Lists#Additional notes|limit}} has been reached.)
<span lang="en" dir="ltr" class="mw-content-ltr">In these cases, queries can be continued.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">More detailed information on continuing queries can be at {{ll|API:Continue}}.</span>

<span id="Possible_warnings"></span>
== Avisos possíveis ==
{| class="wikitable"
|+
! Mensagem de aviso
! Causa
|-
| Não foi implementado nenhum suporte para as páginas especiais.
| <span lang="en" dir="ltr" class="mw-content-ltr">Thrown if a title in the Special: or Media: namespace is given. The pages in these namespaces cannot be queried.</span>
|-
| {{int|apiwarn-redirectsandrevids}}
| <span lang="en" dir="ltr" class="mw-content-ltr">Thrown if the <code>redirect</code> parameter is used in a query that specifies pages using <code>revids</code>.</span>
|}

<span id="Parameter_history"></span>
== Histórico de parâmetros ==
* v1.34: <span lang="en" dir="ltr" class="mw-content-ltr">Introduced <code>exportschema</code></span>
* v1.24: Introduzido <code>rawcontinue</code> (nota: [[Special:MyLanguage/API:Raw query continue|continuação ''raw'']] era o comportamento predefinido até à v1.26)
* v1.21: Introduzido em <code>continue</code>

<span id="Additional_notes"></span>
== Notas adicionais ==
* <span lang="en" dir="ltr" class="mw-content-ltr">Specifying titles through <code>titles</code> or <code>pageids</code> is limited to 50 titles per query, or 500 for those with the <code>apihighlimits</code> right.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Use multiple query modules together to get what you need in one request, e.g. <code>prop=info|revisions&list=backlinks|embeddedin|allimages&meta=userinfo</code>.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Generators always pass page titles to the query module.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Unlike lists (which may include additional data by default), generators should not output any information themselves, unless when explicitly requested via the generator module's query parameters.</span>

<span id="Resolving_redirects"></span>
== Resolver redirecionamentos ==
<span lang="en" dir="ltr" class="mw-content-ltr">Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">When present, they will always contain <code>from</code> and <code>to</code> attributes and may contain a <code>tofragment</code> attribute for those redirects that point to specific sections.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Both normalization and redirection may take place.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In the case of multiple redirects, all redirects will be resolved, and in case of a circular redirect, there might not be a page in the 'pages' section (see [[#circular_redirects|an example request]]).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Redirect resolution cannot be used in combination with the <code>revids=</code> parameter or with a generator generating revids; doing that will produce a [[#Possible warnings|warning]] and will not resolve redirects for the specified revids.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
The examples below show how the <code>redirects</code> parameter works.
</div>

{{ApiEx
| desc=Utilizando o parâmetro "redirects". "Main page" é um redirecionamento para "Main Page"
| p1=action=query
| p2=titles=Main%20page
| p3=redirects
| p4=format=json
| p5=formatversion=2
| result=<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "redirects": [
            {
                "from": "Main page",
                "to": "Main Page"
            }
        ],
        "pages": [
            {
                "pageid": 15580374,
                "ns": 0,
                "title": "Main Page"
            }
        ]
    }
}
</syntaxhighlight>
}}
{{ApiEx
| desc=Mesmo pedido mas sem o parâmetro "redirects".
| p1=action=query
| p2=titles=Main%20page
| p3=format=json
| p4=formatversion=2
| result=<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "pages": [
            {
                "pageid": 217225,
                "ns": 0,
                "title": "Main page"
            }
        ]
    }
}
</syntaxhighlight>
}}
{{ApiEx
| desc=Sem "redirects" pode querer utilizar prop=info para obter o estado do redirecionamento.
| p1=action=query
| p2=titles=Main%20page
| p3=prop=info
| p4=formatversion=2
| result=<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "pages": [
            {
                "pageid": 217225,
                "ns": 0,
                "title": "Main page",
                "contentmodel": "wikitext",
                "pagelanguage": "en",
                "pagelanguagehtmlcode": "en",
                "pagelanguagedir": "ltr",
                "touched": "2017-12-17T02:02:05Z",
                "lastrevid": 777924062,
                "length": 170,
                "redirect": true
            }
        ]
    }
}
</syntaxhighlight>
}}
{{ApiEx
| desc=Pedido com uma ligação de secção. "Wikipedia:!--" é um redirecionamento para "Wikipedia:Manual of Style#Invisible comments"
| p1=action=query
| p2=titles=Wikipedia:!--
| p3=redirects
| p4=format=json
| p5=formatversion=2
| result=<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "redirects": [
            {
                "from": "Wikipedia:!--",
                "to": "Wikipedia:Manual of Style",
                "tofragment": "Invisible comments"
            }
        ],
        "pages": [
            {
                "pageid": 33697,
                "ns": 4,
                "title": "Wikipedia:Manual of Style"
            }
        ]
    }
}
</syntaxhighlight>
}}
{{ApiEx
|desc={{anchor|circular_redirects}}Este é um caso de redirecionamento circular: Page1 &rarr; Page2 &rarr; Page3 &rarr; Page1. Também, neste exemplo é utilizado um nome não normalizado 'page1'.
|p1=action=query
|p2=titles=page1
|p3=redirects
|p4=format=json
|p5=formatversion=2
|result=<syntaxhighlight lang="json">
{
    "batchcomplete": true,
    "query": {
        "normalized": [
            {
                "fromencoded": false,
                "from": "page1",
                "to": "Page1"
            }
        ],
        "redirects": [
            {
                "from": "Page1",
                "to": "Page2"
            },
            {
                "from": "Page2",
                "to": "Page3"
            },
            {
                "from": "Page3",
                "to": "Page1"
            }
        ],
        "pages": [
            {
                "ns": 0,
                "title": "Page1",
                "missing": true
            }
        ]
    }
}
</syntaxhighlight>}}


<span id="See_also"></span>
== Consultar também ==
* {{ll|API:Main page}} - O guia de início rápido.
* {{ll|API:Raw query continue}} - Contém informação sobre como utilizar o parâmetro <code>rawcontinue</code>.

{{Component|mediawiki-api}}