开放接口
Base URLs: http://127.0.0.1:9000
提示
开放接口由积墨布丁 提供支持
1. POST 分页查询表单列表
POST /v1/apis/jmForm.form.page.query
分页查询表单列表
Body 请求参数
{
"offset": 0,
"formKey": "form_key:varchar(50)",
"limit": 0,
"name": "name:mediumtext"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| X-Buddy-Role | header | string | 是 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » offset | body | number | 是 | offset |
| » formKey | body | string | 否 | 表单唯一标识 |
| » limit | body | number | 是 | limit |
| » name | body | string | 否 | 表单名称 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
2. POST 查询id表单详情
POST /v1/apis/jmForm.form.detail.byId
查询id表单详情
Body 请求参数
{
"id": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| X-Buddy-Role | header | string | 是 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » id | body | number | 是 | id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
3. POST 根据code和formKey查询答题记录
POST /v1/apis/jmForm.formData.detail.byCode
根据code和formKey查询答题记录
Body 请求参数
{
"code": "string",
"formKey": "string"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| X-Buddy-Role | header | string | 是 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » code | body | string | 是 | code |
| » formKey | body | string | 是 | formKey |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
4. POST 根据formKey查询答题记录列表
POST /v1/apis/jmForm.formData.query.byFormKey
根据formKey查询答题记录列表
Body 请求参数
{
"offset": 0,
"formKey": "string",
"limit": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| X-Buddy-Role | header | string | 是 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » offset | body | number | 是 | offset |
| » formKey | body | string | 是 | formKey 表单唯一标识 |
| » limit | body | number | 是 | limit |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
5. POST 根据formKey查询表单详情
POST /v1/apis/jmForm.form.detail.byFormKey
根据formKey查询表单详情
Body 请求参数
{
"formKey": "string"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| X-Buddy-Role | header | string | 是 | none |
| Authorization | header | string | 否 | none |
| body | body | object | 否 | none |
| » formKey | body | string | 是 | 表单唯一标识 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |