1.31运行作业

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > WebAPI 

1.31运行作业

复制链接

请求地址

http://ip:port/bi/api?action=runJobs&token=xxxxx

请求消息

请求参数

请求参数:xmlData(必填)

<?xml version="1.0" encoding="UTF-8"?>

<info>                        

 <path>test</path>  

<isFolder>true</isFolder>                        

<onlyCurrent>false</onlyCurrent>                      

<isWait>true</isWait>                      

 <params>                        

 <param name="Short" type="int">1</param>                        

</params>                        

</info>        

参数描述

path(必填):作业的路径。如果不填或者无此参数且isFolder为true则视作运行根目录的作业。

isFolder(选填):如果path是文件夹,则为true。如果是单个的job,则为false。默认为false,isFolder等价于旧版本中的isForder,新版本中两者任选其一,10.0及以后的版本建议使用isFolder。

onlyCurrent(选填):如果path是文件夹,并且只想运行文件夹下的一级目录里的job,则为true。如果想要运行文件夹下面的所有的job,则为false。onlyCurrent等价于旧版本中的isOnlyJob,新版本中两者任选其一,10.0及以后的版本建议使用onlyCurrent。

isWait(选填):是否等待任务运行完成,为true时会等待任务运行完成后,返回任务已完成个数,为false则不等待直接返回任务已启动个数。

param(选填):需要带两个属性,一个是name,一个是type。type的取值有:string、boolean、float、double、char、byte、short、int、long、time、dateTime。

示例

function runJobs () {

 var xml = getXml();

 $.post("http://" + ip + ":" + port + "/" + project + "/api?action= runJobs&token=xxxx",

  {xmlData : xml},

  function(result) {        

      writeXml(result);

  });

}

响应消息

响应结果

isWait:true

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

      <level>1</level>

      <message>任务已完成'1'个。</message>

  </result>

</results>

isWait:false

<?xml version="1.0" encoding="UTF-8"?>

<results>

 <result>

     <level>1</level>

     <message>任务已启动'1'个。</message>

 </result>

</results>

结果描述

响应结果信息为xml,直接parse即可。

level 返回类型,不同数值代表不同返回状态,见附录

message为接口操作结果信息。