Cisco Cisco Prime Network Registrar 8.1 Technical References

Page of 316
GetTask 
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide 
     227 
GetTask 
Overview 
The 
getTask
 API enables the web service client to query the status of tasks and receive 
detailed information about those tasks. 
Request and Response Messages 
Below is the portion of 
TaskInvocation.wsdl that describes the 
getTask
 request and 
response messages. 
<wsdl:message name="getTaskRequest"> 
  <wsdl:part name="taskId" type="xsd:int" />  
</wsdl:message> 
<wsdl:message name="getTaskResponse"> 
  <wsdl:part name="getTaskReturn"  
             type="impl:ArrayOf_soapenc_string" />  
</wsdl:message> 
Response 
GetTask
 will return the status of the queried task as a string array with the following 
information: 
Element 
Description  
Task ID 
Service 
Scope 
Status 
Process start time 
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 
getTask
 . The parameter is described in the table that follows. 
<wsdl:operation name="getTask" parameterOrder="taskId"> 
  <wsdl:input message="impl:getTaskRequest" name="getTaskRequest" />  
  <wsdl:output message="impl:getTaskResponse" name="getTaskResponse"/>  
</wsdl:operation> 
Parameter name 
Description and accepted values 
Required 
taskId 
The task number to query. 
Yes