public class TIDRestFunctions
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
RESTDELETEBINARY_KEYWORD
"RestDeleteBinary"
|
static java.lang.String |
RESTDELETECSS_KEYWORD
"RestDeleteCSS"
|
static java.lang.String |
RESTDELETECUSTOM_KEYWORD
"RestDeleteCustom"
|
static java.lang.String |
RESTDELETEHTML_KEYWORD
"RestDeleteHTML"
|
static java.lang.String |
RESTDELETEIMAGE_KEYWORD
"RestDeleteImage"
|
static java.lang.String |
RESTDELETEJSON_KEYWORD
"RestDeleteJSON"
|
static java.lang.String |
RESTDELETESCRIPT_KEYWORD
"RestDeleteScript"
|
static java.lang.String |
RESTDELETETEXT_KEYWORD
"RestDeleteText"
|
static java.lang.String |
RESTDELETEXML_KEYWORD
"RestDeleteXML"
|
static java.lang.String |
RESTENDSERVICESESSION_KEYWORD
"RestEndServiceSession"
|
static java.lang.String |
RESTGETBINARY_KEYWORD
"RestGetBinary"
|
static java.lang.String |
RESTGETCSS_KEYWORD
"RestGetCSS"
|
static java.lang.String |
RESTGETCUSTOM_KEYWORD
"RestGetCustom"
|
static java.lang.String |
RESTGETHTML_KEYWORD
"RestGetHTML"
|
static java.lang.String |
RESTGETIMAGE_KEYWORD
"RestGetImage"
|
static java.lang.String |
RESTGETJSON_KEYWORD
"RestGetJSON"
|
static java.lang.String |
RESTGETSCRIPT_KEYWORD
"RestGetScript"
|
static java.lang.String |
RESTGETTEXT_KEYWORD
"RestGetText"
|
static java.lang.String |
RESTGETXML_KEYWORD
"RestGetXML"
|
static java.lang.String |
RESTHEADBINARY_KEYWORD
"RestHeadBinary"
|
static java.lang.String |
RESTHEADCSS_KEYWORD
"RestHeadCSS"
|
static java.lang.String |
RESTHEADCUSTOM_KEYWORD
"RestHeadCustom"
|
static java.lang.String |
RESTHEADHTML_KEYWORD
"RestHeadHTML"
|
static java.lang.String |
RESTHEADIMAGE_KEYWORD
"RestHeadImage"
|
static java.lang.String |
RESTHEADJSON_KEYWORD
"RestHeadJSON"
|
static java.lang.String |
RESTHEADSCRIPT_KEYWORD
"RestHeadScript"
|
static java.lang.String |
RESTHEADTEXT_KEYWORD
"RestHeadText"
|
static java.lang.String |
RESTHEADXML_KEYWORD
"RestHeadXML"
|
static java.lang.String |
RESTPATCHBINARY_KEYWORD
"RestPatchBinary"
|
static java.lang.String |
RESTPATCHCSS_KEYWORD
"RestPatchCSS"
|
static java.lang.String |
RESTPATCHCUSTOM_KEYWORD
"RestPatchCustom"
|
static java.lang.String |
RESTPATCHHTML_KEYWORD
"RestPatchHTML"
|
static java.lang.String |
RESTPATCHIMAGE_KEYWORD
"RestPatchImage"
|
static java.lang.String |
RESTPATCHJSON_KEYWORD
"RestPatchJSON"
|
static java.lang.String |
RESTPATCHSCRIPT_KEYWORD
"RestPatchScript"
|
static java.lang.String |
RESTPATCHTEXT_KEYWORD
"RestPatchText"
|
static java.lang.String |
RESTPATCHXML_KEYWORD
"RestPatchXML"
|
static java.lang.String |
RESTPOSTBINARY_KEYWORD
"RestPostBinary"
|
static java.lang.String |
RESTPOSTCSS_KEYWORD
"RestPostCSS"
|
static java.lang.String |
RESTPOSTCUSTOM_KEYWORD
"RestPostCustom"
|
static java.lang.String |
RESTPOSTHTML_KEYWORD
"RestPostHTML"
|
static java.lang.String |
RESTPOSTIMAGE_KEYWORD
"RestPostImage"
|
static java.lang.String |
RESTPOSTJSON_KEYWORD
"RestPostJSON"
|
static java.lang.String |
RESTPOSTSCRIPT_KEYWORD
"RestPostScript"
|
static java.lang.String |
RESTPOSTTEXT_KEYWORD
"RestPostText"
|
static java.lang.String |
RESTPOSTXML_KEYWORD
"RestPostXML"
|
static java.lang.String |
RESTPUTBINARY_KEYWORD
"RestPutBinary"
|
static java.lang.String |
RESTPUTCSS_KEYWORD
"RestPutCSS"
|
static java.lang.String |
RESTPUTCUSTOM_KEYWORD
"RestPutCustom"
|
static java.lang.String |
RESTPUTHTML_KEYWORD
"RestPutHTML"
|
static java.lang.String |
RESTPUTIMAGE_KEYWORD
"RestPutImage"
|
static java.lang.String |
RESTPUTJSON_KEYWORD
"RestPutJSON"
|
static java.lang.String |
RESTPUTSCRIPT_KEYWORD
"RestPutScript"
|
static java.lang.String |
RESTPUTTEXT_KEYWORD
"RestPutText"
|
static java.lang.String |
RESTPUTXML_KEYWORD
"RestPutXML"
|
static java.lang.String |
RESTREQUEST_KEYWORD
"RestRequest"
|
static java.lang.String |
RESTSTARTSERVICESESSION_KEYWORD
"RestStartServiceSession"
|
Modifier and Type | Method and Description |
---|---|
static TIDRestFunctions |
getInstance()
public Singleton to access class static methods via instance
|
static ComponentFunction |
restDeleteBinary(java.lang.String winname,
java.lang.String compname)
Delete binary content.
|
static ComponentFunction |
restDeleteCSS(java.lang.String winname,
java.lang.String compname)
Delete css content.
|
static ComponentFunction |
restDeleteCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "DELETE" method on a REST service with headers defined by user.
|
static ComponentFunction |
restDeleteCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "DELETE" method on a REST service with headers defined by user.
|
static ComponentFunction |
restDeleteHTML(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restDeleteImage(java.lang.String winname,
java.lang.String compname)
Delete image content.
|
static ComponentFunction |
restDeleteJSON(java.lang.String winname,
java.lang.String compname)
Delete json content.
|
static ComponentFunction |
restDeleteScript(java.lang.String winname,
java.lang.String compname)
Delete javascript content.
|
static ComponentFunction |
restDeleteText(java.lang.String winname,
java.lang.String compname)
Delete text content.
|
static ComponentFunction |
restDeleteXML(java.lang.String winname,
java.lang.String compname)
Delete xml content.
|
static ComponentFunction |
restEndServiceSession(java.lang.String winname,
java.lang.String compname)
Stop a session for a REST service.
|
static ComponentFunction |
restGetBinary(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is binary before returning it.
|
static ComponentFunction |
restGetBinary(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is binary before returning it.
|
static ComponentFunction |
restGetCSS(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is css before returning it.
|
static ComponentFunction |
restGetCSS(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is css before returning it.
|
static ComponentFunction |
restGetCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user, and return the content.
|
static ComponentFunction |
restGetCustom(java.lang.String winname,
java.lang.String compname,
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 with headers defined by user, and return the content.
|
static ComponentFunction |
restGetHTML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is html before returning it.
|
static ComponentFunction |
restGetHTML(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is html before returning it.
|
static ComponentFunction |
restGetImage(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is image before returning it.
|
static ComponentFunction |
restGetImage(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is image before returning it.
|
static ComponentFunction |
restGetJSON(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is json before returning it.
|
static ComponentFunction |
restGetJSON(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is json before returning it.
|
static ComponentFunction |
restGetScript(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is javascript before returning it.
|
static ComponentFunction |
restGetScript(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is javascript before returning it.
|
static ComponentFunction |
restGetText(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is text before returning it.
|
static ComponentFunction |
restGetText(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is text before returning it.
|
static ComponentFunction |
restGetXML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is xml before returning it.
|
static ComponentFunction |
restGetXML(java.lang.String winname,
java.lang.String compname,
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 verify the returned content is xml before returning it.
|
static ComponentFunction |
restHeadBinary(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is binary before returning the header part.
|
static ComponentFunction |
restHeadBinary(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is binary before returning the header part.
|
static ComponentFunction |
restHeadCSS(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is css before returning the header part.
|
static ComponentFunction |
restHeadCSS(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is css before returning the header part.
|
static ComponentFunction |
restHeadCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method (with headers defined by user) on a REST service, and get back the header part.
|
static ComponentFunction |
restHeadCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method (with headers defined by user) on a REST service, and get back the header part.
|
static ComponentFunction |
restHeadHTML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is html before returning the header part.
|
static ComponentFunction |
restHeadHTML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is html before returning the header part.
|
static ComponentFunction |
restHeadImage(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is image before returning the header part.
|
static ComponentFunction |
restHeadImage(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is image before returning the header part.
|
static ComponentFunction |
restHeadJSON(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is json before returning the header part.
|
static ComponentFunction |
restHeadJSON(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is json before returning the header part.
|
static ComponentFunction |
restHeadScript(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is javascript before returning the header part.
|
static ComponentFunction |
restHeadScript(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is javascript before returning the header part.
|
static ComponentFunction |
restHeadText(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is text before returning the header part.
|
static ComponentFunction |
restHeadText(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is text before returning the header part.
|
static ComponentFunction |
restHeadXML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is xml before returning the header part.
|
static ComponentFunction |
restHeadXML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is xml before returning the header part.
|
static ComponentFunction |
restPatchBinary(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchCSS(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchCustom(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchHTML(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchImage(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchJSON(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchScript(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchText(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPatchXML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PATCH" method on a REST service, and verify the returned status code is 200 or 204.
|
static ComponentFunction |
restPatchXML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PATCH" method on a REST service, and verify the returned status code is 200 or 204.
|
static ComponentFunction |
restPostBinary(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostCSS(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostCustom(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostHTML(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostImage(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostJSON(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostScript(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostText(java.lang.String winname,
java.lang.String compname) |
static ComponentFunction |
restPostXML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "POST" method on a REST service, and verify the returned status code is 201 ("created").
|
static ComponentFunction |
restPostXML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "POST" method on a REST service, and verify the returned status code is 201 ("created").
|
static ComponentFunction |
restPutBinary(java.lang.String winname,
java.lang.String compname)
Put binary content.
|
static ComponentFunction |
restPutCSS(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutCSS(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutCustom(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutHTML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutHTML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutImage(java.lang.String winname,
java.lang.String compname)
Put image content.
|
static ComponentFunction |
restPutJSON(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutJSON(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutScript(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutScript(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutText(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutText(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutXML(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restPutXML(java.lang.String winname,
java.lang.String compname,
java.lang.String relativeURI,
java.lang.String responseIdVar,
java.lang.String body,
java.lang.String headers,
java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204.
|
static ComponentFunction |
restRequest(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Perform an HTTP method on a REST service.
|
static ComponentFunction |
restRequest(java.lang.String winname,
java.lang.String compname,
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.
|
static ComponentFunction |
restStartServiceSession(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Start a session for a REST service.
|
static ComponentFunction |
restStartServiceSession(java.lang.String winname,
java.lang.String compname,
java.lang.String baseURL,
java.lang.String authentication)
Start a session for a REST service.
|
public static final java.lang.String RESTDELETEBINARY_KEYWORD
public static final java.lang.String RESTDELETECSS_KEYWORD
public static final java.lang.String RESTDELETECUSTOM_KEYWORD
public static final java.lang.String RESTDELETEHTML_KEYWORD
public static final java.lang.String RESTDELETEIMAGE_KEYWORD
public static final java.lang.String RESTDELETEJSON_KEYWORD
public static final java.lang.String RESTDELETESCRIPT_KEYWORD
public static final java.lang.String RESTDELETETEXT_KEYWORD
public static final java.lang.String RESTDELETEXML_KEYWORD
public static final java.lang.String RESTENDSERVICESESSION_KEYWORD
public static final java.lang.String RESTGETBINARY_KEYWORD
public static final java.lang.String RESTGETCSS_KEYWORD
public static final java.lang.String RESTGETCUSTOM_KEYWORD
public static final java.lang.String RESTGETHTML_KEYWORD
public static final java.lang.String RESTGETIMAGE_KEYWORD
public static final java.lang.String RESTGETJSON_KEYWORD
public static final java.lang.String RESTGETSCRIPT_KEYWORD
public static final java.lang.String RESTGETTEXT_KEYWORD
public static final java.lang.String RESTGETXML_KEYWORD
public static final java.lang.String RESTHEADBINARY_KEYWORD
public static final java.lang.String RESTHEADCSS_KEYWORD
public static final java.lang.String RESTHEADCUSTOM_KEYWORD
public static final java.lang.String RESTHEADHTML_KEYWORD
public static final java.lang.String RESTHEADIMAGE_KEYWORD
public static final java.lang.String RESTHEADJSON_KEYWORD
public static final java.lang.String RESTHEADSCRIPT_KEYWORD
public static final java.lang.String RESTHEADTEXT_KEYWORD
public static final java.lang.String RESTHEADXML_KEYWORD
public static final java.lang.String RESTPATCHBINARY_KEYWORD
public static final java.lang.String RESTPATCHCSS_KEYWORD
public static final java.lang.String RESTPATCHCUSTOM_KEYWORD
public static final java.lang.String RESTPATCHHTML_KEYWORD
public static final java.lang.String RESTPATCHIMAGE_KEYWORD
public static final java.lang.String RESTPATCHJSON_KEYWORD
public static final java.lang.String RESTPATCHSCRIPT_KEYWORD
public static final java.lang.String RESTPATCHTEXT_KEYWORD
public static final java.lang.String RESTPATCHXML_KEYWORD
public static final java.lang.String RESTPOSTBINARY_KEYWORD
public static final java.lang.String RESTPOSTCSS_KEYWORD
public static final java.lang.String RESTPOSTCUSTOM_KEYWORD
public static final java.lang.String RESTPOSTHTML_KEYWORD
public static final java.lang.String RESTPOSTIMAGE_KEYWORD
public static final java.lang.String RESTPOSTJSON_KEYWORD
public static final java.lang.String RESTPOSTSCRIPT_KEYWORD
public static final java.lang.String RESTPOSTTEXT_KEYWORD
public static final java.lang.String RESTPOSTXML_KEYWORD
public static final java.lang.String RESTPUTBINARY_KEYWORD
public static final java.lang.String RESTPUTCSS_KEYWORD
public static final java.lang.String RESTPUTCUSTOM_KEYWORD
public static final java.lang.String RESTPUTHTML_KEYWORD
public static final java.lang.String RESTPUTIMAGE_KEYWORD
public static final java.lang.String RESTPUTJSON_KEYWORD
public static final java.lang.String RESTPUTSCRIPT_KEYWORD
public static final java.lang.String RESTPUTTEXT_KEYWORD
public static final java.lang.String RESTPUTXML_KEYWORD
public static final java.lang.String RESTREQUEST_KEYWORD
public static final java.lang.String RESTSTARTSERVICESESSION_KEYWORD
public static TIDRestFunctions getInstance()
public static ComponentFunction restDeleteBinary(java.lang.String winname, java.lang.String compname)
Delete binary content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteCSS(java.lang.String winname, java.lang.String compname)
Delete css content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteCustom(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restDeleteCustom(java.lang.String winname, java.lang.String compname, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restDeleteHTML(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteImage(java.lang.String winname, java.lang.String compname)
Delete image content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteJSON(java.lang.String winname, java.lang.String compname)
Delete json content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteScript(java.lang.String winname, java.lang.String compname)
Delete javascript content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteText(java.lang.String winname, java.lang.String compname)
Delete text content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restDeleteXML(java.lang.String winname, java.lang.String compname)
Delete xml content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restEndServiceSession(java.lang.String winname, java.lang.String compname)
Stop a session for a REST service. Stop a session for a REST service.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restGetBinary(java.lang.String winname, java.lang.String compname, 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 verify the returned content is binary before returning it. 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. This action will verify the reponse's headers containing "Content-Type: application/octet-stream" to make sure the returned content is binary. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetBinary(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is binary before returning it. 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. This action will verify the reponse's headers containing "Content-Type: application/octet-stream" to make sure the returned content is binary. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetCSS(java.lang.String winname, java.lang.String compname, 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 verify the returned content is css before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetCSS(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is css before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetCustom(java.lang.String winname, java.lang.String compname, 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 with headers defined by user, and return the content. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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:NO
The custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetCustom(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service with headers defined by user, and return the content. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetHTML(java.lang.String winname, java.lang.String compname, 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 verify the returned content is html before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetHTML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is html before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetImage(java.lang.String winname, java.lang.String compname, 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 verify the returned content is image before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetImage(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is image before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetJSON(java.lang.String winname, java.lang.String compname, 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 verify the returned content is json before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetJSON(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is json before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetScript(java.lang.String winname, java.lang.String compname, 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 verify the returned content is javascript before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetScript(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is javascript before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetText(java.lang.String winname, java.lang.String compname, 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 verify the returned content is text before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is text before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restGetXML(java.lang.String winname, java.lang.String compname, 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 verify the returned content is xml before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restGetXML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "GET" method on a REST service, and verify the returned content is xml before returning it. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadBinary(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is binary before returning the header part. This action will send the "HEAD" 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.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadBinary(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is binary before returning the header part. This action will send the "HEAD" 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.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadCSS(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is css before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadCSS(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is css before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadCustom(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method (with headers defined by user) on a REST service, and get back the header part. This action will send the "HEAD" method with Headers defined by user. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadCustom(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method (with headers defined by user) on a REST service, and get back the header part. This action will send the "HEAD" method with Headers defined by user. 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadHTML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is html before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadHTML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is html before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadImage(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is image before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadImage(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is image before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadJSON(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is json before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadJSON(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is json before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadScript(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is javascript before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadScript(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is javascript before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadText(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is text before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is text before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restHeadXML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "HEAD" method on a REST service, and verify the returned content is xml before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restHeadXML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "HEAD" method on a REST service, and verify the returned content is xml before returning the header part. This action will send the "HEAD" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPatchBinary(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchCSS(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchCustom(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchHTML(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchImage(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchJSON(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchScript(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchText(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPatchXML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PATCH" method on a REST service, and verify the returned status code is 200 or 204. This action will send the "PATCH" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPatchXML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PATCH" method on a REST service, and verify the returned status code is 200 or 204. This action will send the "PATCH" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPostBinary(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostCSS(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostCustom(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostHTML(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostImage(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostJSON(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostScript(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostText(java.lang.String winname, java.lang.String compname)
Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPostXML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "POST" method on a REST service, and verify the returned status code is 201 ("created"). This action will send the "POST" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPostXML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "POST" method on a REST service, and verify the returned status code is 201 ("created"). This action will send the "POST" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutBinary(java.lang.String winname, java.lang.String compname)
Put binary content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPutCSS(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/css". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutCSS(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/css". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutCustom(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutCustom(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutHTML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/html". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutHTML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/html". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutImage(java.lang.String winname, java.lang.String compname)
Put image content. Not implemented yet.Supporting Engines:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.public static ComponentFunction restPutJSON(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : application/json". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutJSON(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : application/json". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutScript(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : application/javascript". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutScript(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : application/javascript". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutText(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/plain". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/plain". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restPutXML(java.lang.String winname, java.lang.String compname, java.lang.String relativeURI, java.lang.String responseIdVar, java.lang.String body, java.lang.String headers, java.lang.String authentication)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restPutXML(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Perform the "PUT" method on a REST service, and verify the returned status code is 201 ("created") or 200 or 204. This action will send the "PUT" method with Headers containing "Content-Type : text/xml". 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restRequest(java.lang.String winname, java.lang.String compname, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 custom headers to be included in this REST request.authentication
- Optional:YES
The custom authentication/authorization information.public static ComponentFunction restRequest(java.lang.String winname, java.lang.String compname, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
public static ComponentFunction restStartServiceSession(java.lang.String winname, java.lang.String compname, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.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 static ComponentFunction restStartServiceSession(java.lang.String winname, java.lang.String compname, 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:
winname
- Optional:NO
The name of the window to act upon.compname
- Optional:NO
The name of the component to act upon.parameters
- Optional:NO
An array containing the following parameters:
Copyright © SAS Institute. All Rights Reserved.