Wiki
suspend Job

The Client may request that any currently active, not yet completed job be temporarily suspended by calling this method.

Note: This is a request only as the service cannot guarantee to comply with this immediately. There may still be a cost incurred.

A suspended job can be cancelled (by calling cancelJob) or resumed at a later stage (by calling resumeJob.

suspendJob will fail if the job status is complete.

An entry with the following information will be added to the history returned from retrieveJobInformation:

   <event stage="job" status="suspended" timeStamp="2005-01-01T12:00:00.000Z"/>

Passed In

Returned

Schema

Request

<xsd:element name="suspendJobRequest">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:ticket"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

Response

<xsd:element name="suspendJobResponse">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:ticket"/>
      <xsd:element ref="types:succeeded"/>
      <xsd:element ref="types:info"/>
    </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>
    <suspendJobRequest xmlns="urn:oasis:names:tc:wstrans:v1:types">
      <ticket jobId="job-001" projectId="proj-002" userId="user-003"/>
    </suspendJobRequest>
  </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>
    <suspendJobResponse xmlns="urn:oasis:names:tc:wstrans:v1:types">
      <ticket jobId="job-001" projectId="proj-002" userId="user-003"/>
      <succeeded>0</succeeded>
      <info>Suspension not allowed at this time</info>
    </suspendJobResponse>
  </soapenv:Body>
</soapenv:Envelope>