Define an HTTP Request Action
Use the HTTP Request Action to communicate with an external API using a One-Step™ Action.
For example, add an HTTP Request Action to communicate with AWS.
To define an HTTP Request Action:
- Open the One-Step Editor.
- Add an HTTP Request Action to the Designer Board.
- Provide basic information in the General page:
- Provide a name for the action.
- Select a Method. An HTTP Method defines how a request should be interpreted by a server.
- Provide a URL. Type the URL directly in the field, or use the Selector button to insert Tokens (example: Fields, System Functions, Prompts, Expressions, Stored Values, Metrics, and Counters) into the URL.
- The Body field is not required. If you enter information, ensure you provide the format required by the service you're calling (example: AWS requires JSON). Information you provide in this field is dependent on what web service you are calling, and what information it expects in the call.
- Select the Don't stop One-Step on error check box to have the One-Step™ ActionOne-Step Action continue executing even if the web service call returns an error. This allows for the creation of future steps that show details about the error, or try to handle the error in another way.
- On the Headers page, add any headers you want to pass to the web service. Provide a key and a value for each header. Use the Include variables from: field to add headers to the request using tokens.
- On the Response page, select the POST responses you want to store as variables in the Token selector. You can use those values elsewhere in the One-Step Action. Variable names are provided, but you can change them.
- Store result as:
- Store return code as:
- Store headers as:
- On the Advanced page:
- Select Ignore certificate errors to continue the One-Step Action even if the web service call encounters a certificate error.
- Select Store raw request as: to store the raw request sent to the web service as a variable.
- Select Store raw response as: to store the web service's raw response as a variable.
- Define Annotation properties.