http.write

Write data using an HTTP request

Properties

Name	Type	Description	Required
connection (The connection to use for the HTTP request)	string	Logical connection name as defined in the connections.dy.yaml	yes
endpoint			yes
method (HTTP Method)	string	HTTP method to be used for the request Enum: "GET", "PUT", "POST", "DELETE"	yes
payload (Request Payload)	object	Data to be sent in the request body	no
extra_headers (Additional HTTP Headers)	object	Extra headers to be included in the HTTP request	no
extra_query_parameters	object	Extra query parameters to be included in the HTTP request	no
timeout (Timeout in Seconds)	integer	Timeout duration for this specific HTTP request in seconds	no
output	object		no

Example

connection: http_example
endpoint:
  expression: concat(['users/', id])
  language: jmespath
method: PUT
payload:
  full_name:
    expression: full_name
    language: jmespath
  greeting:
    expression: greeting
    language: jmespath
extra_headers:
  my_header:
    expression: lname || '-' || fname
    language: sql
extra_query_parameters:
  fname:
    expression: UPPER(fname)
    language: sql
output:
  status_code: response.status_code
  headers: response.headers
  body: response.content
timeout: 3

payload: Request Payload

Data to be sent in the request body

Additional Properties

|Name|Type|Description|Required| |—-|—-|———–|——–|

extra_headers: Additional HTTP Headers

Extra headers to be included in the HTTP request

Additional Properties

|Name|Type|Description|Required| |—-|—-|———–|——–|

extra_query_parameters: object

Extra query parameters to be included in the HTTP request

Additional Properties

|Name|Type|Description|Required| |—-|—-|———–|——–|

output: object

Properties

Name	Type	Description	Required
status_code (Status Code Field Name)	string	Name of the field where the HTTP response status code will be stored after the request
headers (Headers Field Name)	string	Name of the field where the HTTP response headers will be stored after the request
body (Body Field Name)	string	Name of the field where the HTTP response content will be stored after the request