Houdini 18.5 Nodes TOP nodes

URL Request TOP node

Creates work items that request data from a URL

Since 18.5

You can use this node to create work items that make an HTTP request to a URL. The response data is stored to either a work item attribute or an external file on disk.

Parameters

Generate When

Determines when this node will generate work items. You should generally leave this set to "Automatic" unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.

All Upstream Items are Generated

This node will generate work items once all of the input nodes have generated their work items.

All Upstream Items are Cooked

This node will generate work items once all of the input nodes have cooked their work items.

Each Upstream Item is Cooked

This node will generate work items each time a work item in an input node is cooked.

Automatic

The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.

Perform Request During

Determines whether the HTTP request should be executed during work item generation or when the work item cooks. If the request is executed during generation, the generation step will block until all of the request has completed. This means that work items will not be added to the node until the HTTP request returns a result.

Request

You can use these parameters to configure the URL, query arguments and request type, e.g. GET, POST, etc.

HTTP Request Type

The type of HTTP request to perform.

Custom User Agent

When this parameter is enabled, the value of the parameter is added as the user agent string on HTTP requests made by work items in the node.

Request Timeout

When this parameter is enabled, any HTTP requests made by work items in this node will fail if a response is not received before the specified time has passed.

Allow Direction

When this parameter is enabled, HTTP requests will follow redirects until they reach an endpoint that supplies a different HTTP status code. If this parameter is disabled the request will not follow redirects and returns 30× status code.

Base URL

The base URL for the request, for example https://www.sidefx.com.

Set URL Parameters

Determines how the node should specify extra parameters to the base URL.

None

No extra URL parameters are added.

From Attributes

URL parameters are set based on attribute names/values, specified using a pattern in the Attribute Pattern field.

From Multiparm

Extra parameters are explicitly added using the Num URL Parameters multiparm.

Attribute Pattern

When Set URL Parameters is set to From Attributes, this parameter is used to determine the attributes that should be added as URL query parameters.

Num URL Parameters

When Set URL Parameters is set to From Multiparm, this parameter determines the number of URL query parameters to add to the base URL.

Name

The name of the URL query parameter.

Value

The value of the URL query parameter.

Payload

You can use these parameters to configure the payload data that gets sent with the request when making a POST or PUT request.

Set Payload From

Determines how the payload data should be specified.

None

No payload data is sent with the request.

Attribute

The payload data is set based on the contents of a work item attribute specified in the Attribute Name parameter.

File

The payload data is loaded from a file on disk.

Custom String

The payload is set to the custom string value specified using the Custom Payload parameter.

Attribute Name

When Set Payload From is set to Attribute, this parameter determines the name of the attribute on the upstream work items that contains the payload data.

File Type

When Set Payload From is set to File this parameter determines how the file path is specified.

Upstream Output File

The file is loaded from an upstream work item’s output file list, based on the tag in the File Tag parameter.

Custom File Path

The file is specified using a custom value from the File Path parameter.

File Tag

If File Type is set to Upstream Output File, this parameter determines the file tag to use when loading an upstream output file.

Multipart Names

If File Type is set to Upstream Output File, it’s possible that there are multiple upstream files with the same File Tag associated with them. If this parameter is enabled the HTTP request POST those files as a multipart request, using the part names specified by a Value Pattern in this parameter.

Custom File Pattern

If File Type is set to Custom File Path, the value of this parameter determines the file path for the payload data.

Custom Payload

When Set Payload From is set to Custom String, this contents of this parameter are added as the payload data to the HTTP request.

Convert Payload to Object

When this parameter is enabled the payload contents are converted to a Python Object.

Response

You can use these parameters to configure how response data from the request gets saved.

Save Response Data To

Determines where the response data should be stored.

None

Response data from the request is discarded.

Attribute

Response data saved directly to a string attribute on the work item that made the request.

File

Response data is saved to a file on disk, which is added as an output file on the work item.

Save As

When Save Response Data To is set to Attribute, this parameter determines how the response data is saved. Data can either be saved to a string attribute or reinterpreted as JSON and saved as a PyObject attribute.

Attribute Name

When Save Response Data To is set to Attribute this parameter determines the name of the work item attribute.

File Path

The file path to save the response to, when Save Response Data To is set to File. This path will also be added to the work item as an output file.

File Tag

The file tag to associated with the output File Path, when Save Response Data To is set to File. By default the node will detect the tag based on the extension of the file, however a custom tag can be used instead.

Custom File Tag

Determines the work item output tag, when saving response data as a file with File Tag set to Custom Tag.

Save as Binary

Determines if the output file should be treated as binary, when saving the response data to a file.

Stream Response Data

If this parameter is enabled the response data is streamed from the remote server that handles the request to its storage location. If this parameter is disable the entire response has to be loaded into memory before it can be saved.

SSL Verification

You can use these parameters to configure the SSL certificate validation performed when making a request to an HTTPS URL.

Verify SSL Certificate

Determines whether or not SSL certificate validation should be performed when making an HTTPS request.

Custom Cert File

The path to a custom file that contains the trusted CAs for certificate verification.

Client Cert Type

Determines how custom client-side certificate should be specified. The certificate can either be a single .pem file or a pair contain the private key and certificate.

Error Handling

These parameters determine how request errors should be handled by the node.

On Request Failure

Determines whether request failures should be treated as a failure, warning or ignored.

Max Retries

When this parameter is enabled requests will tried up this number of time, or until the request returns a successful status code. If this parameter is disabled failed requests are not retried.

Status Code Attrib

When this parameter is enabled the HTTP status code from the request is stored into the specified attribute.

Save Response Headers

When this parameter is enabled, the response headers from the request are stored to attributes on the work item.

TOP nodes