Perform a POST method REST call against an endpoint.
If no body is returned, an empty string will be present in FDR_RESPONSE_STRING
.
Environment/Instance Properties
...
Input Name | Input Code | Required | Description |
---|---|---|---|
REST URL | FDR_REQUEST_URL | Yes | URL to the desired REST Service |
Query String | FDR_QUERY_STRING | No | Query String to be used. Use Groovy if desired to use FlexDeploy variables in the query string. 'a=b&c=d&e='+FD_TEMP_DIR+'&f=g' or, if not using Groovy, simply a=b&c=d Spaces will not be trimmed from the string. |
Username | FDR_USER | No | The username for authentication |
Password | FDR_PASSWORD | No | The password for authentication |
Preemptive Authentication | FDR_PREEMPTIVE_AUTH | No | Use preemptive Basic authentication (provide authentication before being asked) if false, non-preemptive Universal authentication is used. |
Request Media Type | FDR_REQUEST_MEDIA_TYPE | No | The media type to request from the server |
Body Media Type | FDR_REQUEST_BODY_MEDIA_TYPE | Yes | The media type of the body |
Body Path | FDR_REQUEST_BODY_PATH | No* | The file path containing the request body. *Either Body or Body Path must be supplied. |
Body | FDR_REQUEST_BODY | No* | The String to use as the request body. *Either Body or Body Path must be supplied. |
Ignore SSL Errors | FDR_IGNORE_SSL_ERRORS | No | If checked, SSL errors will be ignored. Otherwise they will cause the operation to fail. |
Response Action | FDR_RESPONSE_ACTION | Yes | What action should be taken upon completion of this request? Possible options are:
@since 5.3.0.1 |
Headers | FDR_HEADERS | No | Headers to send with the request. Formatted as key=value. One key/value pair per line. For example:
The headers input also allows FlexDeploy property replacement to be used as seen in the x-client-secret header above @since 5.3.0.1 |
Validation Script | FDR_VALIDATION_SCRIPT | No | Groovy validation script to be run against the response body. This input expects a groovy script as plain text, meaning you should not enable the groovy script flag on the plugin input itself. You can access the response payload via the PAYLOAD variable. The payload will be accessed Available variables:
Example script: PAYLOAD.myField && PAYLOAD.myField.equals('myValue') @since 5.3.0.1 |
Validation Action | FDR_VALIDATION_ACTION | No | What action should be taken if the Groovy Validation Script fails? Valid options are:
@since 5.3.0.1 |
Connect Timeout | FDR_CONNECT_TIMEOUT | No | Time to wait to allow a connection to be established. Setting to 0 will wait forever. @since 5.3.0.1 |
Read Timeout | FDR_READ_TIMEOUT | No | Time to wait for a response after establishing a connection. Setting to 0 will wait forever. @since 5.3.0.1 |
...
Output Name | Required | Description |
---|---|---|
| No | The Integer response code of from the REST response |
FDR_RESPONSE_STRING | No | The first Response Entity is returned as a String. |
...