2. WEB API

本文档定义了后台服务提供的 WEB API 接口,全部接口使用 POST 方式提交,并返回 JSON 数据

2.1. /app/info/

用于启动时候查询应用信息

返回值

{
  name: string
  title: string
  rev: integer
}

2.2. /app/cfg/

用于启动时候查询所有的配置项

TODO:暂未实现

2.3. /app/model/

返回工作模型对象

{
  "cid": "EkWork",
  "name": "userwork-1",
  "title": "用户工作 1"

  "inputs": [
    {
      "cid": "EkSceneData",
      "name": "工作文件 1",
      "source": "file",
      "samples": ["这是考勤文件"]
    },
    {
      "cid": "EkSceneText",
      "name": "工作数据 1",
      "source": "input",
      "samples": ["简单报告", "详细报告"]
    }
  ],

  "steps": [
    {
      "cid": "EkStep",
      "name": "第一步",
      "changes": [
        {
          "cid": "EkChange",
          "subject": {
              "cid": "EkRefer",
              "refer": "inputs[1]",
           },
           verb: "echo",
           "objects": [
             {
               cid: "EkSceneText",
               value: "开始自动发送考勤邮件"
             }
           ]
         }
       ]
     },
     {
      "cid": "EkLoop",
      "name": "第二步",
      "changes": [
        {
          "cid": "EkChange",
          "subject": {
              "cid": "EkRefer",
              "refer": "inputs[1]",
           },
           verb: "echo",
           "objects": [
             {
               cid: "EkSceneText",
               value: "开始自动发送考勤邮件"
             }
           ]
         }
       ]
     }
   ]
 }

2.4. /usr/listen/

  • work output/state
  • shell output
  • app question

2.5. /usr/speak/

  • start work
  • start shell
  • answer text/number/choice
  • pause/continue/cancel work
  • kill shell