Express (Distributed operating systems), v8.0 > Secure applications and their environment > Authenticate users > Select a registry or repository > Manage realms in a federated repository > Virtual member manager > Reference > Program model > Control DataObject
ResponseControl DataObject
ResponseControl is returned in the return data object of an API call.
If the API call is handled by a synchronous adapter then this control might not be present in the returned data object. If the call is handled by an asynchronous adapter then this control is returned.
The structure of a ResponseControl data object consists of:
complete
is a boolean property that is set to false if the call is incomplete. After the call is completed, the complete flag is set to true and the returned data object contains the result of the call.
ticket
is a string that the caller is not required to interpret. For an incomplete call, the ticket property contains a ticket string that can be used in the RequestControl to check the status of the API call.
XML schema definition
The following is the XML schema definition for the ResponseControl DataObject.
<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>
Sample data objects
The following is a sample ResponseControl data object. It is returned by a call to an API that is handled by an asynchronous adapter. The complete property in the data object indicates that the operation is not complete yet and the ticket can be used to track the status of the call.
<wim:controls xsi:type="wim:ResponseControl" complete="false" ticket="AsyncLDAP1:1113940307424:-1278154994"/>The following is a sample ResponseControl data object that is returned after the asynchronous call is complete.
<wim:controls xsi:type="wim:ResponseControl" complete="true"/>If the call is handled by synchronous adapter, the ResponseControl might not be present.
Parent topic: Control DataObject