Developer

HTTP Request Argument

The request argument definition encapsulates a data value to be passed from the mobile application to the process being called by the parent HTTP request definition.

The request argument specifies the argument type, which may be CGI Argument, Cookie, HTTP Header, or XML Body. The request argument also specifies the data or data source within the mobile application to pass as the argument to the process or service being called by the parent HTTP request definition.

For a data table, the data value may be the user ID, the name of the data table, a fixed string whose value is defined as a constant within the request argument, or markup text. A given parent HTTP request may contain multiple request arguments. The order in which they are passed to the process or service when called is defined in the parent HTTP request’s list of request arguments.

HTTP Request Argument Attributes

The attributes of a request argument depend in part on the data type of the argument (Data Type attribute). The following list makes note of those attributes specific to a certain argument data type.
  • Argument Type: This attribute specifies the type of argument the definition contains. This may be one of CGI, Cookie, HTTP Header, or XML Body.
  • Name: Alternately displayed as Argument Name, Cookie Name, Header Name, or Name depending on the Argument Type selection. This value must be unique among all request arguments defined within the same parent HTTP request definition.
  • Data Type: Specifies the data value or source for the data value for the request argument. For a data table this may be the Table Name, User ID, Small or Large Markup, or a Fixed String value.
  • String: This attribute is available only when the Data Type attribute is set to Fixed String. String contains the constant string value that is the request argument’s data.
  • Markup Text: This attribute is available only when the Data Type attribute is set to Small Markup or Large Markup. Markup Text contains the single line (Small Markup) of markup text or the contents of the Markup File (Large Markup) that is the data for the request argument.
  • Markup File: This attribute is available only when the Data Type attribute is set to Large Markup. Markup File contains a reference to the text file containing the multi-line markup text. This file is displayed in the Markup Text field directly below the file name in the Editor and can be authored or modified directly in this multi-line field.