patch (REST plugin)

Perform a PATCH method REST call against an endpoint.

If no body is returned, an empty string will be present in FDR_RESPONSE_STRING.


Environment/Instance Properties

Property Name

Property Code

Required

Description





  

Project Properties

Property Name

Property Code

Required

Description





  

Inputs

Input Name

Input Code

Required

Description

REST URLFDR_REQUEST_URLYesURL to the desired REST Service
Query StringFDR_QUERY_STRINGNo

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.

UsernameFDR_USERNoThe username for authentication
PasswordFDR_PASSWORDNoThe password for authentication

Preemptive Authentication

FDR_PREEMPTIVE_AUTHNo

Use preemptive Basic authentication (provide authentication before being asked)

if false, non-preemptive Universal authentication is used.

Request Media TypeFDR_REQUEST_MEDIA_TYPENoThe media type to request from the server
Body Media TypeFDR_REQUEST_BODY_MEDIA_TYPEYesThe media type of the body
Body PathFDR_REQUEST_BODY_PATHNo*

The file path containing the request body.

*Either Body or Body Path must be supplied.

BodyFDR_REQUEST_BODYNo*

The String to use as the request body.

*Either Body or Body Path must be supplied.

Ignore SSL Errors

added in 5.0.5

FDR_IGNORE_SSL_ERRORSNo If checked, SSL errors will be ignored. Otherwise they will cause the operation to fail.

  

Outputs

Output Name

Required

Description

FDR_RESPONSE_CODE

No

The Integer response code of from the REST response

FDR_RESPONSE_STRINGNoThe 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 Environment/Instance.


Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.