HTTP Request Activity
Description
Enables you to perform HTTP requests to a specified web API.
Properties
Basic Auth
- Password: Password used for the basic authentication.
- Username: Username for the basic authentication
Client Certificate Authentication
- Client Certificate: Certificate to be sent with request. It is the location in which the client certificate file is stored. The full path is required.
- Client Certificate Password: The password that corresponds to the Client Certificate file you are using.
Input
-
Authorization
Method
- NoAuth: The default option. It should be used if the web server you are sending requests to does not require an authentication protocol.
- APIkey: Some APIs use API keys for authorization. An API key is a token that a client provides when making API calls.
- BasicAuth: This option has to be selected if the API you are making requests to uses a simple HTTP authentication protocol.
- OAuth1: This option has to be selected if the API you are making requests to uses an OAuth1 protocol.
- OAuth2:This option has to be selected if the API you are making requests to uses an OAuth2 protocol. This access token is usually generated as a response to another HTTP request to the indicated API.
- Body: An optional body containing data associated with the request. Serializes object to data format specified by Request Format and adds it to the request body.
- End Point: The URL to which you want to make the request. Custom segments need to be defined in URL Segments options.
-
Request Format:
Determines how to serialize the request body and sets the 'content-type' header
accordingly. Following options are supported:
- XML: the Request Body is serialized to XML (using System.XML.Serialization.XmlSerializer) and the 'content-type' header is set to 'application/xml'.
- Json: the Request Body is serialized to Json and the 'content-type' header is set to 'application/json'.
- None: the Request Body is not serialized and the 'content-type' is set to 'application/XML' (useful to hand over an already serialized XML string).
-
Request Method:
The request method to be used when calling the API.
- GET
- POST
- PUT
- DELETE
- HEAD
- OPTIONS
- PATCH
- MERGE
- COPY
Input Expert
- Proxy: A definition of a proxy all requests of this activity should be directed to. This object can be created using Define Proxy Activity.
OAuth1
- Access Token: The access token to be used if the API you are making requests to is based on the OAuth1 authentication protocol, after an authorization request for the consumer has been approved.
- Consumer key: A value used by a Consumer to identify itself to the service provider
- Consumer Secret: A secret used by a Consumer to establish ownership of the consumer key.
- Token Secret: A secret used by the consumer to establish ownership of a given token.
OAuth2
- Access Token: The access token to be used if the API you are making requests to is based on the OAuth2 authentication protocol. This access token is usually generated as a response to another HTTP request to the indicated API.
Options
- Cookies: The cookies in the HTTP request.
- Headers: Enables you to include custom headers in the HTTP request
- Parameters: Parameters to be sent with the request
- URL Segments: Custom segments added to the Endpoint URL between braces "{}" The parameter between the braces need to be defined in parameters.
Output
- Response Header: HTTP header that can be used in an HTTP response
- Result: The response received from the HTTP request as a sting variable
- Status code: Response status code