fxapi-app-management

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

应用管理技能

Application Management Skill

fx-api-cli
是提供的命令行程序，所有操作通过执行
fx-api-cli
命令完成。

通过

fx-api-cli app <接口名> '<json入参>'

与应用管理系统交互。

fx-api-cli
is the provided command line program, and all operations are completed by executing the
fx-api-cli
command.

Interact with the application management system via

fx-api-cli app <interface name> '<json input parameters>'

接口列表

Interface List

app.list — 用户应用查询接口

app.list — User Application Query Interface

bash

fx-api-cli app list '{"skip": 0, "limit": 10}'

仅获取 API Key 当中应用授权范围内的应用信息。支持分页查询。参见 API 详情。

bash

fx-api-cli app list '{"skip": 0, "limit": 10}'

Only obtain application information within the application authorization scope of the API Key. Pagination query is supported. See API Details.

app.entry.list — 用户表单查询接口

app.entry.list — User Form Query Interface

bash

fx-api-cli app entry_list '{"app_id": "5e0dca0cc9a2790006c11e02"}'

获取当前应用下所有表单信息。需要指定应用 ID。参见 API 详情。

bash

fx-api-cli app entry_list '{"app_id": "5e0dca0cc9a2790006c11e02"}'

Get all form information under the current application. Application ID is required. See API Details.

app.entry.widget_list — 表单字段查询接口

app.entry.widget_list — Form Field Query Interface

bash

fx-api-cli app widget_list '{"app_id": "59264073a2a60c0c08e20bfb", "entry_id": "59264073a2a60c0c08e20bfd"}'

获取指定表单的字段/字段信息，除分割线字段和关联查询字段以外。需要指定应用 ID 和表单 ID。参见 API 详情。

bash

fx-api-cli app widget_list '{"app_id": "59264073a2a60c0c08e20bfb", "entry_id": "59264073a2a60c0c08e20bfd"}'

Get the field information of the specified form, excluding separator fields and associated query fields. Application ID and form ID are required. See API Details.

核心规则

Core Rules

分页规则

Pagination Rules

默认值：用户未指定时，默认 skip=0，limit=10
限制：limit 最大不超过 100

Default value: If not specified by the user, the default is skip=0, limit=10
Limit: The maximum value of limit cannot exceed 100

应用 ID 查找规则

Application ID Search Rules

当用户提供应用名称而非 ID 时：
1. 调用
```
app.list
```
  获取应用列表
2. 在
```
apps
```
  中按
```
name
```
  匹配
3. 匹配策略：
  - 精确匹配唯一结果：直接使用
  - 模糊匹配多个结果：展示候选列表让用户选择
  - 无匹配结果：告知用户未找到

When the user provides the application name instead of the ID:
1. Call
```
app.list
```
  to get the application list
2. Match by
```
name
```
  in
```
apps
```
3. Matching strategy:
  - Exact match with unique result: use directly
  - Fuzzy match with multiple results: display the candidate list for users to choose
  - No matching result: inform the user that no result is found

表单 ID 查找规则

Form ID Search Rules

当用户提供表单名称而非 ID 时：
1. 调用
```
app.entry.list
```
  获取表单列表（需要先确定应用 ID）
2. 在
```
forms
```
  中按
```
name
```
  匹配
3. 匹配策略：
  - 精确匹配唯一结果：直接使用
  - 模糊匹配多个结果：展示候选列表让用户选择
  - 无匹配结果：告知用户未找到

When the user provides the form name instead of the ID:
1. Call
```
app.entry.list
```
  to get the form list (the application ID needs to be determined first)
2. Match by
```
name
```
  in
```
forms
```
3. Matching strategy:
  - Exact match with unique result: use directly
  - Fuzzy match with multiple results: display the candidate list for users to choose
  - No matching result: inform the user that no result is found

典型工作流

Typical Workflow

查询应用列表

Query Application List

用户query示例：

"帮我查询所有应用"
"查看我有权限的应用"

执行流程：

确定分页参数（用户指定或默认值）
调用
```
app.list
```
获取应用列表
展示应用名称和应用 ID
若结果数量达到 limit，告知用户还有更多应用可继续查看

User query examples:

"Help me query all applications"
"View the applications I have permission to access"

Execution process:

Determine pagination parameters (specified by user or default value)
Call
```
app.list
```
to get the application list
Display application names and application IDs
If the number of results reaches limit, inform the user that there are more applications available to view

查询表单列表

Query Form List

用户query示例：

"帮我查询应用的所有表单"
"查看应用的表单列表"

执行流程：

通过 应用 ID 查找规则 确定目标应用的
```
app_id
```
调用
```
app.entry.list
```
获取表单列表
展示表单名称和表单 ID
若结果数量较多，告知用户可通过分页参数查看更多

User query examples:

"Help me query all forms of the application"
"View the form list of the application"

Execution process:

Determine the
```
app_id
```
of the target application via Application ID Search Rules
Call
```
app.entry.list
```
to get the form list
Display form names and form IDs
If the number of results is large, inform the user that more can be viewed via pagination parameters

查询表单字段

Query Form Fields

用户query示例：

"帮我查询表单的所有字段"
"查看表单的字段信息"

执行流程：

通过 应用 ID 查找规则 确定目标应用的
```
app_id
```
通过 表单 ID 查找规则 确定目标表单的
```
entry_id
```
调用
```
app.entry.widget_list
```
获取字段列表
展示字段名称、标签和类型
若存在系统字段，单独展示系统字段列表

User query examples:

"Help me query all fields of the form"
"View the field information of the form"

Execution process:

Determine the
```
app_id
```
of the target application via Application ID Search Rules
Determine the
```
entry_id
```
of the target form via Form ID Search Rules
Call
```
app.entry.widget_list
```
to get the field list
Display field names, labels and types
If there are system fields, display the system field list separately

错误处理

Error Handling

应用未找到：明确告知用户未找到对应应用
表单未找到：明确告知用户未找到对应表单
API错误：展示具体错误信息，必要时重试
网络问题：HTTP错误时主动重试最多3次

Application not found: Clearly inform the user that the corresponding application is not found
Form not found: Clearly inform the user that the corresponding form is not found
API error: Display specific error information, retry if necessary
Network problem: Actively retry up to 3 times when HTTP error occurs