Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    ActiveCampaign
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    ConstantContact
    Couchbase
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FreshBooks
    FTP
    Geonames
    GoogleDrive
    GoogleSearch
    GoogleSheet
    GreenMile
    GpsInsight
    HttpEndpoint (REST)
    Intacct
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    OneDrive
    OneDrive365 (Business)
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Teams
    Threading
    Twilio
    Twitter
    VellemanDMX
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/httpendpoint




HTTPEndpoint


This adapter allows you to access HTTP services, including REST endpoints, such as the Microsoft Azure Cognitive Services.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String uri The service URL to call
String authMode Authentication mode selected for the call (none, apikey, basic, bearer) none
String keyParam The API Key parameter name to use
String sendKeyAs The method used to send the key (Form,Query,Header)
String apiKey The API Key, or username:password when using authMode apiKey or basic respectivelly
String throwErrorIfStatusNotIn Comma-seperated list of HTTP status codes that considered successful results; will throw error if HTTP status code not in this list. Leave blank to ignore all errors.

Handlers



SendHttpRequest
HttpRequest
Sends an HTTP request (POST by default) sending a string payload to an URI endpoint (webhook) details 

Arguments

Name Description Default
payload R
payloadMethod string
contentType application/json
headers
payloadName
uri
method post

SQL Call

exec HttpEndpoint.SendHttpRequest '{"id": 1, "fname": "herve"}'


Http Call

/bsc/httpendpoint/sendhttprequest

Output Columns

String response
String payloadA payload to send
String payloadMethodThe method used to send the payload (String,Form,Query,Header)
String contentTypeThe Content-Type to use for the request payload (ex: application/xml)
String headersAdditional headers to be passed separated by a comma (ex: myHeader: value1)
String payloadNameParameter name to use for the payload (ignored when payload is a string)
String uriThe URI to append to the service URL
String methodThe HTTP method to use (post,delete,put,get)
SendHttpRequestBytes
HttpRequestBytes
Sends an HTTP request (POST by default) sending a byte array to an URI endpoint (webhook) details 

Arguments

Name Description Default
payloadAsBytes R
payloadMethod string
contentType application/json
headers
payloadName
uri
method post

SQL Call

exec HttpEndpoint.SendHttpRequestBytes 0x01020304


Http Call

/bsc/httpendpoint/sendhttprequestbytes

Output Columns

String response
Object payloadAsBytesA payload to send as a byte array
String payloadMethodThe method used to send the payload (String,Form,Query,Header)
String contentTypeThe Content-Type to use for the request (ex: application/xml)
String headersAdditional headers to be passed separated by a comma (ex: myHeader: value1)
String payloadNameParameter name to use for the payload (ignored when payload is a string)
String uriThe URI to append to the service URL
String methodThe HTTP method to use (post,delete,put,get)