MainService


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

GetRequirement

Retrieves a requirement and all of its data. This includes all of the requirement's fields and also the description of the requirement.

The description is retrieved in one of the following formats: Html, RtfWithImages or RtfWithoutImages. In the formats Html and RtfWithoutImages all images are removed from the text and substituted by special markers of the form AQUAID...AQUAID with a number between the markers. The number is an aqua ID for which you can find the corresponding ScreenShotInfo data in the ScreenShots collection of the requirement. The image data for the ScreenShotInfo can be retrieved using the method GetScreenShots. In the RtfWithoutImages format the AQUAID...AQUAID markers should be simply replaced by the image data. If you are working with the Html format you should replace the AQUAID...AQUAID markers with an img tag and save the picture data to a file.

The content of dictionary fields (like the TargetVersion) is an integer value. This integer value can be mapped to a human-readable string by evaluating the results of the GetProjectInfo and specifically its RequirementTemplate field.

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/GetRequirement"

<?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>
    <GetRequirement xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_requirementId>int</_requirementId>
      <_format>Html or HtmlWithEmbeddedImages or RtfWithoutImages or RtfWithImages or PlainText</_format>
    </GetRequirement>
  </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>
    <GetRequirementResponse xmlns="http://aqua-api.andagon.com/">
      <GetRequirementResult>
        <RequirementsTree>
          <RequirementsTreeElement>
            <Id>int</Id>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ChildPosition>int</ChildPosition>
          </RequirementsTreeElement>
          <RequirementsTreeElement>
            <Id>int</Id>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ChildPosition>int</ChildPosition>
          </RequirementsTreeElement>
        </RequirementsTree>
        <ChildPosition>int</ChildPosition>
        <ImplementedAt>dateTime</ImplementedAt>
        <ImplementedIn>string</ImplementedIn>
        <ParentId>int</ParentId>
        <UmlDiagrams>string</UmlDiagrams>
        <ValidFor>string</ValidFor>
        <Usage>int</Usage>
      </GetRequirementResult>
    </GetRequirementResponse>
  </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>
    <GetRequirement xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_requirementId>int</_requirementId>
      <_format>Html or HtmlWithEmbeddedImages or RtfWithoutImages or RtfWithImages or PlainText</_format>
    </GetRequirement>
  </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>
    <GetRequirementResponse xmlns="http://aqua-api.andagon.com/">
      <GetRequirementResult>
        <RequirementsTree>
          <RequirementsTreeElement>
            <Id>int</Id>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ChildPosition>int</ChildPosition>
          </RequirementsTreeElement>
          <RequirementsTreeElement>
            <Id>int</Id>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ChildPosition>int</ChildPosition>
          </RequirementsTreeElement>
        </RequirementsTree>
        <ChildPosition>int</ChildPosition>
        <ImplementedAt>dateTime</ImplementedAt>
        <ImplementedIn>string</ImplementedIn>
        <ParentId>int</ParentId>
        <UmlDiagrams>string</UmlDiagrams>
        <ValidFor>string</ValidFor>
        <Usage>int</Usage>
      </GetRequirementResult>
    </GetRequirementResponse>
  </soap12:Body>
</soap12:Envelope>