HTTPRequestData

HTTPRequestData["prop"]

gives the value of the specified property of the current HTTP request.

HTTPRequestData[]

gives an association with values of properties of the current HTTP request.

Details

  • The properties available through HTTPRequestData depend on the evaluation environment being used, as determined by $EvaluationEnvironment.
  • HTTPRequestData["Properties"] gives a list of properties available in any particular case.
  • In web-based environments, the following are typically available:
  • "Scheme"URL scheme (appearing at the beginning)
    "Domain"domain name or host
    "Port"port number (appearing after :)
    "Path"path list (separated by /)
    "PathString"complete path as a string
    "AbsolutePath"complete path as a string, including domain and scheme
    "DispatchPathString"element of path used in URLDispatcher processing
    "Query"list of parameter-value pairs (appearing after ?)
    "QueryString"complete query string
    "Method"typical values include "GET", "PUT", and "POST"
    "Headers"fields of the request header
    "Body"raw body of the request as a string
    "BodyByteArray"raw body of the request as a ByteArray object
    "BodyBytes"raw body of the request as a list of byte values
    "MultipartElements"list of multipart elements
    "FormRules"rules for all form elements in the request

Examples

open allclose all

Basic Examples  (1)

Deploy a delayed expression that will give the request data:

Request the delayed expression to show the request data:

Scope  (4)

Deploy a delayed expression that gives the query parameters as a list of rules:

Request the delayed expression and pass query parameters:

Deploy a delayed expression that gives multiple request data properties:

Request the delayed expression using the POST method:

Deploy a delayed expression that manually checks that query parameters are all numbers:

Implement your own version of APIFunction:

Wolfram Research (2014), HTTPRequestData, Wolfram Language function, https://reference.wolfram.com/language/ref/HTTPRequestData.html (updated 2016).

Text

Wolfram Research (2014), HTTPRequestData, Wolfram Language function, https://reference.wolfram.com/language/ref/HTTPRequestData.html (updated 2016).

CMS

Wolfram Language. 2014. "HTTPRequestData." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2016. https://reference.wolfram.com/language/ref/HTTPRequestData.html.

APA

Wolfram Language. (2014). HTTPRequestData. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/HTTPRequestData.html

BibTeX

@misc{reference.wolfram_2024_httprequestdata, author="Wolfram Research", title="{HTTPRequestData}", year="2016", howpublished="\url{https://reference.wolfram.com/language/ref/HTTPRequestData.html}", note=[Accessed: 21-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_httprequestdata, organization={Wolfram Research}, title={HTTPRequestData}, year={2016}, url={https://reference.wolfram.com/language/ref/HTTPRequestData.html}, note=[Accessed: 21-November-2024 ]}