DDDriverRestCommands

DDDriverRestCommands::RestCleanResponseMap
TID

Delete REST response (and request if it is stored) from the internal Map.

Delete a REST response (and request if it is stored) from the internal Map. The REST response/request is stored internally in a Map of pair (responsID, Response). BE CAREFUL WHNE CALLING THIS KEYWORD! It will clean Response from internal Map, and can cause other keyword failing to work.

Fields: [ ]=Optional with Default Value

[ responseID = ]

The ID used to delete Response Object from internal Map.

Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

Examples:

C, RestCleanResponseMap, responseID
Delete Response identified by 'responseID' from internal Map.

C, RestCleanResponseMap
Delete all Responses from internal Map, which means the internal Map will be cleaned up.
BE CAREFUL WHNE CALLING THIS KEYWORD! It can cause other keyword fails to work.

[How To Read This Reference]

DDDriverRestCommands::RestDeleteResponse
TID

Delete a REST response (and request if stored) from the persistent storages.

Delete a REST response (and request if stored) from the persistent storages. The REST response/request is supposed to be in the persistent storages. The response/request can be in more than one type of persistence storage, and it can be a series of variables, a file or something else, please refer to explanation of parameters of keyword RestStoreResponse. For example, if the Response/Request is stored be in a XML file, a JSON file and "a series of variables" at the same time, then this keyword will delete all of them (XML file, JSON file and variables).

Fields: [ ]=Optional with Default Value

responseID

The ID of the Response/Request (stored in persistence storages) to be deleted.

The Response/Request can stored be in more than one type of persistence storage; For example, it can be in a XML file, a JSON file and "a series of variables" at the same time. This keyword will delete all of them.
Please refer to keyword RestStoreResponse if you want to know exactly what type of persistence storage can be used to save a REST response/request.

Examples:

C, RestDeleteResponse, ResponseID
Delete REST response/request (identified by ResponseID) from persistence storages.
If the response/request (identified by ResponseID) has be stored to variables prefixed with 'BayerCustomerGet' and JSON file 'BayerCustomerGet.json'. The variables listed as below will be deleted:
- BayerCustomerGet.Response.Id
- BayerCustomerGet.Response.StatusCode
- BayerCustomerGet.Response.HttpVersion
- etc...
- BayerCustomerGet.Request.Method
- BayerCustomerGet.Request.URI
- etc...
The file 'BayerCustomerGet.json' will also be deleted.

[How To Read This Reference]

DDDriverRestCommands::RestDeleteResponseStore
TID

Delete ALL REST responses (and requests if stored) from the persistent storages.

Delete ALL REST responses (and requests if stored) from the persistent storages. The REST response/request is supposed to be in the persistent storages. The response/request can be in more than one type of persistence storage, and it can be a series of variables, a file or something else, please refer to explanation of parameters of keyword RestStoreResponse. For example, if there are 2 Responses/Requests have been persisted, one is stored be in a XML file, a JSON file and "a series of variables" at the same time, the other is stored in JSON file and "a series of variables", then this keyword will delete all of them (XML file, JSON file and variables of the first Response/Request, JSON file and "a series of variables" of the second Response/Request).

Fields: [ ]=Optional with Default Value

Examples:

C, RestDeleteResponseStore
Delete ALL REST responses (and requests if stored) from the persistent storages.

For example, if there are 2 Responses/Requests have been persisted, one is stored be in a XML file, a JSON file and "a series of variables" at the same time, the other is stored in JSON file and "a series of variables", then this keyword will delete all of them (XML file, JSON file and variables of the first Response/Request, JSON file and "a series of variables" of the second Response/Request).

[How To Read This Reference]

DDDriverRestCommands::RestHeadersLoad
TID

Load headers from a file.

This might be called before invoking a REST action, like RESTGetXML etc. And the loaded headers will be used when executing that REST action if no headers are provided as parameter of that REST action.

Fields: [ ]=Optional with Default Value

headersFile

The path to file holding headers information.

The content is to be decided. JSON=single/multi-line header
XML=single/multi-line header

[ method = ]

The method is used to load the "headers" from a file.
If this parameter is not provided, then "headers" of all methods will be loaded.
The possible methods are listed below:
- DELETE
- GET
- HEAD
- PATCH
- POST
- PUT

[ type = ]

The type is used to load the "headers" from a file.
If this parameter is not provided, then "headers" of all types will be loaded.
The possible types are listed below:
- BINARY
- CSS
- CUSTOM
- HTML
- JSON
- IMAGE
- SCRIPT
- TEXT
- XML

Examples:

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, GET, JSON
Load the "headers" of type "JSON" for method "GET" from file HeadersFile.

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, DELETE
Load the "headers" of all types for method "DELETE" from file HeadersFile.

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, , JSON
Load the "headers" of type "JSON" for all methods from file HeadersFile.

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile
Load all "headers" from file HeadersFile.

[How To Read This Reference]

DDDriverRestCommands::RestStoreResponse
TID

Save a REST response into a persistent storage.

Retrieve a REST response according to the responseID, and store the response into a persistent storage. The persistent storage can be a series of variables, a file or something else, please refer to explanation of parameters.

Fields: [ ]=Optional with Default Value

responseID

The ID used to retrieve Response Object from internal Map.

Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

variablePrefix

The prefix of the variables to store the information of a REST response/request if parameter persistenceType is VARIABLE.
Or the file name holding the information of a REST response/request if parameter persistenceType is FILE.

If this parameter means a 'variable prefix'.
The variablePrefix is used to deduce variables to store a REST response. Deduced variables are listed as below:

variablePrefix.Response.Id
variablePrefix.Response.StatusCode
variablePrefix.Response.HttpVersion
variablePrefix.Response.ContentType
variablePrefix.Response.EntityBody
variablePrefix.Response.EntityLength
variablePrefix.Response.Headers
to be added ...

If the parameter storeRequest is true, then the originating REST Request will also be stored in the deduced variables listed as below:

variablePrefix.Request.Method
variablePrefix.Request.URI
variablePrefix.Request.HttpVersion
variablePrefix.Request.Headers
variablePrefix.Request.MessageBody
to be added ...

If this parameter means a file name, then the information of a REST Response (and Request if the parameter storeRequest is true) will be stored in a file.
The file could be a property file, a json file, or an XML file, examples as below:
Please pay attention to the special characters (new-line, double-quote, <?XML etc.) escaped by the escape character shown in read as below.

    a JSON file example
    {
    "Response":{
      "StatusCode": "200",
      "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}",
      "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER>    \n</CUSTOMERList>",
      "Request": {
         "Method": "GET",
         "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}"
      }
     }
    }
    
    an XML file example:
    <Response>
      <StatusCode>200</StatusCode>
      <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers>
      <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER>
        </CUSTOMERList>]]></EntityBody>
      <Request>
        <Method>GET</Method>
        <Headers>
          Content-Type:application/octet-stream, Accept:application/octet-stream
        </Headers>
      </Request>
    </Response>
    
    a Properties file example:
    Response.ContentType : application/xml
    Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n  </CUSTOMERList>
    Response.EntityLength : 0
    Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1}
    Response.Request.Headers : Content-Type:application/octet-stream
    Accept:application/octet-stream

[ storeRequest = False ]

Store the originating Request information if this parameter is true. The default value is false.

[ persistenceType = VARIABLE ]

The type of the persistence storage to save the Response/Request information.
The valid parameter values are listed below:
- FILE
- VARIABLE

[ fileType = JSON ]

The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:
- JSON
- PROPERTIES
- XML

Examples:

C, RestStoreResponse, ResponseID, BayerCustomerGet
Store a REST response into a series of variables prefixed by "BayerCustomerGet".
After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID. This keyword is going to store the Response into a series of variables prefixed by "BayerCustomerGet", such as:
- BayerCustomerGet.Response.StatusCode
- BayerCustomerGet.Response.ContentType
- BayerCustomerGet.Response.EntityBody
- etc...

C, RestStoreResponse, ^ResponseIDVar, BayerCustomerGet
Store a REST response into a series of variables prefixed by "BayerCustomerGet".
After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID stored in variable ResponseIDVar. This keyword is going to store the Response into a series of variables prefixed by "BayerCustomerGet", such as:
- BayerCustomerGet.Response.StatusCode
- BayerCustomerGet.Response.ContentType
- BayerCustomerGet.Response.EntityBody
- etc...

C, RestStoreResponse, ResponseID, BayerCustomerGet, True
Store a REST response and originating request into a series of variables prefixed by "BayerCustomerGet".
After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID. This keyword is going to store the Response into a series of variables prefixed by "BayerCustomerGet", such as:
- BayerCustomerGet.Response.StatusCode
- BayerCustomerGet.Response.ContentType
- BayerCustomerGet.Response.EntityBody
- etc...
and at the same time it is going to store the originating REST Request into a series of variables prefixed by "BayerCustomerGet", such as:
- BayerCustomerGet.Request.Method
- BayerCustomerGet.Request.URI
- BayerCustomerGet.Request.Headers
- BayerCustomerGet.Request.MessageBody
- etc...

C, RestStoreResponse, ResponseID, persistentFile, False, FILE
Store a REST response into a persistent file of default type (refer to parameter fileType)

After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID stored in variable ResponseIDVar. This keyword is going to store the Response into a persistent file of default type (refer to parameter fileType)

C, RestStoreResponse, ResponseID, persistentFile, False, FILE, JSON
Store a REST response into a JSON file.

After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID stored in variable ResponseIDVar. This keyword is going to store the Response into a JSON file.

C, RestStoreResponse, ResponseID, persistentFile, False, FILE, XML
Store a REST response into a XML file.

After executing a REST GET request on "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", SAFS returns a ResponseID stored in variable ResponseIDVar. This keyword is going to store the Response into a XML file.

[How To Read This Reference]

DDDriverRestCommands::RestVerifyResponse
TID

Verify a REST response is what is expected.

Retrieve a REST response according to the responseID, and compare the response with the content stored in a bench file.
The comparison should be defined by parameter verifyRequest, valueContains and valueCaseSensitive.

Fields: [ ]=Optional with Default Value

responseID

The ID used to retrieve Response Object from internal Map.

Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

benchFile

The bench file for verifying a REST response.

The bench file can be a property file, a json file, or an XML file. Examples listed as below:
Please pay attention to the special characters (new-line, double-quote, <?XML etc.) escaped by the escape character shown in read as below.

    a JSON file example
    {
    "Response":{
      "StatusCode": "200",
      "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}",
      "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER>    \n</CUSTOMERList>",
      "Request": {
         "Method": "GET",
         "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}"
      }
     }
    }
    
    an XML file example:
    <Response>
      <StatusCode>200</StatusCode>
      <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers>
      <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER>
        </CUSTOMERList>]]></EntityBody>
      <Request>
        <Method>GET</Method>
        <Headers>
          Content-Type:application/octet-stream, Accept:application/octet-stream
        </Headers>
      </Request>
    </Response>
    
    a Properties file example:
    Response.ContentType : application/xml
    Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n  </CUSTOMERList>
    Response.EntityLength : 0
    Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1}
    Response.Request.Headers : Content-Type:application/octet-stream
    Accept:application/octet-stream

[ fileType = JSON ]

The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:
- JSON
- PROPERTIES
- XML

[ result = <responseID>.verification.result ]

The variable holding the verification result.

If this parameter is not provided, then the 'verification result' will be automatically saved to a deduced variable "<responseID>.verification.result".

[ verifyRequest = FALSE ]

If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.

[ valueContains = FALSE ]

If true, then verify that Response/Request field's value contains that in benchFile;
Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile;
The default value is false;

[ valueCaseSensitive = TRUE ]

If true, then verify that Response/Request field's value matches case sensitively with that in benchFile;
Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile;
The default value is true;

Examples:

C, RestVerifyResponse, ResponseID, BenchFile
Compare the Response identified by ResponseID with the content stored in the JSON BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be compared with the content stored in the JSON BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponse, ResponseID, BenchFile, XML
Compare the Response identified by ResponseID with the content stored in the XML BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be compared with the content stored in the XML BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponse, ResponseID, BenchFile, XML, verifyResult
Compare the Response identified by ResponseID with the content stored in the XML BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be compared with the content stored in the XML BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "verifyResult".

C, RestVerifyResponse, ResponseID, BenchFile, XML, , true
Compare the Response (including Request) identified by ResponseID with the content stored in the XML BenchFile.

According to the ResponseID, a Response(including Request) object will be retrieved from the internal Map storage, and it will be compared with the content stored in the XML BenchFile.
The field's value of Response(including Request) object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponse, ResponseID, BenchFile, XML, , true, true, false
Compare the Response (including Request) identified by ResponseID with the content stored in the XML BenchFile.

According to the ResponseID, a Response (including Request) object will be retrieved from the internal Map storage, and it will be compared with the content stored in the XML BenchFile.
The field's value of Response(including Request) object should contain the value in bench file case-insensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponse, ResponseID, BenchFile, XML, , false, false, false
Compare the Response identified by ResponseID with the content stored in the XML BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be compared with the content stored in the XML BenchFile.
The field's value of Response object should match the value in bench file case-insensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

[How To Read This Reference]

DDDriverRestCommands::RestVerifyResponseContains
TID

Verify a REST response contains what is expected.

Retrieve a REST response according to the responseID, and verify that the response contains the content stored in a bench file.
The Contains in keyword RestVerifyResponseContains means the Response/Request contains the fields defined in the bench file, that is to say not all fields of Response/Request should be matched
For the field's value, it should be defined by parameter valueContains and valueCaseSensitive.

Fields: [ ]=Optional with Default Value

responseID

The ID used to retrieve Response Object from internal Map.

Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

benchFile

The bench file for verifying a REST response.

    a JSON file example
    {
    "Response":{
      "StatusCode": "200",
      "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}",
      "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER>    \n</CUSTOMERList>",
      "Request": {
         "Method": "GET",
         "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}"
      }
     }
    }
    
    an XML file example:
    <Response>
      <StatusCode>200</StatusCode>
      <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers>
      <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>
        <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER>
        </CUSTOMERList>]]></EntityBody>
      <Request>
        <Method>GET</Method>
        <Headers>
          Content-Type:application/octet-stream, Accept:application/octet-stream
        </Headers>
      </Request>
    </Response>
    
    a Properties file example:
    Response.ContentType : application/xml
    Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n    <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n  </CUSTOMERList>
    Response.EntityLength : 0
    Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1}
    Response.Request.Headers : Content-Type:application/octet-stream
    Accept:application/octet-stream

[ fileType = JSON ]

The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:
- JSON
- PROPERTIES
- XML

[ result = <responseID>.verification.result ]

The variable holding the verification result.

If this parameter is not provided, then the 'verification result' will be automatically saved to a deduced variable "<responseID>.verification.result".

[ verifyRequest = FALSE ]

If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.

[ valueContains = FALSE ]

If true, then verify that Response/Request field's value contains that in benchFile;
Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile;
The default value is false;

[ valueCaseSensitive = TRUE ]

If true, then verify that Response/Request field's value matches case sensitively with that in benchFile;
Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile;
The default value is true;

Examples:

C, RestVerifyResponseContains, ResponseID, BenchFile
Verify that the Response identified by ResponseID contains the content stored in the JSON BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be used to verify containing the content stored in the the JSON BenchFile.
Not all fields of Response will be checked, only those defined in the JSON BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponseContains, ResponseID, BenchFile, XML
Verify that the Response identified by ResponseID contains the content stored in the XML BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be used to verify containing the content stored in the the XML BenchFile.
Not all fields of Response will be checked, only those defined in the XML BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, verifyResult
Verify that the Response identified by ResponseID contains the content stored in the XML BenchFile.

According to the ResponseID, a Response object will be retrieved from the internal Map storage, and it will be used to verify containing the content stored in the the XML BenchFile.
Not all fields of Response will be checked, only those defined in the XML BenchFile.
The field's value of Response object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "verifyResult".

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, , true
Verify that the Response (including Request) identified by ResponseID contains the content stored in the XML BenchFile.

According to the ResponseID, a Response (including Request) object will be retrieved from the internal Map storage, and it will be used to verify containing the content stored in the the XML BenchFile.
Not all fields of Response(including Request) will be checked, only those defined in the XML BenchFile.
The field's value of Response(including Request) object should match the value in bench file case-sensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, , true, true, false
Verify that the Response (including Request) identified by ResponseID contains the content stored in the XML BenchFile.

According to the ResponseID, a Response (including Request) object will be retrieved from the internal Map storage, and it will be used to verify containing the content stored in the the XML BenchFile.
Not all fields of Response(including Request) will be checked, only those defined in the XML BenchFile.
The field's value of Response(including Request) object should contain the value in bench file case-insensitively.
The 'verification result' will be automatically saved to the variable "<responseID>.verification.result".

[How To Read This Reference]

DDDriverRestCommands

DDDriverRestCommands::RestCleanResponseMap TID

DDDriverRestCommands::RestDeleteResponse TID

DDDriverRestCommands::RestDeleteResponseStore TID

DDDriverRestCommands::RestHeadersLoad TID

DDDriverRestCommands::RestStoreResponse TID

DDDriverRestCommands::RestVerifyResponse TID

DDDriverRestCommands::RestVerifyResponseContains TID

DDDriverRestCommands::RestCleanResponseMap
TID

DDDriverRestCommands::RestDeleteResponse
TID

DDDriverRestCommands::RestDeleteResponseStore
TID

DDDriverRestCommands::RestHeadersLoad
TID

DDDriverRestCommands::RestStoreResponse
TID

DDDriverRestCommands::RestVerifyResponse
TID

DDDriverRestCommands::RestVerifyResponseContains
TID