Wolfram Language & System 11.0 (2016)|Legacy Documentation

This is documentation for an earlier version of the Wolfram Language.View current documentation (Version 11.2)

URLSubmit

URLSubmit[url]
submits the specified URL to be executed asynchronously.

URLSubmit[url,{"param1"val1,"param2"val2,}]
submits the specified URL, adding elements with names parami and values vali.

URLSubmit[obj,]
submits the cloud object obj.

URLSubmit[HTTPRequest[],]
submits the specified HTTP request.

Details and OptionsDetails and Options

  • In URLSubmit[url], url can be a string, a URL object, or a cloud object.
  • URLSubmit[assoc] is equivalent to URLSubmit[HTTPRequest[assoc]].
  • URLSubmit returns a symbolic representation of an asynchronous task.
  • For simple forms of the vali such as numbers and short strings, URLSubmit performs a GET request, with the parami specifying parameters in the query string. In other cases, it performs a POST request.
  • The vali can be strings or numbers, or the following special forms:
  • None,Null,Missing""
    True"true"
    False"false"
    {e1,e2,}e1, e2,
    imagean image in default format
    ExportForm[expr,form]any expression, exported in the specified form
    File["file"]the contents of a file
  • URLSubmit takes the same options as URLRead, together with:
  • HandlerFunctions<||>how to handle events generated
    HandlerFunctionsKeysAutomaticwhat parameters to supply to handler functions
  • For URLSubmit, the default setting for the option Interactive is False.
  • During the asynchronous execution of URLSubmit, the following events can be generated:
  • "BodyReceived"response body successfully received
    "ConnectionFailed"URL connection failed
    "CookiesReceived"cookies successfully received
    "HeadersReceived"headers successfully received
    "TaskFinished"task finished
    "TaskStatusChange"status of task changes
  • With the specification HandlerFunctions-><|,"eventi"->fi,|>, fi[assoc] is evaluated whenever eventi is generated. The elements of assoc have keys specified by the setting for HandlerFunctionsKeys.
  • Possible keys specified by HandlerFunctionsKeys include:
  • "Body"body of the response as a string
    "BodyByteArray"raw body of the response as a byte array
    "BodyBytes"raw body of the response as a list of byte values
    "Headers"list of headers received in the response
    "Cookies"list of cookies received in the response
    "ContentType"content type header
    "StatusCode"status code returned by the server
    "StatusCodeDescription"plain text description of status code
    "Task"the task object generated by URLSubmit
    "TaskStatus""Running", "Paused", "Finished"
  • Values that have not yet been received are given as Missing["NotAvailable"].

ExamplesExamplesopen allclose all

Basic Examples  (5)Basic Examples  (5)

Send a request and get notified when the task finishes:

In[1]:=
Click for copyable input
Out[1]=

Send a request with parameters:

In[1]:=
Click for copyable input
Out[1]=

Get the status code and content type:

In[1]:=
Click for copyable input
Out[1]=

Build a URL from components:

In[1]:=
Click for copyable input
Out[1]=

More complex requests can use HTTPRequest:

In[1]:=
Click for copyable input
Out[1]=
Introduced in 2016
(11.0)