|
Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

Workiva Support Center

HTTP Request commands

HTTP Request commands

  • Last updated on

An HTTP Requests connection executes these commands to perform common HyperText Transfer Protocol (HTTP) requests to a given URL to connect and automate supported solutions through their respective connectors.

To see how an HTTP Request is structured, see our HTTP Connector example list.

Note: Although this is labeled as HTTP Request, HTTPS (Secure HTTP) is supported (and recommended).

Requirements

  • While the connection has no OData-specific features, you can add any necessary components of the request via the Headers or Query string parameters.
  • To enable mutual TLS (mTLS) authentication, provide a public/private key pair and, optionally, a CA certificate. To use the public and private keys, upload them as workspace resources, and then select them for the command's Certificate and Certificate private key parameters, respectively.
  • The file containing the private key must not be encrypted. Loading an encrypted file as a private key will result in an error.

To enable these commands, an IT admin first creates a HTTP Request connector.

Delete

To remove a resource, use a Delete command. This command makes an HTTP DELETE request, such as http://postman-echo.com/delete.

Properties

Property Detail
Username If basic authentication is required, enter the username.
Password If basic authentication is required, enter the password.
CA certificate Enter the Certificate Authority (CA) certificate to use when making the request (optional).
Certificate Enter the certificate to send with the request (optional). If provided, also enter Certificate private key.
Certificate private key Enter the private key for Certificate, if provided.
Show response To show the API response body in the output, check this box.
URL Enter the URL used for the request, such as http://postman-echo.com/delete.
Content type Enter the content-type header to set. This specifies the expected format to send to the request body.
Body file Enter the file that contains the JSON object or request parameters to send in the request body. If you include this, leave Body text blank.
Body text Enter the text to send in the request body. If you include this, leave Body file blank.
Headers Enter any additional headers to add to the request.

Outputs

Output Output type
Response headers JSON
Response File
Response code Integer

Exit codes

Code Type Detail
0 Success Success
2 Error Request failed; non-200 response code
4 Error Certificate not found
5 Error Invalid request headers

Get

To retrieve a resource, use a Get command. This command makes an HTTP GET request, such as https://postman-echo.com/get?foo1=bar1&foo2=bar2.

Note: This command includes a space to enter query parameters -- parameters should not be included in the URL itself. If parameters are entered in both the URL and the "Query string" field, they will be stripped from the URL.

Properties

Property Detail
Username If basic authentication is required, enter the username.
Password If basic authentication is required, enter the password.
CA certificate Enter the CA certificate to use when making the request (optional).
Certificate Enter the certificate to send with the request (optional). If provided, also enter Certificate private key.
Certificate private key Enter the private key for Certificate, if provided.
Show response To show the API response body in the output, check this box.
URL Enter the URL used for the request, such as https://postman-echo.com/get.
Query string

Enter the query string to append to the request, such as foo1=bar1&foo2=bar2.

Note: The query string must be encoded.
Headers Enter any additional headers to add to the request.
Content type Enter the content-type header to set, such as application/json. This specifies the expected format to send to the request body.
Output schema To enable later commands in the chain to access this command's output properties, enter a sample payload for each JSON output. 

Outputs

Output Output type
Response headers JSON
Response File
Response code Integer

Exit codes

Code Type Detail
0 Success Success
2 Error Request failed; non-200 response code
4 Error Certificate not found
5 Error Invalid request headers

Post

To place a resource, use a Post command. This command makes an HTTP POST request, such as https://postman-echo.com/post.

Properties

Property Detail
Username If basic authentication is required, enter the username.
Password If basic authentication is required, enter the password.
CA certificate Enter the CA certificate to use when making the request (optional).
Certificate Enter the certificate to send with the request (optional). If provided, also enter Certificate private key.
Certificate private key Enter the private key for Certificate, if provided.
Show response To show the API response body in the output, check this box.
URL Enter the URL used for the request, such as https://postman-echo.com/post.
Content type

Enter the content-type header to set. This specifies the expected format to send to the request body.

Note: For multi-part data, add Form values instead to generate the body.
Body file Enter the file that contains the JSON object or request parameters to send in the request body. If you include this, leave Body text blank.
Body text

Enter the text to send in the request body. If you include this, leave Body file blank.
Tip: if there are multi-select parameters,  use the following pattern:

{
   "queryId": "YOUR_QUERY_ID",
   "parameters": {
      "yourParamName": ["value1", "value2"]
    }
}
Headers Enter any additional headers to add to the request.
Form values To generate the body for multi-part data, add the form values to include in the request, and enter the name and value for each. If you add form values, leave Content type blank.
Output schema To enable later commands in the chain to access this command's output properties, enter a sample payload for each JSON output. 

Outputs

Output Output type
Response headers JSON
Response File
Response Code Integer

Exit codes

Code Type Detail
0 Success Success
2 Error Request failed; non-200 response code
4 Error Certificate not found
5 Error Invalid request headers

Put

To change or update a resource, use a Put command. This command makes an HTTP PUT request, such as https://postman-echo.com/put.

Properties

Property Detail
Username If basic authentication is required, enter the username.
Password If basic authentication is required, enter the password.
CA certificate Enter the CA certificate to use when making the request (optional).
Certificate Enter the certificate to send with the request (optional). If provided, also enter Certificate private key.
Certificate private key Enter the private key for Certificate, if provided.
Show response To show the API response body in the output, check this box.
URL Enter the URL used for the request.
Content type

Enter the content-type header to set. This specifies the expected format to send to the request body.

Note: For multi-part data, add Form values instead to generate the body.
Body file Enter the file that contains the JSON object or request parameters to send in the request body. If you include this, leave Body text blank.
Body text Enter the text to send in the request body. If you include this, leave Body file blank.
Headers Enter any additional headers to add to the request.
Form values To generate the body for multi-part data, add the form values to include in the request, and enter the name and value for each. If you add form values, leave Content type blank.
Output schema To enable later commands in the chain to access this command's output properties, enter a sample payload for each JSON output.

Outputs

Output Output type
Response headers JSON
Response File
Response code Integer

Exit codes

Code Type Detail
0 Success Success
2 Error Request failed; non-200 response code
4 Error Certificate not found
5 Error Invalid request headers
An HTTP Requests connection executes these commands to perform common HyperText Transfer Protocol (HTTP) requests to ...