Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

Excerpt
hiddentrue

Executes an HTTP POST for the given URL using the specified HttpRequest object.

Executes an HTTP POST for the given URL using the specified HttpRequest object. The posted data can be either included in the request object (as name-value parameters) or it can be added as a separate parameter (in the case of JSON, struct etc).Requests can also be sent through a proxy.

...

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

url

String

Yes

The URL.

request

HttpRequest

Yes

A HttpRequest object containing headers, cookies, parameters.

proxy

HttpProxy

No

An HttpProxy object containing the host and port of the proxy server.

postDataObject

variable: primitive type, array or struct

No

Data to be posted.

Return Type

String

Variable return type depends on the left hand side operator type.

...

Code Block
languagejs
//Create request
HttpRequest request;
HttpHeader header = httpCreateHeader("Content-Type", "application/json");
request.headers += header;
//Post data and get response
returnData result = httpPost("https://api.somewebsite.com/contacts/v1/contact/", request, newContact);
//Return ID of newly created user
return result.contactID;
Note

The request parameter should have the HttpRequest type described here. The HttpProxy type is described here.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "http_routine" and space = currentSpace ( )
labelsarray_routines