HTTP headers and HTML form fields for using the Web Gateway
You can customize a request to create or retrieve a resource by using HTTP headers or HTML form fields. Each parameter maps to a property or function of WebSphere® MQ File Transfer Edition.
The HTTP convention is to preface custom headers with x- followed by a product-specific identifier. WebSphere MQ File Transfer Edition uses the product identifier fte-.
Header name | Form field name | Supported object types and verbs | Command-line command and parameter | Description | Example usage of header | Example usage of form field |
---|---|---|---|---|---|---|
x-fte-action | action | File (POST) | fteCreateTransfer, -de | Specifies the action to take if the destination
file exists. Valid options are:
|
x-fte-action:overwrite | <input type="HIDDEN" name="action" value="overwrite"/> |
x-fte-priority | priority | File (POST) | fteCreateTransfer, -pr | Specifies the priority of the transfer. | x-fte-priority:5 | <input type="HIDDEN" name="priority" value="5"/> |
x-fte-type | type | File (POST) | fteCreateTransfer, -t | Specifies whether the transfer is in binary
or text mode. Valid options are:
|
x-fte-type:binary | <input type="HIDDEN" name="type" value="binary"/> |
x-fte-checksum | checksum | File (POST) | fteCreateTransfer, -cs | Specifies the checksum algorithm to use
to check that the transfer sent the data correctly. Valid options
are:
|
x-fte-checksum:MD5 | <input type="HIDDEN" name="checksum" value="MD5"/> |
x-fte-metadata | metadata | File (POST) | fteCreateTransfer, -md | Specifies metadata to associate with the transfer. The metadata header or form field can be specified multiple times within a single request. |
x-fte-metadata:a=b,c=d,e=f | <input type="HIDDEN" name="metadata" value="a=b,c=d,e=f"/> |
x-fte-jobname | jobname | File (POST) | fteCreateTransfer, -jn | Specifies to job name to associate with the transfer. | x-fte-jobname:BatchOrder_1 | <input type="HIDDEN" name="jobname" value="BatchOrder_1"/> |
x-fte-postdest | postdest | File (POST) | fteAnt, where the ant script that is called contains a nested postdst element | Specifies a command to execute at the destination agent when the file transfer has completed. Supports all attributes available to a program invocation. For more details of these attributes, see the topic Program invocation nested elements | x-fte-postdest:[command=virus_scan.sh, type=executable,successrc=0] | <input type="HIDDEN" name="postdest" value="[command=virus_scan.sh, type=executable,successrc=0]"/> |
x-fte-postdest-args | postdest-args | File (POST) | fteAnt, where the Ant script that is called specifies arg elements on a postdst element | Specifies one or more arguments to pass to a command if a command has been specified using the x-fte-postdest header. Only valid if the type attribute specified in the x-fte-postdest header is executable. Supports all attributes available to a program invocation. For more details of these attributes, see the topic Program invocation nested elements. |
x-fte-postdest-args:[argument1, argument2] | <input type="HIDDEN" name="postdest-args" value="[argument1, argument2]"/> |
x-fte-postdest-properties | postdest-properties | File (POST) | fteAnt, where the Ant script that is called specifies property elements on a postdst element | Specifies one or more properties to pass to an Ant script if an Ant script has been specified using the x-fte-postdest header. Only valid if the type attribute specified in the x-fte-postdest header is antscript. Supports all attributes available to a program invocation. For more details of these attributes, see the topic Program invocation nested elements. |
x-fte-postdest-properties:[scanspeed=fast,resultoutput=scan.log] | <input type="HIDDEN" name="postdest-properties" value="[scanspeed=fast,resultoutput=scan.log]"/> |
x-fte-postdest-targets | postdest-targets | File (POST) | fteAnt, where the Ant script that is called specifies target elements on a postdst element | Specifies one or more targets to run from an Ant script if an Ant script has been specified using the x-fte-postdest header. Only valid if the type attribute specified in the x-fte-postdest header is antscript. For more details, see the topic Program invocation nested elements. |
x-fte-postdest-targets:[scanfile] | <input type="HIDDEN" name="postdest-targets" value="[scanfile]"/> |
x-fte-include-file-in-response | None | File (DELETE) | None | Specifies whether the deleted file is included in the HTTP response. The default is false. |
x-fte-include-file-in-response:true Specifies whether the deleted file is included in the HTTP response. The default is false. |
None |
x-fte-check-integrity | None | File space (GET) | None | On a request to view the contents of a file space, specifies that an integrity check should be carried out on the file space files. On a request to list all file spaces, specifies that an integrity check should be carried out on the file space root. The default is false. |
x-fte-check-integrity:true | None |