Skip to content

Http Redirect Writer

The Http Redirect Writer answers a WebAPI request with an HTTP redirect: a response with no body, a status code and a Location header telling the caller where to go next. Both come from the data: the URL from one field of the record, and the status code from another, or 302 when you name none.

It works only with WebAPI. There is nothing to redirect on a file or a URL, so the WebAPI controller is its only target.

Setup

The Setup tab of an Http Redirect writer beneath a WebAPI reader: Transform Id, a collapsed Description, Priority, a Target section reading WebAPI - PDFGET - Pdf Get, and an Options section with Redirect URL Field set to Http.Route and Status Code Field left blank

Transform Id

The unique name of the transform.

Priority

The order this writer runs in among the transforms that share its parent.

Target

The writer offers one target, so there is no drop-down. The section shows only the WebAPI controller's line: WebAPI - followed by the Id and Description of the endpoint whose request the writer answers.

Options

Redirect URL Field

The field holding the URL to redirect to. The list offers the fields of the top-level transaction of the writer's input. Beneath the WebAPI Reader itself, these are its Http.* fields; beneath a Map, whatever the Map's top transaction carries. You must choose a field. If you do not, the integration fails at the start of the writer. If the field is not on the transaction being written, the integration fails at that record.

IMan sends an empty value as an empty Location. It is not an error.

Status Code Field

Optional. The first entry in the list is blank, and blank means 302 (Found, the temporary redirect). If you name a field, IMan sends its value as the status code: 301 for a permanent redirect, 307 or 308 to keep the request's method, or any other integer the field holds. A value that is empty or not a whole number falls back to 302 without an error.

The list offers fields from the same top-level transaction as the URL field. Like the URL field, a named field must be on the transaction written.

Field Mapping

The Field Mapping tab of an Http Redirect writer: a grid of Field Name and Log Key with the fifteen Http fields of the WebAPI reader above it, and an Edit button

The writer writes nothing from the fields, so the grid has two columns: Field Name, and Log Key, which marks the fields whose values identify the record in the audit log. Edit puts the grid into edit mode.

Audit

The writer runs under the same Action on Transform Error as every writer.

Worked example

WebAPI Integration Setup describes returning a response to a WebAPI request. Use this writer when the response should send the caller to another URL.