请求地址

http://ip:port/bi/api?action=getSchedules&token=xxxx

请求消息

请求参数

请求参数：xmlData

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

<info>

<user>test2</user>

 <isWork>true</isWork>

 <type>sendemail</type>

 <lastTriggered>2022-01-05 09:30:44</lastTriggered >

 <path>test</path>

 <isFolder>true</isFolder>                        

 <onlyCurrent>false</onlyCurrent>

</info>

参数描述

请求参数为获取调度任务授权用户接口包含的信息：

•user（选填）：获取执行用户为所输入用户用户名的任务列表，填空时获取没有执行用户的任务，不填user参数则不以user过滤，获取所有token用户可见的调度任务。

•isWork（选填）：获取指定状态的任务列表。true为开启的任务，false为停止的任务。

•type（选填）：获取指定类型的任务列表。customtask为自定义任务、exporttask为导出任务、exporttocsv为导出csv文件、exporttodb为导出到数据库、increimport为增量导入数据、indepthanalysis为深度分析实验、sendemail为发送邮件、syncdata为同步数据、multitask为多任务。

•lastTriggered（选填）： 获取任务最后一次触发时间，格式为yyyy-MM-dd HH:mm:ss。

•path（选填）：获取任务的路径。

•isFolder（选填）：如果path是文件夹，则为true；如果path是单个任务，则为false；如果不填或置空默认为false。

•onlyCurrent（选填）：如果path是文件夹，并且只想获取文件夹下的一级目录里的任务，则为true。如果想要获取文件夹下面的所有任务，则为false。默认为false。

示例

function getSchedules() {

 var xml = getXml();

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

    {xmlData : xml},

    function(result) {

    writeXml(result);

 });

}

响应消息

响应结果

•操作成功。

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

<result>

<ref>

<job-path>test/111</job-path>

<isWork>true</isWork>

<type>sendemail</type>

<auth-user>test123</auth-user>

<lastTriggered>2022-01-05 13:30:44</lastTriggered>

<nextTriggered>2022-02-04 00:00:00</nextTriggered>

<runtime>5s</runtime>

<operationResult>success</operationResult>

<reason></reason>

<afterJob>[增量/增量1]</afterJob>

<triggerCondition>2022-03-02 14:08:45[1, 45 8 14 ? * 1]</triggerCondition>

<triggers>(“a”and”b”)or”c”</triggers>

<relatedResources>

<related>

<relatedType>dashboard</relatedType>

<relatedPath>__data_interpretation_file__</relatedPath>

 </related>

</relatedResources>

</ref>

</result >

•操作失败，输入的用户无权查看他人数据。

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

<results>

 <result><level>6</level>

    <message>您没有权限查看其他人的数据</message>

 </result>

</results>

•操作失败，输入的用户不存在。

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

<results>

 <result><level>6</level>

    <message>输入的用户不存在</message>

 </result>

</results>

•操作失败，输入的时间戳格式不合法。

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

<results>

 <result><level>6</level>

    <message>请输入合法的日期时间</message>

 </result>

</results>

•操作失败，输入的路径不存在。

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

<results>

 <result><level>6</level>

    <message>找不到“test”</message>

 </result>

</results>

•操作失败，输入的用户无权查看所输入的路径。

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

<results>

 <result><level>6</level>

    <message>用户无权查看“test”</message>

 </result>

</results>

结果描述

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

•job-path：调度任务的路径。

•isWork：调度任务的状态。与请求参数中的状态对应。

•type：调度任务的类型。与请求参数中的类型对应。

•auth-user：授权用户。

•lastTriggered：任务上次触发时间。

•nextTriggered：自动执行任务的下次触发时间。

•runtime：任务运行时间。

•operationResult：任务运行结果。

•reason：执行任务失败的原因。

•afterJob：后续执行调度任务的路径。

•triggerCondition：触发器设置的时间条件。

•triggers：触发器的名称。

•relatedResources：任务关联的资源。

•relatedResources-related-relatedType：任务关联资源的类型。包括数据集、报告、实验，参考 资源类型。

•relatedResources-related-relatedPath：任务关联资源的路径。

•level 返回类型，不同数值代表不同返回状态，参考附录。

•message为接口操作结果信息。