Cisco Cisco Prime Network Registrar 8.1 Technical References
GetTaskStatus
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide
228
GetTaskStatus
Overview
The
getTaskStatus
API enables the web service client to query the status of tasks.
Request and Response Messages
Below is the portion of
TaskInvocation.wsdl that describes the
getTaskStatus
request
and response messages.
<wsdl:message name="getTaskStatusResponse">
<wsdl:part name="getTaskStatusReturn" type="soapenc:string" />
</wsdl:message>
<wsdl:message name="getTaskStatusRequest">
<wsdl:part name="taskId" type="xsd:int" />
</wsdl:message>
<wsdl:part name="getTaskStatusReturn" type="soapenc:string" />
</wsdl:message>
<wsdl:message name="getTaskStatusRequest">
<wsdl:part name="taskId" type="xsd:int" />
</wsdl:message>
Response
GetTaskStatus
returns the status of the queried task as one of the following strings:
• NOTSTARTED
• QUEUED
• INPROGRESS
• COMPLETE
• COMPLETEWITHERRORS
• ERROR
• QUEUED
• INPROGRESS
• COMPLETE
• COMPLETEWITHERRORS
• ERROR
For more detailed information about the task, use the
getTask
service, described next in
this section.
Request
The input from the client to the web service is described in the next section.
Parameters
Below is the portion of
TaskInvocation.wsdl that describes the parameter structure passed to
getTaskStatus
. The parameter is described below.
<wsdl:operation name="getTaskStatus" parameterOrder="taskId">
<wsdl:input message="impl:getTaskStatusRequest"
name="getTaskStatusRequest" />
<wsdl:output message="impl:getTaskStatusResponse"
name="getTaskStatusResponse" />
</wsdl:operation>
<wsdl:input message="impl:getTaskStatusRequest"
name="getTaskStatusRequest" />
<wsdl:output message="impl:getTaskStatusResponse"
name="getTaskStatusResponse" />
</wsdl:operation>
Part name
Description and accepted values
Required
taskId
The task number to query.
Yes