RESTResponseV2 - escopo, global

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

Um objeto RESTResponseV2 é retornado pelo RESTMessageV2 métodos executar() e. ExecuteAsync() .

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

Esta API é executada no sn_ws namespace.

RESTResponseV2 - getAllHeaders()

Retorna todos os cabeçalhos contidos na resposta, incluindo cabeçalhos duplicados.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 2. Retorna

Tipo	Descrição
List<GlideHTTPHeader>	Lista de cabeçalhos contida na resposta. Cada cabeçalho é representado como um objeto GlideHTTPHeader que contém o cabeçalho nome e. valor .

O exemplo de código Seguir mostra como chamar a API da tabela REST 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()

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 SaveResponseBodyAsAttachment(...) função, usando GetBody() O objeto RESTResponseV2 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.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 4. Retorna

Tipo	Descrição
Cadeia de caracteres	Corpo da resposta REST.

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

Retorna todos os cookies incluídos na resposta.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 6. Retorna

Tipo	Descrição
Objeto	Matriz de cadeias de caracteres que representam cookies. Itere por meio da matriz para executar operações em cada cookie.

Exiba 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()

Obtém o código de erro numérico se houve um erro durante a transação REST.

Este código de erro é específico para ServiceNow AI 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 GetBody() método.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna

Tipo	Descrição
Número	Código de erro numérico, como 1 para tempo limite do soquete.

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

Obtém a mensagem de erro se houve um erro durante a transação REST.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 10. Retorna

Tipo	Descrição
Cadeia de caracteres	Mensagens de erro

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 (nome da cadeia de caracteres)

Obtém o valor de um cabeçalho especificado.

Tabela 11. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome do cabeçalho para o qual você deseja o valor, como Set-Cookie.

Tabela 12. Retornos

Tipo	Descrição
Cadeia de caracteres	Valor do cabeçalho especificado.

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

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 GetAllHeaders() função.

Tabela 13. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 14. Retorna

Tipo	Descrição
Objeto	Objeto que mapeia o nome de cada cabeçalho para o valor associado.

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

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.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 16. Retorna

Tipo	Descrição
Cadeia de caracteres	Consulta totalmente resolvida.

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

Obtém o valor sys_id do anexo criado a partir do conteúdo do corpo da resposta.

Se o objeto RESTMessageV2 associado a esta resposta chamar SaveResponseBodyAsAttachment(...) função, usar 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.

Tabela 17. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 18. Retorna

Tipo	Descrição
Cadeia de caracteres	Sys_id do novo registro de anexo.

RESTResponseV2 - getStatusCode()

Obtém o código de status HTTP numérico retornado pelo provedor REST.

Tabela 19. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 20. Retorna

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

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

Indica se houve um erro durante a transação REST.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 22. Retorna

Tipo	Descrição
booliano	Retorna verdadeiro se houve um erro, falso se não houve erro.

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)

Defina a quantidade de tempo que a instância espera por uma resposta do provedor de serviços da Web.

Este método substitui a propriedade glide.rest.outbound.ecc_response.timeout desta resposta REST.

Tabela 23. Parâmetros

Nome	Tipo	Descrição
TimeoutSecs	Número	A quantidade de tempo, em segundos, para aguardar esta resposta.

Tabela 24. Retornos

Tipo	Descrição
vazio

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