complexType PurgeStatus

diagram |
namespace | http://base.api.ec.n2.tibco.com
children | statusMessage start end details currentInstanceCount totalInstanceCount purgeOperationName status
used by |
elements | PurgeStatus doPurgeAuditResponseObject/status stopPurgeAuditResponseObject/status checkPurgeAuditResponseObject/status
annotation |
documentation
The status of a purge operation
source | <xs:complexType name="PurgeStatus"> <xs:annotation> <xs:documentation>The status of a purge operation</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="statusMessage" type="xs:string" minOccurs="1" maxOccurs="1"> <xs:annotation> <xs:documentation>A message indicating further information on the last purge operation</xs:documentation> </xs:annotation> </xs:element> <xs:element name="start" type="xs:dateTime" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The time the purge operation started</xs:documentation> </xs:annotation> </xs:element> <xs:element name="end" type="xs:dateTime" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The time the purge operation ended</xs:documentation> </xs:annotation> </xs:element> <xs:element name="details" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Any additional details for this purge</xs:documentation> </xs:annotation> </xs:element> <xs:element name="currentInstanceCount" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The current number of instances purged</xs:documentation> </xs:annotation> </xs:element> <xs:element name="totalInstanceCount" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The total number of instances matched for this purge</xs:documentation> </xs:annotation> </xs:element> <xs:element name="purgeOperationName" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The name of the purge operation being referred to</xs:documentation> </xs:annotation> </xs:element> <xs:element name="status" type="PurgeStatusType" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType>

element PurgeStatus/statusMessage

diagram |
type | xs:string
properties |
content | simple
annotation |
documentation
A message indicating further information on the last purge operation
source | <xs:element name="statusMessage" type="xs:string" minOccurs="1" maxOccurs="1"> <xs:annotation> <xs:documentation>A message indicating further information on the last purge operation</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/start

diagram |
type | xs:dateTime
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
The time the purge operation started
source | <xs:element name="start" type="xs:dateTime" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The time the purge operation started</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/end

diagram |
type | xs:dateTime
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
The time the purge operation ended
source | <xs:element name="end" type="xs:dateTime" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The time the purge operation ended</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/details

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Any additional details for this purge
source | <xs:element name="details" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Any additional details for this purge</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/currentInstanceCount

diagram |
type | xs:long
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
The current number of instances purged
source | <xs:element name="currentInstanceCount" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The current number of instances purged</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/totalInstanceCount

diagram |
type | xs:long
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
The total number of instances matched for this purge
source | <xs:element name="totalInstanceCount" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The total number of instances matched for this purge</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/purgeOperationName

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
The name of the purge operation being referred to
source | <xs:element name="purgeOperationName" type="xs:string" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The name of the purge operation being referred to</xs:documentation> </xs:annotation> </xs:element>

element PurgeStatus/status

diagram |
type | PurgeStatusType
properties |
content | simple
facets |
Kind | Value | Annotation
enumeration | PURGE_IN_PROGRESS |
documentation
A purge action is currently being executed
enumeration | PURGE_COMPLETED |
documentation
The last purge operation completed successfully
enumeration | PURGE_STOPPED |
documentation
The last purge operation was stopped manually
enumeration | PURGE_FAILED |
documentation
The last purge operation failed.
source | <xs:element name="status" type="PurgeStatusType" minOccurs="1" maxOccurs="1"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy