patch (REST plugin)
Perform a PATCH method REST call against an endpoint.
Prior to the 7.0.0.0, 6.5.0.3, 6.0.0.7, 5.7.0.13 releases, the Patch operation always used a POST method with a header sent to tell the target server to override it as a post. Since those versions, if Java 8+ is found, it will be sent as an actual Patch method instead.
If no body is returned, an empty string will be present inĀ FDR_RESPONSE_STRING
.
Inputs
Input Name | Input Code | Required | Description |
---|---|---|---|
REST URL |
| Yes | URL to the desired REST Service This input supports FlexDeploy property replacement. i.e. you can use ${{PROP1}} in the input value. |
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. The query string input also allows FlexDeploy property replacement to be used |
Username |
| No | The username for authentication |
Password |
| No | The password for authentication |
Preemptive Authentication |
| No | Use preemptive Basic authentication (provide authentication before being asked) if false, non-preemptive Universal authentication is used. |
Request Media Type |
| No | The media type to request from the server |
Body Media Type |
| Yes | The media type of the body |
Body Path |
| No* | The file path containing the request body. *Either Body or Body Path must be supplied. This input supports FlexDeploy property replacement. i.e. you can use ${{PROP1}} in the input value. |
Body |
| No* | The String to use as the request body. *Either Body or Body Path must be supplied. This input supports FlexDeploy property replacement. i.e. you can use ${{PROP1}} in the input value. |
Ignore SSL Errors |
| No | Ā If checked, SSL errors will be ignored. Otherwise they will cause the operation to fail. |
Response Action |
| Yes | What action should be taken upon completion of this request? Possible options are:
|
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 |
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.Ā Available variables:
Returning true indicates that the response was considered successful. False indicates that the response should be considered unsuccessful. Example script: PAYLOAD.myField && PAYLOAD.myField.equals('myValue') |
Validation Action |
| No | What action should be taken if the Groovy Validation Script fails?Ā Valid options are:
|
Connect Timeout |
| No | Time to wait to allow a connection to be established. Setting to 0 will wait forever. |
Read Timeout |
| No | Time to wait for a response after establishing a connection. Setting to 0 will wait forever. |
Outputs
Output Name | Required | Description |
---|---|---|
| No | The Integer response code of from the REST response |
| No | The first Response Entity is returned as a String. |
Artifacts
This operation doesnāt consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
- style