准备官方模板建码方案
用官方模板准备批量建码方案:items 按 gallery/get 的 creation_schema 字段 ID 填写,compatibility.can_add_fields 为 true 时可用 extra_fields 追加字段。只校验并保存短期方案,不安装模板、不创建码;通过后返回 30 分钟有效的 plan_id。
请求
text
POST https://open.cli.im/api/v2/rpc/gallery/prepare-creation| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | templates.write、qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
gallery_template_id | string | 是 | 官方模板 ID,取自 gallery/list;不是账号内模板的 template_id |
project_id | integer | 否 | 分区 ID,0 为默认分区(不代表全部分区)。可用的分区用 qrcodes/listCreateTargets 查询。默认 0 |
category_id | integer | 否 | 模板和子码存放的目录 ID;不传放在默认位置。默认 0 |
items | object[] | 是 | 要建的码,1 到 100 项;values 的键为 gallery/get 返回的 creation_schema 里的 field_id,或 extra_fields 里的 field_id。至少 1 项。最多 100 项 |
items[].item_key | string | 是 | 这一项的标识,由调用方自定,同一批内不能重复;查询逐项结果时按它对应。最长 128 个字符 |
items[].name | string | 否 | 码名称,最长 100 字,可以不传。最长 100 个字符 |
items[].values | object | 是 | 字段值,键为 field_id:已有模板取自 templates/getSchema,官方模板取自 gallery/get 的 creation_schema。文本传字符串,数字传数字,日期传 YYYY-MM-DD,图片和附件传 [{"file_key": ...}],不接受外部网址 |
extra_fields | object[] | 否 | 模板自带字段不够用时追加的字段,每个码各自填写,放入“补充信息”分组;仅 compatibility.can_add_fields 为 true 的模板可用。至少 1 项。最多 20 项 |
extra_fields[].field_id | string | 是 | 本次方案内的字段标识,items.values 用它填值;不能与模板自带字段重复 |
extra_fields[].name | string | 是 | 字段名称。最长 100 个字符 |
extra_fields[].type | string | 是 | 字段类型:text 单行文本、textarea 多行文本、number 数字、date 日期(YYYY-MM-DD)、image 图片、file 附件。可选值:text、textarea、number、date、image、file |
extra_fields[].required | boolean | 否 | 是否必填,默认 false。默认 false |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/gallery/prepare-creation' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"gallery_template_id": "30128",
"project_id": 0,
"items": [
{
"item_key": "row-1",
"name": "1 号空压机",
"values": {
"f3a9c1e07b5d": "1 号空压机",
"serial_no": "SN-0001"
}
}
],
"extra_fields": [
{
"field_id": "serial_no",
"name": "出厂编号",
"type": "text"
}
]
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.valid | boolean | 是 | 数据是否全部通过校验 |
data.requested_count | integer | 是 | 本次提交的条数 |
data.errors | object[] | 是 | 未通过校验的问题,按 path 定位;为空表示全部通过 |
data.errors[].code | string | 是 | 错误码,含义见规范顶层的 x-error-catalog |
data.errors[].path | string | 否 | 出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串 |
data.errors[].item_key | string | 否 | 批量数据中出错那一项的 item_key;不针对某一项时为空字符串 |
data.errors[].retryable | boolean | 否 | 原样重试是否可能成功 |
data.errors[].next_action | string | 否 | 建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
data.errors[].message | string | 否 | 补充说明,部分错误才有 |
data.warnings | object[] | 是 | 不阻止建码的提示,如名称重复 |
data.warnings[].code | string | 是 | 错误码,含义见规范顶层的 x-error-catalog |
data.warnings[].path | string | 否 | 出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串 |
data.warnings[].item_key | string | 否 | 批量数据中出错那一项的 item_key;不针对某一项时为空字符串 |
data.warnings[].retryable | boolean | 否 | 原样重试是否可能成功 |
data.warnings[].next_action | string | 否 | 建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
data.warnings[].message | string | 否 | 补充说明,部分错误才有 |
data.field_mapping | object | 是 | 可填写的字段 ID 列表(键和值相同) |
data.samples | any[] | 是 | 请求中前 3 条数据,便于核对 |
data.compatibility | object | 是 | 这个模板能做什么 |
data.compatibility.can_create | boolean | 是 | 是否可以用 gallery/prepare-creation 批量建码 |
data.compatibility.can_create_single | boolean | 是 | 是否可以用 gallery/create-qrcode 生成单个码 |
data.compatibility.can_add_fields | boolean | 是 | 准备方案时是否可以用 extra_fields 追加字段 |
data.compatibility.blockers | object[] | 是 | 阻止批量建码的问题;为空表示可以批量建码 |
data.compatibility.blockers[].code | string | 是 | 错误码,含义见规范顶层的 x-error-catalog |
data.compatibility.blockers[].path | string | 否 | 出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串 |
data.compatibility.blockers[].item_key | string | 否 | 批量数据中出错那一项的 item_key;不针对某一项时为空字符串 |
data.compatibility.blockers[].retryable | boolean | 否 | 原样重试是否可能成功 |
data.compatibility.blockers[].next_action | string | 否 | 建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
data.compatibility.blockers[].message | string | 否 | 补充说明,部分错误才有 |
data.compatibility.unsupported_fields | object[] | 是 | 模板里不能通过接口填写的字段 |
data.compatibility.unsupported_fields[].field_id | string | 是 | 字段 ID |
data.compatibility.unsupported_fields[].name | string | 是 | 字段名称 |
data.compatibility.unsupported_fields[].type | string | 是 | 字段类型 |
data.compatibility.unsupported_fields[].variable | boolean | 是 | 是否每个码各自填写 |
data.compatibility.unsupported_fields[].required | boolean | 是 | 是否必填 |
data.plan_id | string | 否 | 建码方案 ID,30 分钟内有效,传给 gallery/create-from-plan。校验通过时返回 |
data.expires_at | integer | 否 | 方案的过期时间(Unix 秒) |
data.creation_usage | object | 否 | 本次操作计入当日额度的新建数量 |
data.creation_usage.templates | integer | 否 | 新建的模板数 |
data.creation_usage.forms | integer | 否 | 新建的表单数 |
data.creation_usage.qrcodes | integer | 否 | 新建的码数 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"valid": true,
"requested_count": 1,
"errors": [],
"warnings": [],
"field_mapping": {
"f3a9c1e07b5d": "f3a9c1e07b5d",
"serial_no": "serial_no"
},
"samples": [
{
"item_key": "row-1",
"name": "1 号空压机",
"values": {
"f3a9c1e07b5d": "1 号空压机",
"serial_no": "SN-0001"
}
}
],
"compatibility": {
"can_create": true,
"blockers": [],
"unsupported_fields": [],
"can_create_single": true,
"can_add_fields": true
},
"plan_id": "plan_0123456789abcdef0123456789abcdef",
"expires_at": 1795001800,
"creation_usage": {
"templates": 1,
"forms": 1,
"qrcodes": 1
}
}
}常见错误
PERMISSION_DENIED、GALLERY_TEMPLATE_NOT_FOUND、GALLERY_EXTRA_FIELDS_UNSUPPORTED、GALLERY_MASTER_TEMPLATE_REQUIRED、GALLERY_PLACEHOLDER_REQUIRED、CATEGORY_DENIED、UNKNOWN_FIELD、REQUIRED_FIELD、INVALID_TYPE、INVALID_ASSET、DUPLICATE_ITEM_KEY、BATCH_LIMIT、ASSET_UNAVAILABLE、ASSET_LIMIT_EXCEEDED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。