searchJobs
Returns the jobs that have the specified parameters.
Applies to Clouds and Integration Appliances.
Parameters:
- projectName
- The name of the project that contains the configuration where the jobs run.
- version
- The version number of the project.
- configName
- The name of the configuration that contains the orchestration where the jobs run.
- orchName
- The name of the orchestration where the jobs run.
- jobId
- The ID of the jobs to be returned.
- jobKey
- The job key for the jobs to be returned.
- minStartDate
- The earliest date that the jobs started.
- maxStartDate
- The latest date that the jobs started.
- status
- The status of the jobs.
- page
- 0-based page numbering.
- pageSize
- The number of lines per page.
- Returns:
- The jobs that have the specified parameters.
Examples:
The following code is an example
of a SOAP request to search jobs.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:orc="http://www.approuter.com/schemas/2008/1/orcmon">
<soapenv:Header>
<orc:sessionId>834133D57E9259C94D44E53A5F6B43C2</orc:sessionId>
</soapenv:Header>
<soapenv:Body>
<orc:searchJobs>
<orc:projectName>CloudProvideProject_2</orc:projectName>
<orc:version>1.0</orc:version>
<orc:configName>Default</orc:configName>
<orc:orchName>ProvideOnCloud</orc:orchName>
<orc:jobId></orc:jobId>
<orc:jobKey></orc:jobKey>
<orc:minStartDate></orc:minStartDate>
<orc:maxStartDate></orc:maxStartDate>
<orc:status>errored</orc:status>
<orc:page>0</orc:page>
<orc:pageSize>1</orc:pageSize>
</orc:searchJobs>
</soapenv:Body>
</soapenv:Envelope
The following example is the
SOAP response to the request.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:searchJobsResponse xmlns:ns2="http://www.approuter.com/
schemas/2005/1/monitoringProps/" xmlns:ns3="http://www.approuter.com/
schemas/2008/1/orcmon" xmlns:ns4="http://www.approuter.com/schemas/2004/1/
orcmon/" xmlns:ns5="http://www.approuter.com/schema/router/1000/logging.xsd"
xmlns:ns6="http://www.approuter.com/schemas/2004/1/orcmon">
<ns3:jobs status="1" startTime="2010-04-15T10:40:02.665Z"
path="CloudProvideProject_2/1.0/Default/Orchestrations/ProvideOnCloud"
id="ADCF71CCD81139F8CF16F815998B4B73" endTime="2010-04-15T10:40:38.066Z">
<ns6:event seqNum="0">
<ns6:eventType>
<ns4:taskStartLoggedEvent>
<ns4:taskId>ADCF71CCD81139F8CF16F815998B4B73</ns4:taskId>
<ns4:sequenceNumber>0</ns4:sequenceNumber>
<ns4:time>2010-04-15T10:40:02.665Z</ns4:time>
</ns4:taskStartLoggedEvent>
</ns6:eventType>
</ns6:event>
<ns6:event seqNum="1">
<ns6:eventType>
<ns4:setStatusLoggedEvent>
<ns4:taskId>ADCF71CCD81139F8CF16F815998B4B73</ns4:taskId>
<ns4:sequenceNumber>1</ns4:sequenceNumber>
<ns4:status>2</ns4:status>
</ns4:setStatusLoggedEvent>
</ns6:eventType>
</ns6:event>
</S:Body>
</S:Envelope>