| Connection |
Type of connection to use.
- Define Connection Inline: Define connection information within the
action 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 don't need to
update your custom action.
To learn more about connections and credentials, see
credentials, connections, and
aliases. |
| Connection Alias |
Connection & Credential alias record that the
system uses to run the action step. Users with the flow_designer or admin role
can create or select an associated Connection record. 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 don't need to update your custom action. To learn more
about connections and credentials, see credentials, connections, and aliases.
The credential value is displayed as a Password (2 Way
Encrypted) data pill on the data pane. Note: This field is available when Use
Connection Alias is selected from the Connection list. |
| Credential Alias |
Credential alias that the system uses to run
the action step. Users with the flow_designer or admin role can create or select
an associated Connection record. Using an alias eliminates the need to configure
multiple credentials when using an action in multiple environments. Likewise, if
the credential information changes, you don't need to update your custom action.
To learn more about connections and credentials, see credentials, connections, and aliases.
The credential value is displayed as a Password (2 Way
Encrypted) data pill on the data pane. Note: This field is available when Define
Connection Inline is selected from the Connection
list. |
| Use MID |
Option to use a ServiceNow®MID Server to run the REST step. Select this check box to display the MID
Application and
Capabilities fields. |
| Base URL |
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. |
| MID Application |
Capabilities the MID Server must support to be
eligible for selection. The system runs the action step from a MID Server that supports the
selected capabilities. Note: This field is
available when the Use MID check box is
enabled. |
| Capabilities |
Capabilities the MID Server must support to be
eligible for selection. The system runs the action step from a MID Server that supports the
selected capabilities. Note: This field is
available when the Use MID check box is
selected. |
| Build Request |
Option to create the request manually, or import an OpenAPI
Specification.
- Manually: Create action inputs
and complete the REST step form manually.
- From OpenAPI specification:
Import an OpenAPI Specification to generate action
inputs and complete the REST step form. For more
information, see OpenAPI support in the REST step.
|
| API Source |
Option to select an OpenAPI Specification used to construct
the request, or select Import OpenAPI
to import a new OpenAPI Specification. You can import
specifications by providing a URL to the YAML or JSON, or
copying and pasting content.
Note: This field is available when you select
From OpenAPI specification from the Build Request
list.
|
| API Operation |
Option to select an operation from the list. Available
operations are provided by the OpenAPI Specification in the
API Source field.
Note: This field is available when you select
From OpenAPI specification from the Build Request
list.
|
| Resource Path |
Path for the resource. |
| HTTP Method |
HTTP method used to process the request.
- GET
- POST
- PUT
- PATCH
- DELETE
|
| 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.
The REST step does not support requests containing duplicate
query parameter names. If you create a REST request
containing duplicate query parameter names, Flow Designer produces an error and prevents
you from saving the action.
Note: When importing an OpenAPI Specification, the system
adds all parameters and headers present in the specification to the REST step.
Review the final REST step values and remove parameters you do not want to send in
the request. For example, if the API accepts content type headers for both JSON
and XML, the system adds both headers to the REST step. Remove one of the headers
depending on the content type you want to receive in the response.
|
| 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.
Note: When importing an OpenAPI Specification, the system
adds all parameters and headers present in the specification to the REST step.
Review the final REST step values and remove parameters you do not want to send in
the request. For example, if the API accepts content type headers for both JSON
and XML, the system adds both headers to the REST step. Remove one of the headers
depending on the content type you want to receive in the response.
|
| Request Type |
Format of the request. Options include.
- Text: A request in JSON, XML, or other text
format.
- Binary: A request in a binary file format.
- Multipart: A request consisting of multiple content
types.
- Form URL-Encoded: A request in a URL-encoded
query.
Note: This field is editable when the HTTP
Method is POST,
PUT,
PATCH, or
DELETE. |
| Request Body [Text] |
Body of the request in JSON or XML format. The flow execution
details display the response body as either a link to the
embedded text viewer or the sys_id of the attachment record
containing the response. Note: This field is editable if you
select Text from the Request Type
list. |
| Attachment |
Attachment record containing the request. You can look up
this record in a prior step or define it as an input
variable. Note: This field is available when you select
Binary from the Request Type
list. |
| Name, Type, Value |
Content of a multiple part request. For each request part,
specify its name, content type, and value. The name can be
any valid string and the type can be any valid type. The
value must match the content type.
For attachments, specify:
- Type: attachment.
- Value: The sys_id of the
Attachment record containing the content. You can
look up this record in a prior step or define it as
an input variable.
Note: These fields are available when you select
Multipart from the Request
Type list.
|
| Name, Value |
Content of a form URL-encoded request. Specify each part of
the URL-encoded request with a name-value pair. Note: This field
is available when you select Form
URL-Encoded from the Request Type
list. |
| Enable Retry Policy |
Option to enable the retry policy. For more
information, see Retry
policy. |
| Override Default Policy for Alias |
Option to override the default retry policy. This check box is not applicable when Define
Connection Inline is selected from the Connection list. |
| Retry Policy |
Default retry policy associated with
Connection Alias. If Override Default Policy
for Alias is selected, you can override the default retry policy and
select another existing retry policy based on your requirement. |
| Save As Attachment |
Option to specify whether to save the response as a record in
the Attachment [sys_attachment] table. |
| Attachment File Name |
Name of the attachment created by the REST response. For
example, rest-response.txt. Note: This
field is available when Save As
Attachment is selected. |
| Attachment File Record |
Target record to which the attachment is associated. The
target record must be a data pill of type
Record. For example, a specific
incident record. You can look up this record in a prior step or
define it as an input variable. The flow execution details
display the sys_id of the associated record. Note: This field is
available when Save As Attachment is
selected. |
