xdmp.httpPost

xdmp.httppostxdmphttppost

/apidoc/8.0/xdmp:http-post.xml

Sends the http POST request to the server.

The URI to which the data is to be posted.

uri

String

The options object for this request. The default value is null.

The xdmp.httpPost options include the following option, in addition to the options documented with the xdmp.httpGet $options parameter:

data

This option can contain any string. Anything in the data option is sent as a string in the PUT or POST body. When POSTing to a web service, the data may need to be a SOAP XML structure or binary content. The optional third argument can be used to specify the body instead.

The other options are the same as the other xdmp.http* functions, and the options are documented with the xdmp.httpGet $options parameter.

options

Object?

The data for this request. This is an alternative to the data option for the second parameter that allows binary content to be specified for the body of the POST.

data

Node?

ValueIterator

The http functions only operate on URIs that use the http or https schemes; specifying a URI that does not begin with http:// or https:// throws an exception.

If an http function times out, it throws a socket received exception (SVC-SOCRECV).

If you expect the request body from this http function to be processed by another application (via a web service, for example), you should specify a content-type header. If no content-type header is specified, the content type defaults to text/plain.

http://marklogic.com/xdmp/privileges/xdmp-http-post

xdmp.httpPost("http://www.my.com/document.xhtml",
     {
       "authentication" : {
         "method" : "basic",
         "username" : "myname",
         "password" : "mypassword"
       }
     });
=> the response from the server as well as the specified document

//  Use xdmp.quote to encode the JSON as a string
//  because the "data" option is a string 

var payload = xdmp.quote({"foo":"bar"})
xdmp.httpPost("http://www.my.com/document.xhtml",
     {
       "authentication" : {
          "method" : "basic",
          "username" : "myname",
          "password" : "mypassword"
       },
       "data" : payload,
       "headers" : {
         "content-type" : "application/xml"
       }
     });
=> the response from the server as well as the specified document