I

「接口」Ex.I.action

• 接口：/api/form/actions（POST）
• 安全：是

{
    "control": "控件ID，对应 UI_FORM 中的 CONTROL_ID",
    "name": "表单名称",
    "op": [],
    "remote": "Boolean，是否读取远程配置，默认无值。"
}

该接口会执行分流操作。

• 远程读取：POST /api/form/actions，尚未开发该接口后端（开发中）。
• 本地读取：（默认）直接读取参数中op来构造合法的Action信息。

「接口」Ex.I.apis

• 接口：/api/x-api/search（POST）
• 安全：是

读取当前系统中所有的接口信息，读取时候自动为系统追加查询条件：

{
    "criteria": {
        "": true
    }
}

根据查询引擎规范该条件追加后，会生成AND操作符来连接所有的params中存在的条件。

「接口」Ex.I.app

• 接口：/app/name/:name（GET）
• 安全：否

此接口一般用于初始化过程，调用Ux.ajaxFetch函数从远程读取应用程序配置，而且这个接口不带安全认证，也无法 读取到appKey这种敏感信息。该函数可传一个Function的异常回调函数，当访问过程中出错时，执行该函数处理异常流程。

参数中的:name参数直接从Ux.Env.APP中读取，该值配置在环境变量中。

「接口」Ex.I.application

• 接口：/api/app（GET）
• 安全：是

带缓存地读取应用程序信息，这个方法会执行校验：

1. 系统调用Ux.isInit()方法读取应用信息，如果应用信息不存在则直接抛出异常。
2. 如果拥有应用信息，并且该应用包含了appKey数据，则直接从缓存中读取数据。
3. 如果没有包含appKey，则只证明执行了第一次初始化，需要再次读取（敏感信息）。

appKey是用来判断首次初始化和二次初始化的核心字段，而且该接口会使用appKey读取应用配置数据。

「接口」Ex.I.attributes

读取单个模型的属性信息

• 接口：/api/model/identifier/:identifier（GET）
• 安全：是

根据模型中的统一标识符identifier读取模型中的属性集

「接口」Ex.I.authorize

• 接口：/oauth/authorize（POST）
• 安全：否

申请临时码专用方法：

{
    "client_id": "客户ID",
    "client_secret": "客户账号颁布的密钥",
    "response_type": "code",
    "scope": "应用的域"
}

内部参数

「接口」Ex.I.category

• 接口：
  • 读唯一：/api/:type/category/:code（GET）
  • 读某一类：/api/type/categories/:type（GET）
  • 读几类：/api/type/categories（POST）
• 安全：是

读取X_CATEGORY专用接口（三义性接口），这个方法会分三种方式读取，根据参数判断。

内部参数

「接口」Ex.I.company

• 接口：/api/company/employee/:eid（GET）
• 安全：是

根据用户数据中存储的员工主键employeeId读取员工所属公司信息，如果未登录则读取的数据为空。

「接口」Ex.I.control

• 接口：/api/ui/control（POST）
• 安全：是

{
    "type": "两种类型",
    "control": "控件ID"
}

读取控件配置UI_CONTROL相关数据。

内部参数

• type = FORM，读取表单配置数据。
• type = LIST，读取列表配置数据。

「接口」Ex.I.forest

• 接口:
  • 读取某一类：/api/type/categories/:type（GET）
  • 判断节点

节点主要包含两种：

• 整棵树：tree =
• 树中某个分支：tree = xxx,

连接模式

1. mode = "REPLACE": 抓取的树直接替换当前节点
2. mode = "CONNECT": 抓取的树作为当前节点的子节点

「接口」Ex.I.form

• 接口：/api/ui/form/:code（GET）
• 安全：是

读取表单专用配置接口，根据表单的code读取表单配置信息。

「接口」Ex.I.forms

• 接口：/api/ui/forms/:identifier（GET）
• 安全：是

读取模型下的表单配置信息，这个接口读取和identifier模型相关的所有表单配置信息。

「接口」Ex.I.inited

• 接口
  • 应用接口：/api/app（GET）
  • 菜单数据：/api/menus（GET）
• 安全：是

该接口为登录过后的主页调用的专用初始化接口，主要执行两个操作：

1. 执行 X_APP 的全配置信息（包括敏感信息，appKey）。
2. 执行 X_MENU 的全配置信息（只读取当前菜单）。

「接口」Ex.I.jobResume

• 接口：/api/job/resume/:key（PUT）
• 安全：是

恢复任务专用接口，I_JOB特定应用。

「接口」Ex.I.jobs

• 接口：/api/job/info/by/sigma（GET）
• 安全：是

读取当前系统中所有的任务信息（按sigma分类）。

「接口」Ex.I.jobStart

• 接口：/api/job/start/:key（PUT）
• 安全：是

启动任务专用接口

「接口」Ex.I.jobStop

• 接口：/api/job/stop/:key（PUT）
• 安全：是

停止任务专用接口

「接口」Ex.I.lists

• 接口：/api/ui/lists/:identifier（GET）
• 安全：是

读取模型下的所有列表配置信息

「接口」Ex.I.login

• 接口：/oauth/login（POST）
• 安全：否

登录入口专用，请求数据如：

{
    "username": "登录账号",
    "password": "MD5加密过后的密码"
}

「接口」Ex.I.logout

• 接口：/api/user/logout（POST）
• 安全：是

注销登出专用接口

「接口」Ex.I.menus

• 接口：/api/menus（GET）
• 安全：是

登录过后根据Ux.isInit()的应用信息返回当前应用的所有菜单数据，应用数据存储在 X_APP表中，包含X_SOURCE的数据源信息，菜单数据存储在X_MENU表中。

「接口」Ex.I.mission

• 接口：/api/job/info/mission/:key（GET）
• 安全：是

读取 Mission 相关的 Job任务配置。

「接口」Ex.I.module

• 接口：/api/module?entry={entry}（GET）
• 安全：是

根据当前路由路径读取X_MODULE中的模块配置信息，该模块的配置信息和Cab.json中绑定 的资源文件合并生成当前模块的所有配置信息。

「接口」Ex.I.ops

• 接口：/api/ui/ops（POST）
• 安全：是

读取操作专用配置UI_OP，入参为：

{
    "control": "控件ID",
    "identifier": "模型标识符",
    "type": "OP"
}

内部参数

「接口」Ex.I.page

• 接口：/api/ui/page（POST）
• 安全：是

1. 先读取UI_PAGE中的页面配置信息。
2. 然后读取UI_LAYOUT中的模板配置信息。
3. 最后根据pageId读取UI_CONTROL中的控件配置信息。

「接口」Ex.I.password

• 接口：/api/user/password（POST）
• 安全：是

更新用户登录密码专用接口

「接口」Ex.I.profile

• 接口：/api/user/profile（POST）
• 安全：是

更新登录用户的Profile详细信息。

「接口」Ex.I.relation

• 接口：/api/relation（GET）
• 安全：是

读取关系定义专用接口

「接口」Ex.I.relationDelete

• 接口：/api/ox/relation/remove（POST）
• 安全：是

删除关系专用接口

「接口」Ex.I.relationSave

• 接口：/api/ox/relation/save（POST）
• 安全：是

存储关系专用

「接口」Ex.I.tabular

• 接口：
  • 读唯一：/api/:type/tabular/:code（GET）
  • 读某一类：/api/type/tabulars/:type（GET）
  • 读几类：/api/type/tabulars（POST）
• 安全：是

读取X_TABULAR专用接口（三义性接口），这个方法分三种方式读取，根据参数判断。

内部参数

「接口」Ex.I.token

• 接口：
  • 确认：/api/todo/confirm/:key（PUT）
  • 拒绝：/api/todo/reject/:key（PUT）
• 安全：是

Todo待办的确认和拒绝专用接口。

「接口」Ex.I.token

• 接口：/oauth/token（POST）
• 安全：否

请求格式

{
    "client_id": "客户ID",
    "code": "临时验证码"
}

使用临时授权码交换令牌专用方法。

「接口」Ex.I.uri

• 接口：/api/x-api/:key（GET）
• 安全：是

读取具体 uri 配置。

「接口」Ex.I.user

• 接口：/api/user（GET）
• 安全：是

读取当前登录用户的基本信息。

「接口」Ex.I.visitor

• 接口：/ui/visitor/:identifier/:page（POST）
• 安全：是

{
    "identifier": "路径参数，模型标识符",
    "page": "页面ID",
    "view": "「位置1」视图信息",
    "position": "「位置2」位置信息",
    "type": "类型选择，FORM / LIST",
    "alias": "「位置3」别名信息"
}

位置信息计算规则：view / position / alias

• view：视图信息，直接从 $myView 中提取。
• position：位置信息，直接从 $myView 中提取。
• alias：别名处理，同样用来计算 alias。

内部参数