EVOLUTION-MANAGER
Edit File: POST.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: POST file to a server.</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for POST {httr}"><tr><td>POST {httr}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>POST file to a server.</h2> <h3>Description</h3> <p>POST file to a server. </p> <h3>Usage</h3> <pre> POST( url = NULL, config = list(), ..., body = NULL, encode = c("multipart", "form", "json", "raw"), handle = NULL ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>url</code></td> <td> <p>the url of the page to retrieve</p> </td></tr> <tr valign="top"><td><code>config</code></td> <td> <p>Additional configuration settings such as http authentication (<code><a href="authenticate.html">authenticate()</a></code>), additional headers (<code><a href="add_headers.html">add_headers()</a></code>), cookies (<code><a href="set_cookies.html">set_cookies()</a></code>) etc. See <code><a href="config.html">config()</a></code> for full details and list of helpers.</p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p>Further named parameters, such as <code>query</code>, <code>path</code>, etc, passed on to <code><a href="modify_url.html">modify_url()</a></code>. Unnamed parameters will be combined with <code><a href="config.html">config()</a></code>.</p> </td></tr> <tr valign="top"><td><code>body</code></td> <td> <p>One of the following: </p> <ul> <li> <p><code>FALSE</code>: No body. This is typically not used with <code>POST</code>, <code>PUT</code>, or <code>PATCH</code>, but can be useful if you need to send a bodyless request (like <code>GET</code>) with <code>VERB()</code>. </p> </li> <li> <p><code>NULL</code>: An empty body </p> </li> <li> <p><code>""</code>: A length 0 body </p> </li> <li> <p><code>upload_file("path/")</code>: The contents of a file. The mime type will be guessed from the extension, or can be supplied explicitly as the second argument to <code>upload_file()</code> </p> </li> <li><p> A character or raw vector: sent as is in body. Use <code><a href="content_type.html">content_type()</a></code> to tell the server what sort of data you are sending. </p> </li> <li><p> A named list: See details for encode. </p> </li></ul> </td></tr> <tr valign="top"><td><code>encode</code></td> <td> <p>If the body is a named list, how should it be encoded? Can be one of form (application/x-www-form-urlencoded), multipart, (multipart/form-data), or json (application/json). </p> <p>For "multipart", list elements can be strings or objects created by <code><a href="upload_file.html">upload_file()</a></code>. For "form", elements are coerced to strings and escaped, use <code>I()</code> to prevent double-escaping. For "json", parameters are automatically "unboxed" (i.e. length 1 vectors are converted to scalars). To preserve a length 1 vector as a vector, wrap in <code>I()</code>. For "raw", either a character or raw vector. You'll need to make sure to set the <code><a href="content_type.html">content_type()</a></code> yourself.</p> </td></tr> <tr valign="top"><td><code>handle</code></td> <td> <p>The handle to use with this request. If not supplied, will be retrieved and reused from the <code><a href="handle_pool.html">handle_pool()</a></code> based on the scheme, hostname and port of the url. By default <span class="pkg">httr</span> requests to the same scheme/host/port combo. This substantially reduces connection time, and ensures that cookies are maintained over multiple requests to the same host. See <code><a href="handle_pool.html">handle_pool()</a></code> for more details.</p> </td></tr> </table> <h3>Value</h3> <p>A <code><a href="response.html">response()</a></code> object. </p> <h3>See Also</h3> <p>Other http methods: <code><a href="BROWSE.html">BROWSE</a>()</code>, <code><a href="DELETE.html">DELETE</a>()</code>, <code><a href="GET.html">GET</a>()</code>, <code><a href="HEAD.html">HEAD</a>()</code>, <code><a href="PATCH.html">PATCH</a>()</code>, <code><a href="PUT.html">PUT</a>()</code>, <code><a href="VERB.html">VERB</a>()</code> </p> <h3>Examples</h3> <pre> b2 <- "http://httpbin.org/post" POST(b2, body = "A simple text string") POST(b2, body = list(x = "A simple text string")) POST(b2, body = list(y = upload_file(system.file("CITATION")))) POST(b2, body = list(x = "A simple text string"), encode = "json") # body can also be provided as a json string directly to deal # with specific case, like an empty element in the json string. # passing as string directly POST(b2, body = '{"a":1,"b":{}}', encode = "raw") # or building the json string before json_body <- jsonlite::toJSON(list(a = 1, b = NULL), auto_unbox = TRUE) POST(b2, body = json_body, encode = "raw") # Various types of empty body: POST(b2, body = NULL, verbose()) POST(b2, body = FALSE, verbose()) POST(b2, body = "", verbose()) </pre> <hr /><div style="text-align: center;">[Package <em>httr</em> version 1.4.2 <a href="00Index.html">Index</a>]</div> </body></html>