Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.
 
No matching results found

Post-Http

This is generated from the built in components of BuildMaster 2024.0, and may be different than what you have installed (especially if you have extensions); go to [Gear Icon] -> Administration -> Operations within your BuildMaster instance to see exactly what operations are available.

Executes an HTTP POST/PUT/PATCH request to a URL, typically used for RESTful operations.

Script usage:

Post-Http(
	[Method: <integer>],
	[ContentType: <text>],
	[TextData: <text>],
	[FormData: <%(key1: value1, ...)>],
	[LogRequestData: <true/false>],
	Url: <text>,
	[LogResponseBody: <true/false>],
	[ErrorStatusCodes: <text>],
	[ResponseBody: <text>],
	[RequestHeaders: <%(key1: value1, ...)>],
	[MaxResponseLength: <integer>],
	[ProxyRequest: <true/false>],
	[Credentials: <text>],
	[UserName: <text>],
	[Password: <text>],
	[IgnoreSslErrors: <true/false>]
);

This operation may be prefixed with HTTP::, although this is a built-in namespace and isn't really necessary.

Arguments:

NameFormatScript UsageUsage Notes
Method
integer
Method
 Default value is "POST".
Content type
text
ContentType
 Default value is "application/x-www-form-urlencoded".
Request text content
text
TextData
Direct text input that will be written to the request content body. This will override any form data if both are supplied.
Form data
%(key1: value1, ...)
FormData
A map of form data key/value pairs to send. If TextData is supplied, this value is ignored.
Log request data
true/false
LogRequestData
☆ URL (default)
text
Url
 This argument is required.
Log response body
true/false
LogResponseBody
Error status codes
text
ErrorStatusCodes
Comma-separated status codes (or ranges in the form of start:end) that should indicate this action has failed. For example, a value of "401,500:599" will fail on all server errors and also when "HTTP Unauthorized" is returned. The default is 400:599. Value note: "400:599".
⇒ Store response as
text
ResponseBody
 Value note: "Do not store response body as variable".
Request headers
%(key1: value1, ...)
RequestHeaders
Max response length
integer
MaxResponseLength
 Default value is "1000".
Use server in context
true/false
ProxyRequest
When selected, this will proxy the HTTP calls through the server is in context instead of using the server Otter or BuildMaster is installed on. Default value is "True".
Credentials
text
Credentials
User name
text
UserName
 Not specifying will "Use user name from credential".
Password
text
Password
 Not specifying will "Use password from credential".
Ignore SSL Errors
true/false
IgnoreSslErrors
 Default value is "False".

Example:


# posts some key-value pairs to a test service and writes the response body to the BuildMaster execution log
Post-Http http://httpbin.org/post
(
    FormData: %(
        Var1: "value1",
        Var2: "value2"
    ),
    LogResponseBody: true
);

inedo.com | Support | MyInedo

docs © 2024 Inedo, LLC