Cisco Cisco Prime Network Registrar 8.1 Technical References
DeleteTaskById
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide
292
DeleteTaskById
Overview
The
DeleteTaskByID
API enables the web service client to delete one or more tasks
from Cisco Prime Network Registrar IPAM.
Request and Response Messages
The portion of
Deletes.wsdl that describes the
DeleteTaskById
request and response
messages is shown following.
<wsdl:operation name="deleteTaskById" parameterOrder="ids">
<wsdl:input message="impl:deleteTaskByIdRequest"
name="deleteTaskByIdRequest"/>
<wsdl:output message="impl:deleteTaskByIdResponse"
name="deleteTaskByIdResponse"/>
</wsdl:operation>
<wsdl:message name="deleteTaskByIdRequest">
<wsdl:part name="ids" type="impl:ArrayOf_soapenc_int"/>
</wsdl:message>
<wsdl:message name="deleteTaskByIdResponse">
<wsdl:part name="deleteTaskByIdReturn" type="xsd:int"/>
</wsdl:message>
<wsdl:input message="impl:deleteTaskByIdRequest"
name="deleteTaskByIdRequest"/>
<wsdl:output message="impl:deleteTaskByIdResponse"
name="deleteTaskByIdResponse"/>
</wsdl:operation>
<wsdl:message name="deleteTaskByIdRequest">
<wsdl:part name="ids" type="impl:ArrayOf_soapenc_int"/>
</wsdl:message>
<wsdl:message name="deleteTaskByIdResponse">
<wsdl:part name="deleteTaskByIdReturn" type="xsd:int"/>
</wsdl:message>
Response
The count of tasks deleted is returned.
Request
The request takes one parameter, which is an array of integers. Each integer is a Task ID.
Parameters
Element
Accepted Values
Required
Return
Code
Code
Faultstring
ids
The Task IDs to delete, one per
element in the array.
Yes
-106
-108
Task Not found
Missing IDs