exportRequirements Interface

The exportRequirements interface is used to export requirements as XML files. The following table shows the parameters of the exportRequirements interface.

Interface URL Parameter Descriptions

http://<front-end URL>/servicesExchange?hid=exportRequirements

sid Web-service token or session identifier for user authentication. You can generate the web-service token in the Settings Page of the Silk Central UI. To access this page, hover the mouse cursor over the user name in the Silk Central menu and select User Settings. You can retrieve the session identifier by invoking the logonUser method of one of the Available Web Services.
  nodeID The node with this ID and, recursively, all of the node's children nodes are exported
includeObsolete Optional: Specify true or false. Defaults to true if omitted. Specify false to exclude obsolete requirements.

Example: http://<front-end URL>/servicesExchange?hid=exportRequirements&nodeID=<id>&sid=<webServiceToken>

exportRequirements Web Service Example

The following code uses Apache HttpClient to export requirements.

import org.apache.commons.httpclient.*; // Apache HttpClient

String webServiceToken = "e39a0b5b-45db-42db-84b2-b85028d954d5";

URL service = new URL("http", mWebServiceHelper.getHost(),
  "exportRequirements", webServiceToken,
HttpClient client = new HttpClient();
HttpMethod fileGet = new GetMethod(service.toExternalForm());
int status = client.executeMethod(fileGet);
String exportedRequirementResponse = fileGet.getResponseBodyAsString();

To download Apache HttpComponents, visit http://hc.apache.org/downloads.cgi. Refer to the documentation of the component for the required libraries.