Integration Plugins → Web Services Plugin → Invoke REST Service Step
This step performs a remote REST service request and stores the result.
Required properties:
Property Name | Description |
---|---|
URL | Enter the URL to the remote REST service. |
Optional properties:
Property Name | Description |
---|---|
User Name | User name of the remote user |
Password | Password of the remote user |
Request method | The action to be performed.
Options include:
|
Request Body | The body of the request to be performed |
Destination | The location where the execution result will
be saved.
Options include:
|
Response file | Path to the file where the response will be saved |
Status expression |
An expression in the response to process for the step result. Specify this in one of the following formats: <result property>=<success value> A Groovy script, starting with the comment //GROOVY |
HTTP Headers | This field contains HTTP headers that will
be added to the request. Specify each on a new line, with the header name
separated from the value with '='.
For example: token=Zy65QnbGf |
Content file |
Path to the file containing the request body. The contents will be used as the request body instead of the Request Body field content. |
Content type | The MIME type of the request content. |
Attachments |
Attachment properties should be specified as line-separated strings in the following format: <property name>[<index>]=<property value> Allowed properties are:
Add indexes if there is more than one attachment. For example: type[0]=text name[0]=My Text File file[0]=c:\Temp\MyFile.txt type[1]= binary name[1]=My Exec File file[1]=c:\Temp\MyFile3.exe fileName[1]=NewFileName.exe |
Debug logs | Add debug information to logs. |
Copyright © 2013–2017 Serena Software, Inc., a Micro Focus company. All rights reserved.