REST step

Add a REST step to an action in Action Designer to send an outbound REST web service request to an external system.

Note: REST step is not available on base systems and requires the IntegrationHub plugin. When the IntegrationHub plugin is activated, the step is visible under Utilities.

Outbound REST web service is a platform feature that allows you to retrieve, create, update, or delete data on a web services server that supports the REST architecture.

Roles and availability

  • Available as an Action Designer action step. Subject matter experts use the action_designer role to create a custom action with one or more action steps.

Fields

Field Description
Connection Type of connection to use.
  • Define Connection Inline: Define connection information within the REST step.
  • Use Connection Alias: Define connection information using the Connection Alias table. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you do not have to update your custom action.

To learn more about connections and credentials, see credentials, connections, and aliases.

Connection and Credential Alias If Use Connection Alias is selected, select a connection alias or click + to create a new connection. If you selected Define Connection Inline, click + to create a new credential.
HTTP Method HTTP method for the request.
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
Base URL The base URL for the REST request. If Use Connection Alias is selected, this field is read-only and displays the base URL associated with alias. If Define Connection Inline is selected, enter a base URL for the connection.
Resource Path The path for the resource.
Query Parameters Name-value pairs to pass to the REST endpoint. You can create these parameters manually, or drag input variables into the parameter fields, and then assign a value.
Headers Headers to send with the request. You can create headers manually, or drag input variables into the parameter fields, and then assign a value.
Body The body of the request in the format that the content type specifies. This field is available if using the POST, PUT, or PATCH HTTP methods.

If the size of a REST response is larger than 5 MB, the system generates an error. To increase the maximum allowed size of a response, add the glide.pf.rest.response_payload_max_size property and increase the value to a maximum of 10 MB.