=========
 WEB API
=========

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

.. contents:: 内容
   :depth: 2
   :local:
   :backlinks: top

/app/info/
==========

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

返回值

.. code-block:: js

   {
     name: string
     title: string
     rev: integer
   }

/app/cfg/
=========

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

:TODO: 暂未实现

/app/model/
===========

返回工作模型对象

.. code-block:: js

   {
     "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: "开始自动发送考勤邮件"
                }
              ]
            }
          ]
        }
      ]
    }

/usr/listen/
============

- work output/state
- shell output
- app question

/usr/speak/
===========

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