---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIRequest - com escopo, global

# RESTAPIRequest - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A API RESTAPIRequest fornece métodos que permitem acessar detalhes da solicitação de API REST em scripts.

Esta API é executada no namespace `sn_ws`.  
Nota:  
Você não pode instanciar objetos deste tipo. Objetos desse tipo são criados automaticamente e podem ser acessados somente em scripts de recurso de REST API com script.

## RESTAPIRequest - corpo {#ariaid-title2}

O corpo da solicitação.
{#r_SSR_body__table_a3m_rt1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| corpo | [RESTAPIRequestBody](https://servicenow-prod.fluidtopics.net/_zzJsfUvHAFkTLITKN2c3g#c_ScriptableServiceRequestBody "A API RESTAPIRequestBody fornece métodos que permitem acessar o conteúdo do corpo de uma solicitação de REST API em scripts.") | O corpo da solicitação. Você pode acessar dados do objeto do corpo usando a API RESTAPIRequestBody. |
[Tabela 1. Campo]

{#r_SSR_body__table_a3m_rt1_sr}  

    var requestBody = request.body // Returns instance of RESTAPIRequestBody

## RESTAPIRequest - getHeader(Cabeçalho de cadeia de caracteres) {#ariaid-title3}

Retorna o valor de um cabeçalho específico da solicitação de serviço web.
{#r_SSR-getHeader_String__table_q32_q2r_qr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cabeçalho | Cadeia de caracteres | O nome do cabeçalho, como accept ou content-type. |
[Tabela 2. Parâmetros]

{#r_SSR-getHeader_String__table_q32_q2r_qr} {#r_SSR-getHeader_String__table_r32_q2r_qr__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | O valor do cabeçalho especificado. |
[Tabela 3. Retorna]

{#r_SSR-getHeader_String__table_r32_q2r_qr}  

    var acceptHeader = request.getHeader('accept');

## RESTAPIRequest -- getSupportedResponseContentTypes() {#ariaid-title4}

Obtenha os tipos de conteúdo especificados no cabeçalho Aceitar da solicitação.
{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 4. Parâmetros]

{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs} {#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Uma matriz de valores de cadeia de caracteres em que cada cadeia de caracteres é um tipo de conteúdo, como aplicação/json. |
[Tabela 5. Retorna]

{#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs}

## RESTAPIRequest - cabeçalhos {#ariaid-title5}

Todos os cabeçalhos da solicitação.
{#r_SSR_headers__table_zmm_3s1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cabeçalhos | objeto | Todos os cabeçalhos da solicitação e seus valores. |
[Tabela 6. Campo]

{#r_SSR_headers__table_zmm_3s1_sr}  

    var headers = request.headers; 
    var acceptHeader = headers.Accept;
    var myCustomHeader = headers.myCustom; 
    var specialHeader = headers['special - header'];

## RESTAPIRequest - pathParams {#ariaid-title6}

Os parâmetros de caminho passados no URI da solicitação.
{#r_SSR_pathParams__table_zsf_jr1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| pathParams | Objeto | Os parâmetros de caminho como um objeto de script. Os parâmetros de caminho disponíveis dependem da configuração do serviço web. |
[Tabela 7. Campo]

{#r_SSR_pathParams__table_zsf_jr1_sr}  
Neste exemplo, o endpoint de API REST de script segue este formato: https://instance.service-now.com/api/now/myservice/{tableName}/{id}. A solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/myservice/myApp_table/1234.

    var pathParams = request.pathParams; 
    var tableName = pathParams.tableName; //'myApp_table' 
    var id = pathParams.id; //'1234'

## RESTAPIRequest - queryParams {#ariaid-title7}

Os parâmetros de consulta da solicitação de serviço web.
{#r_SSR_queryParams__table_gzw_yg5_rr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| queryParams | Matriz | Os parâmetros de consulta da solicitação de serviço web. |
[Tabela 8. Campo]

{#r_SSR_queryParams__table_gzw_yg5_rr}  
Neste exemplo, a solicitação que está sendo processada usa este URL: https://\<instance_rest_endpoint\> ?active=false\&name=now . Observe os parâmetros active e name.

    var queryParams = request.queryParams; 
    var isActiveQuery = queryParams.active; // [false] 
    var nameQueryVal = queryParams.name; // ['now']

## RESTAPIRequest - queryString {#ariaid-title8}

A consulta inteira adicionada ao URI do endpoint.
{#r_SSR_queryString__table_zwx_5q1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| queryString | Cadeia de caracteres | A consulta inteira para a solicitação. |
[Tabela 9. Campo]

{#r_SSR_queryString__table_zwx_5q1_sr}  
Neste exemplo, a solicitação que está sendo processada usa este URL: https://\<instance_rest_endpoint\> ?active=false\&name=now . Observe a consulta `active=false&name=now`.

    var query = request.queryString; //"active=false&name=now"

## RESTAPIRequest - URI {#ariaid-title9}

O URI da solicitação, excluindo informações de domínio.
{#r_SSR_uri__table_h5d_ct1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| URI | Cadeia de caracteres | O URI da solicitação, excluindo informações de domínio. |
[Tabela 10. Campo]

{#r_SSR_uri__table_h5d_ct1_sr}  
Neste exemplo, a solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/table/myTable?active=false\&name=now.

    var query = request.uri; //"api/now/table/myTable"

## RESTAPIRequest - URL {#ariaid-title10}

A URL de solicitação inteira.
{#r_SSR_url__table_zdq_qs1_sr__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| URL | Cadeia de caracteres | A URL de solicitação inteira. |
[Tabela 11. Campo]

{#r_SSR_url__table_zdq_qs1_sr}  
Neste exemplo, a solicitação que está sendo processada usa este URL: https://instance.service-now.com/api/now/table/myTable?active=false\&name=now.

    var query = request.url; //"https://instance.service-now.com/api/now/table/myTable?active=false&name=now"