MainService


Klicken Sie hier, um die vollständige Vorgangsliste anzuzeigen.

GetRequirements

Retrieves a list of requirements in a specific project and folder. The folder provided can be 0 - in this case requirements in the root of the project are retrieved. Turning the option recursive on causes the method to return all the requirements in the specified folder and folders beneath it in the hierarchy.

The ID of a user view filters for a limited set of requirements and must be always provided. You can find all user views with their names by invoking the GetProjectInfo method.

Note that the requirements returned here do not contain the description field - it is always empty. You need to retrieve a specific requirement using GetRequirement to obtain its full description.

Test

Das Testformular ist nur für Anforderungen vom lokalen Computer verfügbar.

SOAP 1.1

Es folgt ein Beispiel für eine SOAP 1.1-Anforderung und -Antwort. Die angezeigten Platzhalter müssen durch tatsächliche Werte ersetzt werden.

POST /aquaAPI/mainservice.asmx HTTP/1.1
Host: aqua-demo2.andagon.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://aqua-api.andagon.com/GetRequirements"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRequirements xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_projectId>int</_projectId>
      <_folderId>int</_folderId>
      <_recursive>boolean</_recursive>
      <_userViewId>int</_userViewId>
    </GetRequirements>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRequirementsResponse xmlns="http://aqua-api.andagon.com/">
      <GetRequirementsResult>
        <Requirement>
          <RequirementsTree>
            <RequirementsTreeElement xsi:nil="true" />
            <RequirementsTreeElement xsi:nil="true" />
          </RequirementsTree>
          <ChildPosition>int</ChildPosition>
          <ImplementedAt>dateTime</ImplementedAt>
          <ImplementedIn>string</ImplementedIn>
          <ParentId>int</ParentId>
          <UmlDiagrams>string</UmlDiagrams>
          <ValidFor>string</ValidFor>
          <Usage>int</Usage>
        </Requirement>
        <Requirement>
          <RequirementsTree>
            <RequirementsTreeElement xsi:nil="true" />
            <RequirementsTreeElement xsi:nil="true" />
          </RequirementsTree>
          <ChildPosition>int</ChildPosition>
          <ImplementedAt>dateTime</ImplementedAt>
          <ImplementedIn>string</ImplementedIn>
          <ParentId>int</ParentId>
          <UmlDiagrams>string</UmlDiagrams>
          <ValidFor>string</ValidFor>
          <Usage>int</Usage>
        </Requirement>
      </GetRequirementsResult>
    </GetRequirementsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

Es folgt ein Beispiel für eine SOAP 1.2-Anforderung und -Antwort. Die angezeigten Platzhalter müssen durch tatsächliche Werte ersetzt werden.

POST /aquaAPI/mainservice.asmx HTTP/1.1
Host: aqua-demo2.andagon.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRequirements xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_projectId>int</_projectId>
      <_folderId>int</_folderId>
      <_recursive>boolean</_recursive>
      <_userViewId>int</_userViewId>
    </GetRequirements>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRequirementsResponse xmlns="http://aqua-api.andagon.com/">
      <GetRequirementsResult>
        <Requirement>
          <RequirementsTree>
            <RequirementsTreeElement xsi:nil="true" />
            <RequirementsTreeElement xsi:nil="true" />
          </RequirementsTree>
          <ChildPosition>int</ChildPosition>
          <ImplementedAt>dateTime</ImplementedAt>
          <ImplementedIn>string</ImplementedIn>
          <ParentId>int</ParentId>
          <UmlDiagrams>string</UmlDiagrams>
          <ValidFor>string</ValidFor>
          <Usage>int</Usage>
        </Requirement>
        <Requirement>
          <RequirementsTree>
            <RequirementsTreeElement xsi:nil="true" />
            <RequirementsTreeElement xsi:nil="true" />
          </RequirementsTree>
          <ChildPosition>int</ChildPosition>
          <ImplementedAt>dateTime</ImplementedAt>
          <ImplementedIn>string</ImplementedIn>
          <ParentId>int</ParentId>
          <UmlDiagrams>string</UmlDiagrams>
          <ValidFor>string</ValidFor>
          <Usage>int</Usage>
        </Requirement>
      </GetRequirementsResult>
    </GetRequirementsResponse>
  </soap12:Body>
</soap12:Envelope>