GlideHTTPRequest - Global
. GlideHTTPRequest A API fornece métodos de utilitário para executar funções comuns com solicitações HTTP Glide.
Você pode usar esta API em scripts globais do lado do servidor. Para usar esta classe, instancie um objeto GlideHTTPRequest usando o construtor. O construtor requer uma URL de endpoint como parâmetro de entrada.
GlideHTTPRequest - addHeader(nome da cadeia de caracteres, valor da cadeia de caracteres)
Adiciona um cabeçalho à sua solicitação HTTP.
| Nome | Tipo | Descrição |
|---|---|---|
| nome | Cadeia de caracteres | Nome do cabeçalho, como Aceitar ou Content-Type . |
| valor | Cadeia de caracteres | Valor do cabeçalho, como aplicação/json . |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo adiciona o cabeçalho de solicitação "Aceitar" e retorna o número de incidentes de uma instância da ServiceNow, analisando as respostas JSON ou XML.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the Accept header to get JSON response
request.addHeader('Accept', 'application/json');
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
gs.print('(JSON) Incidents returned: ' + JSON.parse(response.getBody()).result.length);
// Replace the Accept header to get XML response
request.addHeader('Accept', 'application/xml');
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
gs.print('(XML) Incidents returned: ' + gs.xmlToJSON(response.getBody()).response.result.length);
Saída
200
(JSON) Incidents returned: 66
200
(XML) Incidents returned: 66
GlideHTTPRequest - addParameter(nome da cadeia de caracteres, valor da cadeia de caracteres)
Adiciona um parâmetro à sua solicitação HTTP.
| Nome | Tipo | Descrição |
|---|---|---|
| nome | Cadeia de caracteres | Parâmetro a ser adicionado, como sysparm_limit. |
| valor | Cadeia de caracteres | Valor do parâmetro. |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como adicionar o. sysparm_limitParâmetro para a chamada de endpoint REST para limitar o número de respostas retornadas.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the 'sysparm_limit' parameter to limit the number of records returned
request.addParameter('sysparm_limit', 1);
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
gs.print('Incidents returned: ' + JSON.parse(response.getBody()).result.length);
Saída:
200
Incidents returned: 1
GlideHTTPRequest - setBasicAuth(cadeia de caracteres de nome de usuário, senha da cadeia de caracteres)
Define um nome de usuário e uma senha para autenticação básica.
| Nome | Tipo | Descrição |
|---|---|---|
| userName | Cadeia de caracteres | Nome de usuário a ser usado para autenticação. |
| senha | Cadeia de caracteres | Senha do usuário a ser usada para autenticação. |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como usar o. SetBasicAuth() Método para definir o nome de usuário e a senha para a chamada de endpoint REST associada.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the Accept header to get JSON response
request.addHeader('Accept', 'application/json');
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
gs.print('(JSON) Incidents returned: ' + JSON.parse(response.getBody()).result.length);
// Replace the Accept header to get XML response
request.addHeader('Accept', 'application/xml');
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
gs.print('(XML) Incidents returned: ' + gs.xmlToJSON(response.getBody()).response.result.length);
Saída
200
(JSON) Incidents returned: 66
200
(XML) Incidents returned: 66
GlideHTTPRequest - setContentType(tipo de cadeia de caracteres)
Define o cabeçalho Content-Type da sua solicitação HTTP com o valor especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| tipo | Cadeia de caracteres | Tipo de conteúdo a ser definido, como aplicação/json ou dados de formulário/várias partes . Para obter informações adicionais sobre Content-Type, consulte https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type. |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como definir Content-Type Cabeçalho de solicitação para uma chamada de endpoint REST usando SetContentType() método.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Set up incident record to post
// Set the Content-Type of the POST
request.setContentType('application/json');
// Execute the POST request
var response = request.post();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
Saída
200
GlideHTTPRequest - setFollowRedirect(followRedirect booliano)
Habilita ou desabilita a opção Seguir redirecionamento para uma chamada de endpoint REST.
Para obter informações adicionais sobre redirecionamentos HTTP, consulte https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections.
| Nome | Tipo | Descrição |
|---|---|---|
| FollowRedirecionar | Booliano | Sinalizador que indica se o endpoint deve seguir qualquer redirecionamento de URL retornado pelo endpoint. Valores válidos: Padrão: verdadeiro
|
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como desativar redirecionamentos para uma chamada de endpoint usando SetFollowRedirect() método.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the Accept header to get JSON response
request.addHeader('Accept', 'application/json');
// Turn off follow redirect - default is on (true)
request.setFollowRedirect(false);
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
Saída
200
GlideHTTPRequest - setHtttpTimeout(int timeout)
Define o valor do tempo limite HTTP em milissegundos.
| Nome | Tipo | Descrição |
|---|---|---|
| timeout | Inteiro | Valor de tempo limite a ser definido. Unidade: Milissegundos |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como definir o valor de tempo limite para uma chamada de endpoint usando SetTimeout() método.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the Accept header to get JSON response
request.addHeader('Accept', 'application/json');
// Set the time out value
request.setHttpTimeOut(1000);
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
Saída
200
GlideHTTPRequest - setLogLevel(cadeia de caracteres loglevel)
Define o nível de log de uma solicitação HTTP.
| Nome | Tipo | Descrição |
|---|---|---|
| logLevel | Cadeia de caracteres | O nível de registro em log disponível. Nota: Por motivos de desempenho, na produção, é aconselhável deixar o registro em log de solicitação HTTP em basic. Valores válidos:
Padrão: Básico |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra como definir o nível de log para uma chamada de endpoint usando SetLogLevel() método.
var instance = 'dev12345';
var username = 'admin';
var password = 'yourpassword';
// Instantiate request with ServiceNow API incidents table endpoint
var request = new GlideHTTPRequest('https://'+instance+'.service-now.com/api/now/table/incident');
// Add authentication data
request.setBasicAuth(username, password);
// Add the Accept header to get JSON response
request.addHeader('Accept', 'application/json');
// Set the time out value
request.setLogLevel(elevated);
// Execute the GET request
var response = request.get();
// Print the results: status code and number of records returned
gs.print(response.getStatusCode());
Saída
200
GlideHTTPRequest - setupProxy(host de cadeia de caracteres, porta de cadeia de caracteres)
Define o host proxy e a porta para a chamada REST associada.
| Nome | Tipo | Descrição |
|---|---|---|
| Host | Cadeia de caracteres | Host do proxy |
| porta | Cadeia de caracteres | Porta de proxy |
| Tipo | Descrição |
|---|---|
| vazio |