Docs Menu
- Introduction to Syncloop
- Quick Start Syncloop
-
API Developer Guide
-
middleware
-
pub
- adapter
- authorization
- client
- collection
- date
- docList
- file
- graphQL
- io
- json
- jwt
- math
- platform
- security
- server
- service
- specs
- sql
- string
- bytesToHexString
- bytesToString
- compare
- compareStrings
- concat
- decodeBase64
- decodeHTML
- encodeBase64
- encodeHTML
- equals
- equalsIgnoreCase
- escapeSQL
- fromXML
- htmlDecode
- htmlEncode
- indexOf
- isAlphanumeric
- isBlank
- isDate
- isEmpty
- isNumber
- length
- lookupDict
- maskString
- messageDigest
- messageFormat
- NullOrWhiteSpc
- objectToString
- padLeft
- replace
- rightPad
- stringConcat
- stringIndexOf
- stringToBytes
- subString
- TextArrayToTextString
- TextListCollector
- tokenize
- toLower
- toString
- toUpper
- trim
- urlDecode
- tenant
- util
- xml
-
pub
-
middleware
- User Guide
- FAQs
- Java Docs
- Blogs
API Developer Guide / middleware / pub / client / http / request
Service: request
This service works as an HTTP client and is able to call any type of HTTP call.
Input Parameters:
Name | Type | Description |
url: | String | Provides the HTTP URL of the service |
method: | String | Provides the HTTP method of the calling service |
payload: | String | Provides the request payload. |
headers: | Document | Provides the request headers parameter |
urlParameters: | Document | Provides various URL parameters |
auth: | Document | |
awsSignature: | String | Provides AWS authentication token |
AccessKey: | String | Provides the Access Key |
SecretKey: | String | Encryption Key |
region: | String | Region information |
service: | String | Service Information |
host: | String | Computer or the server that communicates on Network |
signPayload : | String | Payload is signed |
formData: | Document | Provides form data for the request |
inputStream: | Object | Provides content in the input stream. |
settings: | Document | |
sslValidation: | Boolean | Checks for SSL Validation |
responseAsInput: | Boolean | Checks for an ordered stream of Bytes |
requestTimeout: | String | Server would like to shut down this unused connection. |
Output Parameter:
Name | Type | Description |
respHeaders: | Document | Header of the response |
respPayload: | String | Payload of the response |
error: | String | Error message |
inputStream: | Object | Response contents as input stream |
statusCode: | String | Status code of the request |
issucccessful: | Boolean | Connection is successful |