Skip to main content
Version: 8.1

HTTP_FORM_DATA - UCA for SOA command option

Description​

The HTTP_FORM_DATA option specifies whether or not there is HTTP form data provided as an XML document in the payload file.

Usage​

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Long Form

-httpformdata option

Values​

option is the specification for whether or not there is form data in the payload file.

Valid values for option are:

  • true
    There is form data in the payload file.
  • false
    There is not form data in the payload file.

Default is false.

Format of Form Data​

Form data is provided as the payload to the service request. The form data is formatted as an XML document as defined by the XML Schema Definition (XSD) below.

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://com.stonebranch/UAI/HTTPFormData" xmlns="http://com.stonebranch/UAI/HTTPFormData"	elementFormDefault="qualified">
    <xsd:element name="HTTPFormData" type="HTTPFormDataType" />
    <xsd:complexType name="HTTPFormDataType">
        <xsd:sequence>
            <xsd:element name="Property" maxOccurs="unbounded" type="PropertyType" minOccurs="0" />
        </xsd:sequence>
    </xsd:complexType>
    <xsd:complexType name="PropertyType">
        <xsd:sequence>
            <xsd:element name="Name" type="xsd:string" />
            <xsd:element name="Value" type="xsd:string" />
        </xsd:sequence>
    </xsd:complexType>
</xsd:schema>
</pre>

The XSD defines the form data as a <HTTPFormData> XML element containing a sequence of property values defined by the <property> XML tag. Each property value consist of a name and value defined by a <name> and <value> XML tag, respectively.

The following illustrates a form data XML document that contains two properties. The first property has a name of "Comments" with a value of "You only live once, but if you work it right, once is enough.". The second property has a name of "box" and a value of "yes".

<?xml version="1.0" encoding="UTF-8"?>
<p:HTTPFormData xmlns:p="http://com.stonebranch/UAI/HTTPFormData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://com.stonebranch/UAI/HTTPFormData HTTPFormData.xsd ">
    <p:Property>
        <p:Name>Comments</p:Name>
        <p:Value>You only live once, but if you work it right, once is enough.</p:Value>
    </p:Property>
    <p:Property>
        <p:Name>box</p:Name>
        <p:Value>yes</p:Value>
    </p:Property>
</p:HTTPFormData>