MainService


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

SaveRequirement

Saves changes to an existing requirement or creates a new one.

If the Id of the provided requirement is 0, then a new requirement will be created. Otherwise the existing requirement is updated. Updating the requirement is subject to permission checks, a PermissionException will be generated in case the logged in user does not have the right permissions to access the requirement.

Parameter '_saveRichText' denotes whether rich text fields (e.g. description, rich text custom fields) should be considered during save.If true, then '_format' parameter specifies format in which text are being saved (html, rtf, plain-text). Text are converted to RTF represenation automatically. If '_saveRichText' is false, then existing fields remain unchanged.

The following properties of the Requirement object are not supported when saving: AttachedFiles, AttachedLinks, MindMaps, Parent.

The method returns the Requirement in its state after it has been saved.

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

<?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>
    <SaveRequirement xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_req>
        <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>
      </_req>
      <_format>Html or HtmlWithEmbeddedImages or RtfWithoutImages or RtfWithImages or PlainText</_format>
      <_saveDescription>boolean</_saveDescription>
    </SaveRequirement>
  </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>
    <SaveRequirementResponse xmlns="http://aqua-api.andagon.com/">
      <SaveRequirementResult>
        <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>
      </SaveRequirementResult>
    </SaveRequirementResponse>
  </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>
    <SaveRequirement xmlns="http://aqua-api.andagon.com/">
      <_session>string</_session>
      <_req>
        <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>
      </_req>
      <_format>Html or HtmlWithEmbeddedImages or RtfWithoutImages or RtfWithImages or PlainText</_format>
      <_saveDescription>boolean</_saveDescription>
    </SaveRequirement>
  </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>
    <SaveRequirementResponse xmlns="http://aqua-api.andagon.com/">
      <SaveRequirementResult>
        <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>
      </SaveRequirementResult>
    </SaveRequirementResponse>
  </soap12:Body>
</soap12:Envelope>