Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2023-06-23
ai.https

ai.https

Solicitud

Método
Descripción
request(url, method, body, headers, ) allowAutoRedirect)
Realiza una solicitud HTTPS. Devuelve una respuesta.
A partir de 2018.3, request(method) admite
  • GET: recuperar datos.
  • POST: envía datos al recurso especificado.
  • PUT: crea o sustituye el recurso especificado.
  • PATCH: aplique modificaciones parciales al recurso.
requestStream(url, method, body, headers
disponible con 2018.3
Realiza una solicitud de transmisión HTTPS. Devuelve una respuesta.
  • GET: recuperar datos.
  • POST: envía datos al recurso especificado.
  • PUT: crea o sustituye el recurso especificado.
  • PATCH: aplique modificaciones parciales al recurso.
AuthorizedRequest(url, method, body, headers)
Realiza una solicitud https con la cabecera de autorización generada para un CCDS con OAuth activado. Devuelve una respuesta.
Utiliza los detalles del elemento de configuración de OAuth subyacente junto con la información de autorización del origen de datos para generar la cabecera de autorización de la solicitud https.
A partir de 2018.3,authorizedRequest(method) admite
  • GET: recuperar datos.
  • POST: envía datos al recurso especificado.
  • PUT: crea o sustituye el recurso especificado.
  • PATCH: aplique modificaciones parciales al recurso.
requestAuthorizedStream(url, method, body, headers)
disponible con 2018.3
Realiza una solicitud de transmisión HTTPS con la cabecera de autorización generada para un CCDS con OAuth activado. Devuelve una respuesta.
Utiliza los detalles del elemento de configuración de OAuth subyacente junto con la información de autorización del origen de datos para generar la cabecera de autorización de la solicitud de flujo https.
RequestAuthorizedStream(method) admite
  • GET: recuperar datos.
  • POST: envía datos al recurso especificado.
  • PUT: crea o sustituye el recurso especificado.
  • PATCH: aplique modificaciones parciales al recurso.

Respuesta

Método
Descripción
getHttpCode()
Devuelve el código HTTP de la respuesta. Para obtener una lista completa de los códigos de respuesta HTTP, haga clic aquí.
getHeaders()
Devuelve las cabeceras de respuesta.
getBody()
Devuelve el contenido de la respuesta.

Ejemplos

ai.https.request

function testConnection(context) {
    //This example connects to Postman Echo using GET
    var URL = 'https://postman-echo.com/get?foo1=bar1&foo2=bar2';
    var method = 'GET';
    var body = '';
    var headers = null;
    //ai.https.request
    var response = ai.https.request(URL, method, body, headers);
    var responseCode = response.getHttpCode();
    if (responseCode == 200) {
        ai.log.logInfo('Test Connection Succeeded','Response code was 200');
        return true;
    }
    else{
        ai.log.logInfo('Test Connection Failed','Response code was not 200');
        return false;
    }
}
ai.https.requestStream

function testConnection(context) {
    //This example connects to Postman Echo using GET
    var URL = 'https://postman-echo.com/get?foo1=bar1&foo2=bar2';
    var method = 'GET';
    var body = '';
    var headers = null;
    var response = ai.https.requestStream(URL, method, body, headers);
    return true;
 }
ai.https.authorizedRequest

function testConnection(context) {
    //This example connects to Postman Echo using GET
    var URL = 'https://postman-echo.com/basic-auth';
    var method = 'GET';
    var username='postman';
    var pwd='password';
    var body = '<username>'+username+'</username><password>'+pwd+'</password>';
    var headers = {'Authorization': 'Basic cG9zdG1hbjpwYXNzd29yZA=='};
    var response = ai.https.authorizedRequest(URL, method, body, headers);
    var responseCode = response.getHttpCode();
    ai.log.logInfo(responseCode);
    if (responseCode == 200) {
        ai.log.logInfo('Test Connection Succeeded','Response code was 200');
        var responseBody = response.getBody();
        ai.log.logInfo(responseBody); //{"authenticated":true}
        return true;
    }
    else{
        ai.log.logInfo('Test Connection Failed','Response code was not 200');
        return false;
    }
}
ai.requestAuthorizedStream

function testConnection(context) {
    //This example connects to Postman Echo using GET
    var URL = 'https://postman-echo.com/basic-auth';
    var method = 'GET';
    var username='postman';
    var pwd='password';
    var body = '<username>'+username+'</username><password>'+pwd+'</password>';
    var headers = {'Authorization': 'Basic cG9zdG1hbjpwYXNzd29yZA=='};
    var response = ai.https.requestAuthorizedStream(URL, method, body, headers);
}