public class TIDRest extends UIComponent
Modifier | Constructor and Description |
---|---|
protected |
TIDRest(java.lang.String compname) |
|
TIDRest(java.lang.String winname,
java.lang.String compname)
Constructor
Create an instance of pseudo-component representing
a specific component in a specific window.
|
|
TIDRest(Window window,
java.lang.String compname)
Constructor
Create an instance of pseudo-component representing
a specific component in a specific window.
|
Modifier and Type | Method and Description |
---|---|
ComponentFunction |
restDeleteBinary() |
void |
restDeleteBinary(StepTestTable table) |
ComponentFunction |
restDeleteCSS() |
void |
restDeleteCSS(StepTestTable table) |
void |
restDeleteCustom(StepTestTable table,
java.lang.String[] parameters)
Perform the "DELETE" method on a REST service with headers defined by user.
|
void |
restDeleteCustom(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String headers,
java.lang.String body,
java.lang.String authentication)
Perform the "DELETE" method on a REST service with headers defined by user.
|
ComponentFunction |
restDeleteCustom(java.lang.String[] parameters)
Perform the "DELETE" method on a REST service with headers defined by user.
|
ComponentFunction |
restDeleteCustom(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String headers,
java.lang.String body,
java.lang.String authentication)
Perform the "DELETE" method on a REST service with headers defined by user.
|
ComponentFunction |
restDeleteHTML() |
void |
restDeleteHTML(StepTestTable table) |
ComponentFunction |
restDeleteImage() |
void |
restDeleteImage(StepTestTable table) |
ComponentFunction |
restDeleteJSON() |
void |
restDeleteJSON(StepTestTable table) |
ComponentFunction |
restDeleteScript() |
void |
restDeleteScript(StepTestTable table) |
ComponentFunction |
restDeleteText() |
void |
restDeleteText(StepTestTable table) |
ComponentFunction |
restDeleteXML() |
void |
restDeleteXML(StepTestTable table) |
ComponentFunction |
restEndServiceSession()
Stop a session for a REST service.
|
void |
restEndServiceSession(StepTestTable table)
Stop a session for a REST service.
|
void |
restGetBinary(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the binary content.
|
void |
restGetBinary(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the binary content.
|
ComponentFunction |
restGetBinary(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the binary content.
|
ComponentFunction |
restGetBinary(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the binary content.
|
void |
restGetCSS(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the css text content.
|
void |
restGetCSS(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the css text content.
|
ComponentFunction |
restGetCSS(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the css text content.
|
ComponentFunction |
restGetCSS(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the css text content.
|
void |
restGetCustom(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user.
|
void |
restGetCustom(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String headers,
java.lang.String body,
java.lang.String authentication)
Perform the "GET" method on a REST service with headers defined by user.
|
ComponentFunction |
restGetCustom(java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user.
|
ComponentFunction |
restGetCustom(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String headers,
java.lang.String body,
java.lang.String authentication)
Perform the "GET" method on a REST service with headers defined by user.
|
void |
restGetHTML(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the html text content.
|
void |
restGetHTML(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the html text content.
|
ComponentFunction |
restGetHTML(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the html text content.
|
ComponentFunction |
restGetHTML(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the html text content.
|
void |
restGetImage(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the image content.
|
void |
restGetImage(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the image content.
|
ComponentFunction |
restGetImage(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the image content.
|
ComponentFunction |
restGetImage(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the image content.
|
void |
restGetJSON(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the json text content.
|
void |
restGetJSON(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the json text content.
|
ComponentFunction |
restGetJSON(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the json text content.
|
ComponentFunction |
restGetJSON(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the json text content.
|
void |
restGetScript(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the javascript text content.
|
void |
restGetScript(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the javascript text content.
|
ComponentFunction |
restGetScript(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the javascript text content.
|
ComponentFunction |
restGetScript(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the javascript text content.
|
void |
restGetText(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the plain text content.
|
void |
restGetText(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the plain text content.
|
ComponentFunction |
restGetText(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the plain text content.
|
ComponentFunction |
restGetText(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the plain text content.
|
void |
restGetXML(StepTestTable table,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the xml text content.
|
void |
restGetXML(StepTestTable table,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the xml text content.
|
ComponentFunction |
restGetXML(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the xml text content.
|
ComponentFunction |
restGetXML(java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the xml text content.
|
ComponentFunction |
restHeadBinary() |
void |
restHeadBinary(StepTestTable table) |
ComponentFunction |
restHeadCSS() |
void |
restHeadCSS(StepTestTable table) |
ComponentFunction |
restHeadCustom() |
void |
restHeadCustom(StepTestTable table) |
ComponentFunction |
restHeadHTML() |
void |
restHeadHTML(StepTestTable table) |
ComponentFunction |
restHeadImage() |
void |
restHeadImage(StepTestTable table) |
ComponentFunction |
restHeadJSON() |
void |
restHeadJSON(StepTestTable table) |
ComponentFunction |
restHeadScript() |
void |
restHeadScript(StepTestTable table) |
ComponentFunction |
restHeadText() |
void |
restHeadText(StepTestTable table) |
ComponentFunction |
restHeadXML() |
void |
restHeadXML(StepTestTable table) |
ComponentFunction |
restPatchBinary() |
void |
restPatchBinary(StepTestTable table) |
ComponentFunction |
restPatchCSS() |
void |
restPatchCSS(StepTestTable table) |
ComponentFunction |
restPatchCustom() |
void |
restPatchCustom(StepTestTable table) |
ComponentFunction |
restPatchHTML() |
void |
restPatchHTML(StepTestTable table) |
ComponentFunction |
restPatchImage() |
void |
restPatchImage(StepTestTable table) |
ComponentFunction |
restPatchJSON() |
void |
restPatchJSON(StepTestTable table) |
ComponentFunction |
restPatchScript() |
void |
restPatchScript(StepTestTable table) |
ComponentFunction |
restPatchText() |
void |
restPatchText(StepTestTable table) |
ComponentFunction |
restPatchXML() |
void |
restPatchXML(StepTestTable table) |
ComponentFunction |
restPostBinary() |
void |
restPostBinary(StepTestTable table) |
ComponentFunction |
restPostCSS() |
void |
restPostCSS(StepTestTable table) |
ComponentFunction |
restPostCustom() |
void |
restPostCustom(StepTestTable table) |
ComponentFunction |
restPostHTML() |
void |
restPostHTML(StepTestTable table) |
ComponentFunction |
restPostImage() |
void |
restPostImage(StepTestTable table) |
ComponentFunction |
restPostJSON() |
void |
restPostJSON(StepTestTable table) |
ComponentFunction |
restPostScript() |
void |
restPostScript(StepTestTable table) |
ComponentFunction |
restPostText() |
void |
restPostText(StepTestTable table) |
ComponentFunction |
restPostXML() |
void |
restPostXML(StepTestTable table) |
ComponentFunction |
restPutBinary() |
void |
restPutBinary(StepTestTable table) |
ComponentFunction |
restPutCSS() |
void |
restPutCSS(StepTestTable table) |
ComponentFunction |
restPutCustom() |
void |
restPutCustom(StepTestTable table) |
ComponentFunction |
restPutHTML() |
void |
restPutHTML(StepTestTable table) |
ComponentFunction |
restPutImage() |
void |
restPutImage(StepTestTable table) |
ComponentFunction |
restPutJSON() |
void |
restPutJSON(StepTestTable table) |
ComponentFunction |
restPutScript() |
void |
restPutScript(StepTestTable table) |
ComponentFunction |
restPutText() |
void |
restPutText(StepTestTable table) |
ComponentFunction |
restPutXML() |
void |
restPutXML(StepTestTable table) |
void |
restRequest(StepTestTable table,
java.lang.String[] parameters)
Perform an HTTP method on a REST service.
|
void |
restRequest(StepTestTable table,
java.lang.String hTTPMethod,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform an HTTP method on a REST service.
|
ComponentFunction |
restRequest(java.lang.String[] parameters)
Perform an HTTP method on a REST service.
|
ComponentFunction |
restRequest(java.lang.String hTTPMethod,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform an HTTP method on a REST service.
|
void |
restStartServiceSession(StepTestTable table,
java.lang.String[] parameters)
Start a session for a REST service.
|
void |
restStartServiceSession(StepTestTable table,
java.lang.String baseURL,
java.lang.String authentication)
Start a session for a REST service.
|
ComponentFunction |
restStartServiceSession(java.lang.String[] parameters)
Start a session for a REST service.
|
ComponentFunction |
restStartServiceSession(java.lang.String baseURL,
java.lang.String authentication)
Start a session for a REST service.
|
getWindow, setWindow
getName, getParent, getParentName, quote
public TIDRest(Window window, java.lang.String compname)
window
- Optional:NO
Specifies which Window this component is 'in'.compname
- Optional:NO
Specifies the AppMap name of the component in the Window.public TIDRest(java.lang.String winname, java.lang.String compname)
winname
- Optional:NO
Specifies the AppMap name of the window.compname
- Optional:NO
Specifies the AppMap name of the component in the Window.protected TIDRest(java.lang.String compname)
public ComponentFunction restDeleteBinary()
Supporting Engines:
public void restDeleteBinary(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteCSS()
Supporting Engines:
public void restDeleteCSS(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteCustom(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String headers, java.lang.String body, java.lang.String authentication)
Perform the "DELETE" method on a REST service with headers defined by user. This action will send the "DELETE" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.headers
- Optional:NO
The headers to be included in this REST request.body
- Optional:YESThe body to send with this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restDeleteCustom(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String headers, java.lang.String body, java.lang.String authentication)
Perform the "DELETE" method on a REST service with headers defined by user. This action will send the "DELETE" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.headers
- Optional:NO
The headers to be included in this REST request.body
- Optional:YESThe body to send with this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restDeleteCustom(java.lang.String[] parameters)
Perform the "DELETE" method on a REST service with headers defined by user. This action will send the "DELETE" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restDeleteCustom(StepTestTable table, java.lang.String[] parameters)
Perform the "DELETE" method on a REST service with headers defined by user. This action will send the "DELETE" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restDeleteHTML()
Supporting Engines:
public void restDeleteHTML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteImage()
Supporting Engines:
public void restDeleteImage(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteJSON()
Supporting Engines:
public void restDeleteJSON(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteScript()
Supporting Engines:
public void restDeleteScript(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteText()
Supporting Engines:
public void restDeleteText(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restDeleteXML()
Supporting Engines:
public void restDeleteXML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restEndServiceSession()
Stop a session for a REST service. Stop a session for a REST service.Supporting Engines:
public void restEndServiceSession(StepTestTable table)
Stop a session for a REST service. Stop a session for a REST service.Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restGetBinary(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the binary content. This action will send the "GET" method with Headers containing "Accept : application/octet-stream". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information by keyword's parameter.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetBinary(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the binary content. This action will send the "GET" method with Headers containing "Accept : application/octet-stream". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information by keyword's parameter.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetBinary(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the binary content. This action will send the "GET" method with Headers containing "Accept : application/octet-stream". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information by keyword's parameter.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetBinary(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the binary content. This action will send the "GET" method with Headers containing "Accept : application/octet-stream". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information by keyword's parameter.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetCSS(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the css text content. This action will send the "GET" method with Headers containing "Accept : text/css". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetCSS(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the css text content. This action will send the "GET" method with Headers containing "Accept : text/css". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetCSS(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the css text content. This action will send the "GET" method with Headers containing "Accept : text/css". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetCSS(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the css text content. This action will send the "GET" method with Headers containing "Accept : text/css". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetCustom(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String headers, java.lang.String body, java.lang.String authentication)
Perform the "GET" method on a REST service with headers defined by user. This action will send the "GET" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.headers
- Optional:NO
The headers to be included in this REST request.body
- Optional:YESThe body to send with this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetCustom(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String headers, java.lang.String body, java.lang.String authentication)
Perform the "GET" method on a REST service with headers defined by user. This action will send the "GET" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.headers
- Optional:NO
The headers to be included in this REST request.body
- Optional:YESThe body to send with this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetCustom(java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user. This action will send the "GET" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetCustom(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user. This action will send the "GET" method with Headers defined by user. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetHTML(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the html text content. This action will send the "GET" method with Headers containing "Accept : text/html". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetHTML(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the html text content. This action will send the "GET" method with Headers containing "Accept : text/html". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetHTML(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the html text content. This action will send the "GET" method with Headers containing "Accept : text/html". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetHTML(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the html text content. This action will send the "GET" method with Headers containing "Accept : text/html". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetImage(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the image content. This action will send the "GET" method with Headers containing "Accept : image". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetImage(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the image content. This action will send the "GET" method with Headers containing "Accept : image". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetImage(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the image content. This action will send the "GET" method with Headers containing "Accept : image". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetImage(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the image content. This action will send the "GET" method with Headers containing "Accept : image". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetJSON(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the json text content. This action will send the "GET" method with Headers containing "Accept : application/json". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetJSON(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the json text content. This action will send the "GET" method with Headers containing "Accept : application/json". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetJSON(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the json text content. This action will send the "GET" method with Headers containing "Accept : application/json". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetJSON(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the json text content. This action will send the "GET" method with Headers containing "Accept : application/json". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetScript(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the javascript text content. This action will send the "GET" method with Headers containing "Accept : application/javascript". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetScript(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the javascript text content. This action will send the "GET" method with Headers containing "Accept : application/javascript". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetScript(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the javascript text content. This action will send the "GET" method with Headers containing "Accept : application/javascript". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetScript(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the javascript text content. This action will send the "GET" method with Headers containing "Accept : application/javascript". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetText(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the plain text content. This action will send the "GET" method with Headers containing "Accept : text/plain". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetText(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the plain text content. This action will send the "GET" method with Headers containing "Accept : text/plain". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetText(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the plain text content. This action will send the "GET" method with Headers containing "Accept : text/plain". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetText(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the plain text content. This action will send the "GET" method with Headers containing "Accept : text/plain". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restGetXML(java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the xml text content. This action will send the "GET" method with Headers containing "Accept : text/xml". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restGetXML(StepTestTable table, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "GET" method on a REST service, and try to get back the xml text content. This action will send the "GET" method with Headers containing "Accept : text/xml". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restGetXML(java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the xml text content. This action will send the "GET" method with Headers containing "Accept : text/xml". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restGetXML(StepTestTable table, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and try to get back the xml text content. This action will send the "GET" method with Headers containing "Accept : text/xml". It only tells the server what type of content is expected, and it is not guarantee that the server will return it. If the field SessionIDItem is provided in the map, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restHeadBinary()
Supporting Engines:
public void restHeadBinary(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadCSS()
Supporting Engines:
public void restHeadCSS(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadCustom()
Supporting Engines:
public void restHeadCustom(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadHTML()
Supporting Engines:
public void restHeadHTML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadImage()
Supporting Engines:
public void restHeadImage(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadJSON()
Supporting Engines:
public void restHeadJSON(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadScript()
Supporting Engines:
public void restHeadScript(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadText()
Supporting Engines:
public void restHeadText(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restHeadXML()
Supporting Engines:
public void restHeadXML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchBinary()
Supporting Engines:
public void restPatchBinary(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchCSS()
Supporting Engines:
public void restPatchCSS(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchCustom()
Supporting Engines:
public void restPatchCustom(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchHTML()
Supporting Engines:
public void restPatchHTML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchImage()
Supporting Engines:
public void restPatchImage(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchJSON()
Supporting Engines:
public void restPatchJSON(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchScript()
Supporting Engines:
public void restPatchScript(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchText()
Supporting Engines:
public void restPatchText(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPatchXML()
Supporting Engines:
public void restPatchXML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostBinary()
Supporting Engines:
public void restPostBinary(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostCSS()
Supporting Engines:
public void restPostCSS(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostCustom()
Supporting Engines:
public void restPostCustom(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostHTML()
Supporting Engines:
public void restPostHTML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostImage()
Supporting Engines:
public void restPostImage(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostJSON()
Supporting Engines:
public void restPostJSON(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostScript()
Supporting Engines:
public void restPostScript(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostText()
Supporting Engines:
public void restPostText(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPostXML()
Supporting Engines:
public void restPostXML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutBinary()
Supporting Engines:
public void restPutBinary(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutCSS()
Supporting Engines:
public void restPutCSS(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutCustom()
Supporting Engines:
public void restPutCustom(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutHTML()
Supporting Engines:
public void restPutHTML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutImage()
Supporting Engines:
public void restPutImage(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutJSON()
Supporting Engines:
public void restPutJSON(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutScript()
Supporting Engines:
public void restPutScript(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutText()
Supporting Engines:
public void restPutText(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restPutXML()
Supporting Engines:
public void restPutXML(StepTestTable table)
Supporting Engines:
table
- Optional:NO
The table to add the record to.public ComponentFunction restRequest(java.lang.String hTTPMethod, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform an HTTP method on a REST service. If the test field SessionIDItem is provided, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
hTTPMethod
- Optional:NOThe HTTP method to execute.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding the ID (generated internally), which is used to
get the Response Object from the internal Map.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public void restRequest(StepTestTable table, java.lang.String hTTPMethod, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform an HTTP method on a REST service. If the test field SessionIDItem is provided, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.hTTPMethod
- Optional:NOThe HTTP method to execute.relativeURI
- Optional:NOThe relative URI combined with a base-URL (stored in a session) to form a REST service URL.responseIdVar
- Optional:NO
The name of the variable holding the ID (generated internally), which is used to
get the Response Object from the internal Map.body
- Optional:YESThe body to send with this REST request.headers
- Optional:YES
The headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public ComponentFunction restRequest(java.lang.String[] parameters)
Perform an HTTP method on a REST service. If the test field SessionIDItem is provided, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restRequest(StepTestTable table, java.lang.String[] parameters)
Perform an HTTP method on a REST service. If the test field SessionIDItem is provided, the keyword RestStartServiceSession SHOULD be executed before executing this action, which will be handled within a session. Otherwise, it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction restStartServiceSession(java.lang.String baseURL, java.lang.String authentication)
Start a session for a REST service. Currently the "base URL" and "authentication information" will be stored for the opened session.Supporting Engines:
baseURL
- Optional:NOThe base URL to be stored with a session.authentication
- Optional:YES
The file holding authentication information to be used during this session.public void restStartServiceSession(StepTestTable table, java.lang.String baseURL, java.lang.String authentication)
Start a session for a REST service. Currently the "base URL" and "authentication information" will be stored for the opened session.Supporting Engines:
table
- Optional:NO
The table to add the record to.baseURL
- Optional:NOThe base URL to be stored with a session.authentication
- Optional:YES
The file holding authentication information to be used during this session.public ComponentFunction restStartServiceSession(java.lang.String[] parameters)
Start a session for a REST service. Currently the "base URL" and "authentication information" will be stored for the opened session.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void restStartServiceSession(StepTestTable table, java.lang.String[] parameters)
Start a session for a REST service. Currently the "base URL" and "authentication information" will be stored for the opened session.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
Copyright © SAS Institute. All Rights Reserved.