"ResponseControl" wird im Rückgabedatenobjekt eines API-Aufrufs übergeben.
Wenn der API-Aufruf von einem synchronen Adapter gehandhabt wird, ist dieses Steuerelement eventuell nicht in dem zurückgegebenen Datenobjekt vorhanden. Wenn der Aufruf von einem asynchronen Adapter gehandhabt wird, wird dieses Steuerelement zurückgegeben.
Die Struktur des Datenobjekts "ResponseControl" hat folgende Bestandteile:
- complete
- Ist ein boolesches Merkmal, das
auf "false" gesetzt wird, wenn der Aufruf unvollständig ist.
Nachdem der Aufruf abgeschlossen ist, wird die vollständige Markierung auf "true" gesetzt, und das zurückgegebene Datenobjekt enthält das Ergebnis des Aufrufs.
- ticket
- Ist eine Zeichenfolge, die der Aufrufende nicht interpretieren muss. Bei einem unvollständigen Aufruf enthält das Merkmal "ticket" eine Zeichenfolge "ticket", die in "RequestControl" verwendet werden kann, um den Status des API-Aufrufs zu prüfen.
XML-Schemadefinition
Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "ResponseControl".
<xsd:complexType name="ResponseControl">
<xsd:complexContent>
<xsd:extension base ="Control">
<xsd:attribute name="complete" type="xsd:boolean" default="true"/>
<xsd:attribute name="ticket" type="xsd:string"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Beispieldatenobjekte
Im Folgenden sehen Sie ein Beispiel für das Datenobjekt "ResponseControl". Es wird von einem Aufruf an eine API zurückgegeben, die von einem asynchronen Adapter gehandhabt wird. Das Merkmal "complete" im Datenobjekt gibt an, dass die Operation noch nicht vollstädnig ist, und die Zugriffsberechtigung ("ticket") kann verwendet werden, um den Status des Aufrufs zu verfolgen.
<wim:controls xsi:type="wim:ResponseControl" complete="false"
ticket="AsyncLDAP1:1113940307424:-1278154994"/>
Im Folgenden sehen Sie ein Beispiel für das Datenobjekt "ResponseControl", das zurückgegeben wird, nachdem der asynchrone Aufruf abgeschlossen wurde.
<wim:controls xsi:type="wim:ResponseControl" complete="true"/>
Anmerkung: Wenn der Aufruf von einem synchronen Adapter gehandhabt wird, ist das Datenobjekt "ResponseControl" möglicherweise nicht vorhanden.