---
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


---

# RESTResponseV2 - com escopo, global

# RESTResponseV2 - 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) 5 min. de leitura

A API RESTResponseV2 fornece métodos que permitem usar os dados retornados por uma mensagem REST de saída em código JavaScript.

Um objeto RESTMessonseV2 é retornado pelos métodos RESTMessageV2execute() e executeAsync().

Você pode usar esta API em aplicações com escopo ou dentro do escopo global.

Esta API é executada no namespace `sn_ws`.

## RESTResponseV2 -- getAllHeaders() {#ariaid-title2}

Retorna todos os cabeçalhos contidos na resposta, incluindo cabeçalhos duplicados.
{#RRV2-getAllHeaders__table_hyh_l1l_gz__entry__3}

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

{#RRV2-getAllHeaders__table_hyh_l1l_gz} {#RRV2-getAllHeaders__table_iyh_l1l_gz__entry__2}

| Tipo | Descrição |
|-|-|
| Lista\<GlideHTTPHeader\> | Lista de cabeçalhos contidos na resposta. Cada cabeçalho é representado como um objeto GlideHTTPHeader que contém o <var class="keyword varname">nome</var> e o <var class="keyword varname">valor</var>do cabeçalho. |
[Tabela 2. Retorna]

{#RRV2-getAllHeaders__table_iyh_l1l_gz}  
O exemplo de código a seguir mostra como chamar a REST Table API e lista todos os cabeçalhos encontrados na resposta.

    var request = new sn_ws.RESTMessageV2();
    request.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');
    request.setHttpMethod('GET');

    request.setBasicAuth('username', 'password');
    request.setRequestHeader("Accept", "application/json");
    var res = request.execute();
    if (res.getStatusCode() != 200) {
      gs.info('Bad Request');
    }

    var headers = res.getAllHeaders();
    for(var i in headers){
      gs.info(headers[i].name + ': ' + headers[i].value);
    }

Cabeçalhos de resposta

    X-Is-Logged-In: true
    X-Transaction-ID: e3003cb2db8c
    X-Total-Count: 66
    X-Content-Type-Options: nosniff
    Pragma: no-store,no-cache
    Cache-Control: no-cache,no-store,must-revalidate,max-age=-1
    Expires: 0
    Content-Type: application/json;charset=UTF-8
    Date: Fri, 14 May 2021 16:05:10 GMT
    Connection: close
    Server: ServiceNow
    JSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure
    Set-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
    Set-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
    Set-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure
    Set-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
    Set-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure
    Strict-Transport-Security: max-age=63072000; includeSubDomains

## RESTResponseV2 -- getBody() {#ariaid-title3}

Obtém o conteúdo do corpo da resposta REST.
Use esta função quando quiser obter o corpo da solicitação como conteúdo de texto. Não use este método ao salvar a resposta como um anexo binário. Se um objeto RESTMessageV2 chamar a função saveResponseBodyAsAttachment(...), o uso de getBody() no objeto RESTMessponseV2 associado causará um erro. Ao salvar a resposta como um anexo, se a mensagem REST de saída falhar, chame getErrorMessage() na resposta para recuperar o conteúdo do corpo.
{#r_RESTResponseV2-getBody__table_vy2_525_jqg__entry__3}

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

{#r_RESTResponseV2-getBody__table_vy2_525_jqg} {#r_RESTResponseV2-getBody__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Corpo da resposta REST. |
[Tabela 4. Retorna]

{#r_RESTResponseV2-getBody__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var responseBody = response.getBody();

## RESTResponseV2 -- getCookies() {#ariaid-title4}

Retorna todos os cookies incluídos na resposta.
{#r_RESTResponseV2-getCookies__table_wcc_nbw_ns__entry__3}

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

{#r_RESTResponseV2-getCookies__table_wcc_nbw_ns} {#r_RESTResponseV2-getCookies__table_xcc_nbw_ns__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Matriz de cadeias de caracteres que representam cookies. Itere a matriz para executar operações em cada cookie. |
[Tabela 6. Retorna]

{#r_RESTResponseV2-getCookies__table_xcc_nbw_ns}  
Exibir cookies individuais da resposta.

    var cookies = response.getCookies();
    for (var i = 0; i < cookies.length; i++) {
      gs.info('cookie: ' + cookies.get(i));
    }

Saída:

    cookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly
    cookie: SABASESSIONID=370152970.36895.0000; path=/

## RESTResponseV2 -- getErrorCode() {#ariaid-title5}

Obtém o código de erro numérico se houver um erro durante a transação REST.
Este código de erro é específico para Now Platform, não é um código de erro HTTP. Forneça este código de erro se precisar de assistência do Suporte ao cliente da ServiceNow.  
Nota:  
Para recuperar o conteúdo da mensagem de erro real, use o método [getBody()](https://servicenow-prod.fluidtopics.net/tU_wUOr5mStxwPW067kUmQ#r_RESTResponseV2-getBody "Obtém o conteúdo do corpo da resposta REST.").
{#r_RESTResponseV2-getErrorCode__table_vy2_525_jqh__entry__3}

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

{#r_RESTResponseV2-getErrorCode__table_vy2_525_jqh} {#r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Código de erro numérico, como 1 para tempo limite de soquete. |
[Tabela 8. Retorna]

{#r_RESTResponseV2-getErrorCode__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var errorCode = response.getErrorCode();

## RESTResponseV2 -- getErrorMessage() {#ariaid-title6}

Obtém a mensagem de erro se houver um erro durante a transação REST.
{#r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi__entry__3}

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

{#r_RESTResponseV2-getErrorMessage__table_vy2_525_jqi} {#r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Mensagens de erro |
[Tabela 10. Retorna]

{#r_RESTResponseV2-getErrorMessage__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var errorMsg = response.getErrorMessage();

## RESTResponseV2 -- getHeader(cadeia de caracteres name) {#ariaid-title7}

Obtém o valor de um cabeçalho especificado.
{#r_RESTResponseV2-getHeader_S__table_vy2_525_jq__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome do cabeçalho para o qual você deseja o valor, como Set-Cookie. |
[Tabela 11. Parâmetros]

{#r_RESTResponseV2-getHeader_S__table_vy2_525_jq} {#r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do cabeçalho especificado. |
[Tabela 12. Retorna]

{#r_RESTResponseV2-getHeader_S__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var headerVal = response.getHeader("Content-Type");

## RESTResponseV2 -- getHeaders() {#ariaid-title8}

Obtém todos os cabeçalhos retornados na resposta REST e os valores associados.
Nota:  
Se um cabeçalho estiver presente mais de uma vez na resposta, como um cabeçalho Set-Cookie, esta função retornará somente o último dos cabeçalhos duplicados. Para retornar todos os cabeçalhos, incluindo duplicatas, use a função getAllHeaders().
{#r_RESTResponseV2-getHeaders__table_vy2_525_jqj__entry__3}

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

{#r_RESTResponseV2-getHeaders__table_vy2_525_jqj} {#r_RESTResponseV2-getHeaders__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que mapeia o nome de cada cabeçalho para o valor associado. |
[Tabela 14. Retorna]

{#r_RESTResponseV2-getHeaders__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var headers = response.getHeaders();

## RESTResponseV2 -- getQueryString() {#ariaid-title9}

Obtém a consulta totalmente resolvida enviada para o endpoint REST.
Esta consulta contém o URL do endpoint, bem como todos os valores atribuídos a variáveis na mensagem REST. Use este método somente com respostas a solicitações diretas. Este método não é compatível com solicitações enviadas de forma assíncrona ou solicitações enviadas usando um MID Server.
{#r_RESTResponseV2-getQueryString__table_vy2_525_jqk__entry__3}

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

{#r_RESTResponseV2-getQueryString__table_vy2_525_jqk} {#r_RESTResponseV2-getQueryString__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Consulta totalmente resolvida. |
[Tabela 16. Retorna]

{#r_RESTResponseV2-getQueryString__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var queryString = response.getQueryString();

## RESTResponseV2 -- getResponseAttachmentSysid() {#ariaid-title10}

Obtém o valor de sys_id do anexo criado a partir do conteúdo do corpo da resposta.
Se o objeto RESTMessageV2 associado a esta resposta chamar a função saveResponseBodyAsAttachment(...), use getResponseAttachmentSysid() para obter o sys_id do registro de anexo criado. Use esta função quando quiser executar operações adicionais com o novo registro de anexo.
{#r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs__entry__3}

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

{#r_RRV2-getResponseAttachmentSysid__table_kzq_vd2_vs} {#r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do novo registro de anexo. |
[Tabela 18. Retorna]

{#r_RRV2-getResponseAttachmentSysid__table_lzq_vd2_vs}

## RESTResponseV2 -- getStatusCode() {#ariaid-title11}

Obtém o código numérico de status HTTP retornado pelo provedor REST.
{#r_RESTResponseV2-getStatusCode__table_vy2_525_jql__entry__3}

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

{#r_RESTResponseV2-getStatusCode__table_vy2_525_jql} {#r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Código de status numérico retornado pelo provedor REST, como 200 para uma resposta bem-sucedida. |
[Tabela 20. Retorna]

{#r_RESTResponseV2-getStatusCode__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var statusCode = response.getStatusCode();

## RESTResponseV2 -- haveError() {#ariaid-title12}

Indica se houve um erro durante a transação REST.
{#r_RESTResponseV2-haveError__table_vy2_525_jqm__entry__3}

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

{#r_RESTResponseV2-haveError__table_vy2_525_jqm} {#r_RESTResponseV2-haveError__table_qpt_3f5_jq__entry__2}

| Tipo | Descrição |
|-|-|
| booliano | Retorna verdadeiro se houve um erro e falso se não houve erro. |
[Tabela 22. Retorna]

{#r_RESTResponseV2-haveError__table_qpt_3f5_jq}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute();
    var error = response.haveError();

## RESTResponseV2 - WaitForResponse(Number timeoutSecs) {#ariaid-title13}

Defina a quantidade de tempo que a instância espera por uma resposta do provedor de serviços web.
Este método substitui a propriedade glide.rest.outbound.ecc_response.timeout para esta resposta REST.
{#r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| timeoutSecs | Número | A quantidade de tempo, em segundos, de espera por esta resposta. |
[Tabela 23. Parâmetros]

{#r_RESTResponseV2-waitForResponse_N__table_vy2_525_jq} {#r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 24. Retorna]

{#r_RESTResponseV2-waitForResponse_N__table_nxp_dmh_dr}  

    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.executeAsync();
    response.waitForResponse(60);