This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

DeleteInstance function

Deletes an instance of a class.

WSDL operation

<operation name="DeleteInstance" parameterOrder="inargs">
	<input message="tns:DeleteInstanceRequest"
		name="DeleteInstanceRequest"/>
	<output message="tns:DeleteInstanceResponse"
		name="DeleteInstanceResponse"/>
	<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

WSDL messages

<message name="DeleteInstanceRequest">
	<part element="types:DeleteInstance" name="inargs"/>
</message>
<message name="DeleteInstanceResponse">
	<part element="common:StatusOutput" name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="DeleteInstance">
	<complexType>
		<sequence>
			<element name="lang" type="string"/>
			<element name="datasetId" type="string"/>
			<element name="instanceInfo" 
				type="common:DeleteInstanceInfoIn" />
			<element name="deleteOption"
				type="common:InstanceDeleteOption"/>
			<element name="extensions" type="common:ExtensionsList" 
				nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="StatusOutput">
	<complexType>
		<sequence>
			<element name="status" type="impl:StatusList"/>
		</sequence>
	</complexType>
</element>
<element name="AtriumFault">
	<complexType>
		<choice>
			<element name="serviceFault"
				type="tns:AtriumServiceFault" />
			<element name="backendFault"
				type="tns:AtriumBackendFault" />
		</choice>
	</complexType>
</element>

Input arguments

lang

The language of the product specific to the locale. If no language is specified, the default language is used.

datasetId

The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in this parameter.

instanceInfo

A list of instances. See InstanceDeleteOption.

deleteOption

Specifies the action to take if the specified class contains attributes or subclasses.DERIVED_INSTANCE_FOUND --Deletes only the specified instance, if the instance is retrieved. UNCONDITIONALLY --Deletes the instance even when the instance cannot be retrieved. Errors are ignored for instances that do not exist.

extensions

A list of extension types for the operation.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call of this operation.

Fault message

Fault message

See Fault message.

Was this page helpful? Yes No Submitting... Thank you

Comments