You can include an identifying string with a Legacy REST Web Services request and the server will include that string in the response it returns. One use of this function is to identify the response to an asynchronous Legacy REST Web Service request.

To specify the identifying string for a Legacy REST Web Services response, include the atg-rest-user-input control parameter in your HTTP request. Set the value of the control parameter to the identifying string. See Adding Control Parameters.

The following example shows a Legacy REST Web Services request that includes the atg-rest-user-input control parameter.

curl -v -b cookies.txt -X GET \
http://myserver:8080/rest/bean/atg/dynamo/Configuration/httpPort?
atg-rest-user-input=MyMessageId001

* About to connect() to myserver port 8080 (#0)
*   Trying 12.34.567.890... connected
* Connected to myserver (12.34.567.890) port 8080 (#0)
> GET /rest/bean/atg/dynamo/Configuration/httpPort?
atg-rest-user-input=MyMessageId001 HTTP/1.1
> User-Agent: curl/7.21.1 (i386-pc-win32) libcurl/7.21.1 zlib/1.2.5
> Host: myserver:8080
> Accept: */*
> Cookie: JSESSIONID=AD84270CB05CC0960580D1B875595822
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< X-Powered-By: Servlet 2.5; JBoss-5.0/JBossWeb-2.1
< X-ATG-Version: version=
QVRHUGxhdGZvcm0vMTAuMCxTZXJ2aWNlLzEwLjAsQ0FGLzEwLjAgWyBQbGF0Zm9ybUxpY2Vuc
2UvMCBTZWxmU2VydmljZUxpY2Vuc2UvMCAgXQ==
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Fri, 22 Oct 2010 16:36:07 GMT
<
{
  "atg-rest-response": {"httpPort": 8080},
  "atg-rest-user-input": "MyMessageId001"
}* Connection #0 to host myserver left intact
* Closing connection #0