Wiki
retrieve Active Jobs List

This call allows the client to retrieve a list of their currently active jobs. This can used together with retrieveJobInformation to get the current status for the active jobs.

Passed In

Returned

Schema

Request

<xsd:element name="retrieveActiveJobsListRequest">
  <xsd:complexType>
    <xsd:sequence/>
  </xsd:complexType>
</xsd:element>

Response

<xsd:element name="retrieveActiveJobListResponse">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="0" ref="types:ticket"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

Sample Message

Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <retrieveActiveJobsListRequest xmlns="urn:oasis:names:tc:wstrans:v1:types"/>
  </soapenv:Body>
</soapenv:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <retrieveActiveJobsListResponse xmlns="urn:oasis:names:tc:wstrans:v1:types">
      <ticket jobId="job-001" projectId="project-001" userId="user-001"/>
      <ticket jobId="job-002" projectId="project-002" userId="user-002"/>
      <ticket jobId="job-003" projectId="project-003" userId="user-003"/>
    </retrieveActiveJobsListResponse>
  </soapenv:Body>
</soapenv:Envelope>

See also: retrieveFullJobsList