OpenAPI 参考
当前公开记录 274 个 HTTP 操作,按业务领域、访问范围和方法检索。每项均提供操作 ID、路径、已登记参数与请求 Schema,可通过 CLI 或 MCP 调用。
检索全部接口 · 下载 OpenAPI 3.1 JSON · 下载完整 PDF
地址与认证
基础地址是实际 CPQ 服务的根地址,例如本机 http://127.0.0.1:8765。所有目录路径包含 /api/;官网与应用分开部署时,使用应用地址发起请求。
| 身份范围 | 使用地址 | 会话 Cookie |
|---|---|---|
| 本机 / 独立部署业务与门户 | CPQ 应用地址 | cpq_session |
| SaaS 企业业务与企业管理 | 对应企业域名 | __Host-cpq_session |
| SaaS 集中账号 | 平台域名 | __Host-cpq_account |
| SaaS 平台运营 | 平台域名 | __Host-cpq_ops |
非生产 SaaS 环境的 Cookie 不带 __Host- 前缀。SaaS 会话写请求同时使用 X-CPQ-CSRF,请从对应会话读取接口取得,不要自行生成;CLI/MCP 自动处理 Cookie 与 CSRF。登录响应设置 HttpOnly Cookie,业务响应不会提供可复制的长期 API Key。
注册、登录、首次设置等无需已有会话,但仍有凭据、验证和部署限制。外部连接回执使用 X-CPQ-Signature;邮件网关回执支持专用 Bearer 凭据。这些回执凭据不能作为通用业务认证。
HTTP 与客户端返回
HTTP 成功响应是业务 JSON 对象、数组或原始文件。CLI 和 MCP 为调用结果增加 {ok,status,data} 包装,下载文件在未指定 CLI --output 时以 base64 file 对象返回。操作发现与 Schema 导出本身直接输出 JSON。
cpq operations describe products.list
cpq call products.list --query '{"page":1,"pageSize":20}'
cpq call quotes.get --path '{"id":"从列表取得的真实ID"}'
cpq request GET /api/products --query '{"page":1,"pageSize":20}'
直接 HTTP 调用示意;私有 cookie-jar 由登录流程建立,不能放入公开仓库:
curl --fail-with-body --cookie cookie-jar.txt \
'https://cpq.example.com/api/products?page=1&pageSize=20'
参数、分页与版本
路径中的 {id} 或 {filename} 必须替换为真实单个标识。请求体使用 application/json。CLI 的 --body 支持 JSON 文本、@文件或标准输入 -。
已支持分页的操作在参数表列出 page/pageSize;没有全局统一的分页返回结构,请按具体响应读取 items/total 等字段。接口 Schema 中的开放对象表示该文档未穷举领域字段,不表示任意字段都有效。
保存、发布和报价动作通常要求最新 version,客户端不能自行递增。400 和 409 都可能表示业务版本冲突。读取完整当前状态并合并后再提交;不要将精简工作区数据当成完整目录保存。
错误与文件
| HTTP 状态 | 含义与处理 |
|---|---|
| 400 | 输入、业务校验或版本冲突;检查 error 和 validationErrors |
| 401 | 会话不存在或失效;重新登录 |
| 403 | 身份、范围、CSRF 或签名不满足;按当前权限修正请求 |
| 404 | 对象不存在、接口不存在或不属于当前域名 |
| 409 | 并发版本或业务状态冲突;重新读取状态 |
| 429 | 频率或额度限制;遵循服务端提示,部分响应含 Retry-After |
| 500 / 503 | 服务器处理失败或暂时不可用;先确认写入结果 |
错误 JSON 至少含 error,SaaS 错误可含 code 和更多结构化字段。状态表说明共同约定,不代表每个接口都会返回所有状态。服务器没有全局幂等键,写操作不会由 CLI 自动重试。
文件上传使用 base64 JSON,可先用 cpq file encode 编码。导出、附件和后台任务下载返回真实 MIME 与原始字节;用 CLI --output 保存。客户端默认 HTTP 超时 30 秒,可调整到 600 秒;大体量工作优先使用服务端后台任务。
接口目录
展开接口查看参数与调用示例。读取/计算标记来自 CLI/MCP 操作契约;预览仍可能消耗运行资源。范围标签说明入口所需身份,具体数据与动作权限由服务端继续校验。
共 274 个操作
没有匹配的接口
试试产品、报价、catalog 或 /api/quotes,或清除领域与权限筛选。
基础与身份 10
GET/api/health服务健康检查读取 / 计算
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call health.get先运行 cpq operations describe health.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/auth/status登录方式与启用状态读取 / 计算
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call auth.status先运行 cpq operations describe auth.status 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/auth/login本机账号登录;优先使用 cpq auth login写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call auth.login \
--body @request.json先运行 cpq operations describe auth.login 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/auth/logout退出本机或企业会话写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call auth.logout \
--body @request.json先运行 cpq operations describe auth.logout 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/auth/setup首次初始化本机账号写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call auth.setup \
--body @request.json先运行 cpq operations describe auth.setup 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/bootstrap工作区与当前账号的精简上下文读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call bootstrap.get先运行 cpq operations describe bootstrap.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/state完整工作区状态、规则和资料读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call state.get先运行 cpq operations describe state.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/dashboard工作台指标与待办读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call dashboard.get先运行 cpq operations describe dashboard.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/release-status目录、定价和商务发布版本读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call release-status.get先运行 cpq operations describe release-status.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/siteSaaS 站点类型与企业入口读取 / 计算
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call site.get先运行 cpq operations describe site.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
产品与配置 16
GET/api/products分页查询商品读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
CLI 调用
cpq call products.list先运行 cpq operations describe products.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/catalog读取完整产品目录草稿和版本读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call catalog.get先运行 cpq operations describe catalog.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/import批量合并商品到目录草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call catalog.import \
--body @request.json先运行 cpq operations describe catalog.import 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/preview验证目录并运行产品配置页草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| modelId | string | 必需 | — |
| catalogVersion | integer | 可选 | 最近一次读取或保存返回的版本;不要自行递增。 |
| selection | object | 可选 | — |
| attributeValues | object | 可选 | — |
| arrayValues | object | 可选 | — |
| selectedProducts | array | 可选 | — |
| productQuantities | object | 可选 | — |
| configurationAction | string | 可选 | — |
| currency | string | 可选 | — |
| scenarioId | string | 可选 | — |
| catalog | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"modelId": {
"type": "string"
},
"catalogVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"selection": {
"type": "object",
"additionalProperties": true
},
"attributeValues": {
"type": "object",
"additionalProperties": true
},
"arrayValues": {
"type": "object",
"additionalProperties": true
},
"selectedProducts": {
"type": "array",
"items": {
"type": "string"
}
},
"productQuantities": {
"type": "object",
"additionalProperties": true
},
"configurationAction": {
"type": "string"
},
"currency": {
"type": "string"
},
"scenarioId": {
"type": "string"
},
"catalog": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"catalog",
"modelId"
],
"additionalProperties": true
}
CLI 调用
cpq call catalog.preview \
--body @request.json先运行 cpq operations describe catalog.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/rich-preview解析富文本内容读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call catalog.rich-preview \
--body @request.json先运行 cpq operations describe catalog.rich-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/catalog/image-library检索素材库读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call catalog.image-library先运行 cpq operations describe catalog.image-library 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/image上传产品图片写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| name | string | 可选 | — |
| content | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"content"
],
"additionalProperties": true
}
CLI 调用
cpq call catalog.image-upload \
--body @request.json先运行 cpq operations describe catalog.image-upload 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/catalog/images/{filename}读取已上传图片读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| filename | path | string | 必需 | — |
CLI 调用
cpq call catalog.image-download \
--path '{"filename": "实际filename"}'先运行 cpq operations describe catalog.image-download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/configure运行已发布产品配置、布局与规则读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| modelId | string | 可选 | — |
| catalogVersion | integer | 可选 | 最近一次读取或保存返回的版本;不要自行递增。 |
| selection | object | 可选 | — |
| attributeValues | object | 可选 | — |
| arrayValues | object | 可选 | — |
| selectedProducts | array | 可选 | — |
| productQuantities | object | 可选 | — |
| configurationAction | string | 可选 | — |
| currency | string | 可选 | — |
| scenarioId | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"modelId": {
"type": "string"
},
"catalogVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"selection": {
"type": "object",
"additionalProperties": true
},
"attributeValues": {
"type": "object",
"additionalProperties": true
},
"arrayValues": {
"type": "object",
"additionalProperties": true
},
"selectedProducts": {
"type": "array",
"items": {
"type": "string"
}
},
"productQuantities": {
"type": "object",
"additionalProperties": true
},
"configurationAction": {
"type": "string"
},
"currency": {
"type": "string"
},
"scenarioId": {
"type": "string"
}
},
"required": [],
"additionalProperties": true
}
CLI 调用
cpq call configure.run \
--body @request.json先运行 cpq operations describe configure.run 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/calculators/compute执行属性计算器读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call calculators.compute \
--body @request.json先运行 cpq operations describe calculators.compute 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/calculators/preview预览计算器草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call calculators.preview \
--body @request.json先运行 cpq operations describe calculators.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/config-tables保存配置查找表写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call config-tables.save \
--body @request.json先运行 cpq operations describe config-tables.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/product-lines产品线与版本读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call product-lines.get先运行 cpq operations describe product-lines.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/product-lines维护产品线写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| lines | array | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"required": [
"version",
"lines"
],
"additionalProperties": true
}
CLI 调用
cpq call product-lines.save \
--body @request.json先运行 cpq operations describe product-lines.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/draft保存草稿:catalog写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| catalog | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"catalog": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"catalog"
],
"additionalProperties": true
}
CLI 调用
cpq call catalog.draft \
--body @request.json先运行 cpq operations describe catalog.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/catalog/publish发布定义:catalog写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| catalog | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"catalog": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"catalog"
],
"additionalProperties": true
}
CLI 调用
cpq call catalog.publish \
--body @request.json先运行 cpq operations describe catalog.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
规则与 BML 13
POST/api/rules保存并发布单条规则写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| rule | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"rule": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"rule"
],
"additionalProperties": true
}
CLI 调用
cpq call rules.save \
--body @request.json先运行 cpq operations describe rules.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/rules/import批量发布配置规则写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call rules.import \
--body @request.json先运行 cpq operations describe rules.import 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/rules/test测试规则条件和结果读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call rules.test \
--body @request.json先运行 cpq operations describe rules.test 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/bml/http-connections读取 BML HTTP 连接设置读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call bml.http-connections.get先运行 cpq operations describe bml.http-connections.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/bml/http-connections保存 BML HTTP 连接设置写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call bml.http-connections.save \
--body @request.json先运行 cpq operations describe bml.http-connections.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/bml/standard-functions标准 BML 函数与签名读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call bml.functions先运行 cpq operations describe bml.functions 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/bml/file-download下载已保存的 BML 文件读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | query | string | 必需 | — |
CLI 调用
cpq call bml.file-download \
--query '{"id": "实际id"}'先运行 cpq operations describe bml.file-download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/bml/convert-condition条件表达式转换读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call bml.convert-condition \
--body @request.json先运行 cpq operations describe bml.convert-condition 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/bml/test运行 BML 测试;allowHttpWrite 可启用外部写入写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call bml.test \
--body @request.json先运行 cpq operations describe bml.test 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/signed-punchin/certificates公钥和证书配置读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call signed-punchin.certificates.get先运行 cpq operations describe signed-punchin.certificates.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/signed-punchin/certificates保存公钥和证书写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call signed-punchin.certificates.save \
--body @request.json先运行 cpq operations describe signed-punchin.certificates.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/signed-punchin/template构建签名报文模板读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call signed-punchin.template \
--body @request.json先运行 cpq operations describe signed-punchin.template 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/signed-punchin/test验证签名传入属性读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call signed-punchin.test \
--body @request.json先运行 cpq operations describe signed-punchin.test 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
价格与协议 28
GET/api/pricing定价模型与价格规则草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call pricing.get先运行 cpq operations describe pricing.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/pricing/preview定价试算读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call pricing.preview \
--body @request.json先运行 cpq operations describe pricing.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/price-center读取统一价格中心草稿与版本读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call price-center.get先运行 cpq operations describe price-center.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/price-center/history读取价格发布历史读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call price-center.history先运行 cpq operations describe price-center.history 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/price-center/approval-policy读取价格发布审批设置与候选人读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call price-center.approval-policy.get先运行 cpq operations describe price-center.approval-policy.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/approval-policy保存价格审批策略并使旧申请失效写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
},
"reason": {
"type": "string"
}
},
"required": [
"version",
"data",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.approval-policy.save \
--body @request.json先运行 cpq operations describe price-center.approval-policy.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/price-center/approvals分页读取价格变更审批记录读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
CLI 调用
cpq call price-center.approvals先运行 cpq operations describe price-center.approvals 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/price-center/approval-detail读取价格审批冻结差异与完整处理记录读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | query | string | 必需 | — |
CLI 调用
cpq call price-center.approval-detail \
--query '{"id": "实际id"}'先运行 cpq operations describe price-center.approval-detail 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/approval-submit提交已保存并核对的价格草稿审批写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| base | object | 必需 | — |
| reviewDigest | string | 必需 | — |
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"base": {
"type": "object",
"additionalProperties": true
},
"reviewDigest": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"version",
"base",
"reviewDigest",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.approval-submit \
--body @request.json先运行 cpq operations describe price-center.approval-submit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/approval-decide按顺序批准、退回或撤回价格变更申请写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| id | string | 必需 | — |
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| action | JSON · approve / reject / withdraw | 必需 | — |
| reason | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"action": {
"enum": [
"approve",
"reject",
"withdraw"
]
},
"reason": {
"type": "string"
}
},
"required": [
"id",
"version",
"action"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.approval-decide \
--body @request.json先运行 cpq operations describe price-center.approval-decide 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/review校验并对比待发布价格读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| base | object | 必需 | — |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"base": {
"type": "object",
"additionalProperties": true
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"base",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.review \
--body @request.json先运行 cpq operations describe price-center.review 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/draft保存统一价格草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| base | object | 必需 | — |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"base": {
"type": "object",
"additionalProperties": true
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"base",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.draft \
--body @request.json先运行 cpq operations describe price-center.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/publish原子发布已核对的价格草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| base | object | 必需 | — |
| data | object | 必需 | — |
| reviewDigest | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"base": {
"type": "object",
"additionalProperties": true
},
"data": {
"type": "object",
"additionalProperties": true
},
"reviewDigest": {
"type": "string"
}
},
"required": [
"version",
"base",
"data",
"reviewDigest"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.publish \
--body @request.json先运行 cpq operations describe price-center.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/reset从当前发布版重建价格草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.reset \
--body @request.json先运行 cpq operations describe price-center.reset 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/restore恢复历史价格为草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| base | object | 必需 | — |
| releaseVersion | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"base": {
"type": "object",
"additionalProperties": true
},
"releaseVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
}
},
"required": [
"version",
"base",
"releaseVersion"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.restore \
--body @request.json先运行 cpq operations describe price-center.restore 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/agreement-source-preview预览已批准报价可转换的协议明细,不写入读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| quoteId | string | 必需 | — |
| quoteVersion | integer | 可选 | 最近一次读取或保存返回的版本;不要自行递增。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"quoteId": {
"type": "string"
},
"quoteVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
}
},
"required": [
"quoteId"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.agreement-source-preview \
--body @request.json先运行 cpq operations describe price-center.agreement-source-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/agreement-from-quote生成来源可核验的协议提案,另行保存并发布读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| quoteId | string | 必需 | — |
| quoteVersion | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| lineIds | array | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"quoteId": {
"type": "string"
},
"quoteVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"lineIds": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"quoteId",
"quoteVersion",
"lineIds"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.agreement-from-quote \
--body @request.json先运行 cpq operations describe price-center.agreement-from-quote 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price-center/agreement-revision生成协议修订或续期提案,另行保存并发布读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| agreementId | string | 必需 | — |
| agreementDigest | string | 必需 | — |
| changeKind | JSON · revision / renewal | 必需 | — |
| startDate | string | 必需 | — |
| endDate | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"agreementId": {
"type": "string"
},
"agreementDigest": {
"type": "string"
},
"changeKind": {
"enum": [
"revision",
"renewal"
]
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
}
},
"required": [
"agreementId",
"agreementDigest",
"changeKind",
"startDate"
],
"additionalProperties": true
}
CLI 调用
cpq call price-center.agreement-revision \
--body @request.json先运行 cpq operations describe price-center.agreement-revision 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commercial/import-preview价目导入预检读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commercial.import-preview \
--body @request.json先运行 cpq operations describe commercial.import-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commercial/preview商业价格预览读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commercial.preview \
--body @request.json先运行 cpq operations describe commercial.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commercial/exchange-preview币种对汇率试算读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commercial.exchange-preview \
--body @request.json先运行 cpq operations describe commercial.exchange-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/price报价金额试算读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call price.calculate \
--body @request.json先运行 cpq operations describe price.calculate 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/settings保存基础价目或审批参数写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call settings.save \
--body @request.json先运行 cpq operations describe settings.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/demo启用明确标记的示例价格写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call demo.enable \
--body @request.json先运行 cpq operations describe demo.enable 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/pricing/draft保存草稿:pricing写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call pricing.draft \
--body @request.json先运行 cpq operations describe pricing.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/pricing/publish发布定义:pricing写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call pricing.publish \
--body @request.json先运行 cpq operations describe pricing.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/manage/commercial读取commercial读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call manage.commercial.get先运行 cpq operations describe manage.commercial.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/manage/commercial保存commercial写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call manage.commercial.save \
--body @request.json先运行 cpq operations describe manage.commercial.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
商务与审批 12
GET/api/commerce读取商务流程草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call commerce.get先运行 cpq operations describe commerce.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/filter-preview预览商务行过滤读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.filter-preview \
--body @request.json先运行 cpq operations describe commerce.filter-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/constraint-preview预览商务约束读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.constraint-preview \
--body @request.json先运行 cpq operations describe commerce.constraint-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/access-preview预览字段与动作访问规则读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.access-preview \
--body @request.json先运行 cpq operations describe commerce.access-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/validation-preview预览商务校验规则读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.validation-preview \
--body @request.json先运行 cpq operations describe commerce.validation-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/formula-preview预览商务公式读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.formula-preview \
--body @request.json先运行 cpq operations describe commerce.formula-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/modify-preview预览修改动作读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.modify-preview \
--body @request.json先运行 cpq operations describe commerce.modify-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/preview预览商务流程读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call commerce.preview \
--body @request.json先运行 cpq operations describe commerce.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/draft保存草稿:commerce写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call commerce.draft \
--body @request.json先运行 cpq operations describe commerce.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/commerce/publish发布定义:commerce写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call commerce.publish \
--body @request.json先运行 cpq operations describe commerce.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/manage/approvalPolicy读取approvalPolicy读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call manage.approvalPolicy.get先运行 cpq operations describe manage.approvalPolicy.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/manage/approvalPolicy保存approvalPolicy写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call manage.approvalPolicy.save \
--body @request.json先运行 cpq operations describe manage.approvalPolicy.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
报价与界面 29
GET/api/quote-scenarios销售可用报价场景读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call quote-scenarios.list先运行 cpq operations describe quote-scenarios.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/quote-experience报价场景、布局、字段呈现及预览参考数据读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call quote-experience.get先运行 cpq operations describe quote-experience.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quote-experience/preview以真实报价和账号预览报价界面草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| data | object | 必需 | — |
| quoteId | string | 必需 | — |
| userId | string | 必需 | — |
| stage | JSON · draft / pending / approved / rejected / ordered | 可选 | — |
| stepId | string | 可选 | — |
| scenarioId | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"quoteId": {
"type": "string"
},
"userId": {
"type": "string"
},
"stage": {
"enum": [
"draft",
"pending",
"approved",
"rejected",
"ordered"
]
},
"stepId": {
"type": "string"
},
"scenarioId": {
"type": "string"
}
},
"required": [
"data",
"quoteId",
"userId"
],
"additionalProperties": true
}
CLI 调用
cpq call quote-experience.preview \
--body @request.json先运行 cpq operations describe quote-experience.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/quotes分页查询当前账号可见报价读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
CLI 调用
cpq call quotes.list先运行 cpq operations describe quotes.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes从产品配置创建报价写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| modelId | string | 可选 | — |
| catalogVersion | integer | 可选 | 最近一次读取或保存返回的版本;不要自行递增。 |
| selection | object | 可选 | — |
| attributeValues | object | 可选 | — |
| arrayValues | object | 可选 | — |
| selectedProducts | array | 可选 | — |
| productQuantities | object | 可选 | — |
| configurationAction | string | 可选 | — |
| currency | string | 可选 | — |
| scenarioId | string | 可选 | — |
| customer | string | 可选 | — |
| project | string | 可选 | — |
| region | string | 可选 | — |
| buyerId | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"modelId": {
"type": "string"
},
"catalogVersion": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"selection": {
"type": "object",
"additionalProperties": true
},
"attributeValues": {
"type": "object",
"additionalProperties": true
},
"arrayValues": {
"type": "object",
"additionalProperties": true
},
"selectedProducts": {
"type": "array",
"items": {
"type": "string"
}
},
"productQuantities": {
"type": "object",
"additionalProperties": true
},
"configurationAction": {
"type": "string"
},
"currency": {
"type": "string"
},
"scenarioId": {
"type": "string"
},
"customer": {
"type": "string"
},
"project": {
"type": "string"
},
"region": {
"type": "string"
},
"buyerId": {
"type": "string"
}
},
"required": [],
"additionalProperties": true
}
CLI 调用
cpq call quotes.create \
--body @request.json先运行 cpq operations describe quotes.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/quotes/{id}读取报价读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call quotes.get \
--path '{"id": "实际id"}'先运行 cpq operations describe quotes.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}校验、重新计价并保存报价写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| customer | string | 可选 | — |
| project | string | 可选 | — |
| lines | array | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"customer": {
"type": "string"
},
"project": {
"type": "string"
},
"lines": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.save \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/rule-preview报价未保存修改的规则预览读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.rule-preview \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.rule-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/access-preview报价字段访问预览读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call quotes.access-preview \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.access-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/document-preview报价文档预览读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| kind | string | 可选 | — |
| language | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"kind": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.document-preview \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.document-preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quote-experience/draft保存草稿:quote-experience写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call quote-experience.draft \
--body @request.json先运行 cpq operations describe quote-experience.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quote-experience/publish发布定义:quote-experience写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call quote-experience.publish \
--body @request.json先运行 cpq operations describe quote-experience.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/clone报价动作 clone;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.clone \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.clone 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/adopt-process报价动作 adopt-process;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.adopt-process \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.adopt-process 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/modify报价动作 modify;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.modify \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.modify 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/advance报价动作 advance;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.advance \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.advance 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/remind报价动作 remind;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.remind \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.remind 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/reprice报价动作 reprice;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.reprice \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.reprice 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/reconfigure报价动作 reconfigure;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.reconfigure \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.reconfigure 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/submit报价动作 submit;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.submit \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.submit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/approve报价动作 approve;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.approve \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.approve 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/reject报价动作 reject;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.reject \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.reject 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/withdraw报价动作 withdraw;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.withdraw \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.withdraw 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/order报价动作 order;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.order \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.order 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/add-configuration报价动作 add-configuration;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.add-configuration \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.add-configuration 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/copy-configuration报价动作 copy-configuration;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.copy-configuration \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.copy-configuration 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/remove-configuration报价动作 remove-configuration;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.remove-configuration \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.remove-configuration 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/rename-configuration报价动作 rename-configuration;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.rename-configuration \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.rename-configuration 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/quotes/{id}/reorder-configurations报价动作 reorder-configurations;必须携带最新 version写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| comment | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"comment": {
"type": "string"
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call quotes.reorder-configurations \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe quotes.reorder-configurations 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
文档与导出 15
GET/api/export导出 PDF、DOCX 或内部 BOM CSV/XLSX读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | query | string | 必需 | — |
| format | query | JSON · pdf / docx / csv / xlsx | 按需 | — |
| kind | query | JSON · quote / technical / bom | 按需 | — |
| language | query | JSON · zh / en / both | 按需 | — |
| descriptionMode | query | string | 按需 | — |
| audience | query | string | 按需 | — |
CLI 调用
cpq call export.download \
--query '{"id": "实际id"}'先运行 cpq operations describe export.download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/jobs创建异步导出或后台业务任务写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call jobs.create \
--body @request.json先运行 cpq operations describe jobs.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/jobs/{id}查询异步任务进度读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call jobs.get \
--path '{"id": "实际id"}'先运行 cpq operations describe jobs.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/jobs/{id}/download下载后台任务产物读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call jobs.download \
--path '{"id": "实际id"}'先运行 cpq operations describe jobs.download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/document-design文档设计草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call document-design.get先运行 cpq operations describe document-design.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/document-design/check验证文档模板读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call document-design.check \
--body @request.json先运行 cpq operations describe document-design.check 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/document-design/references查询文档模板引用读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call document-design.references \
--body @request.json先运行 cpq operations describe document-design.references 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/documents/preview真实报价的文档模板草稿预览读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call documents.preview \
--body @request.json先运行 cpq operations describe documents.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/documents/upload上传文档附件写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| filename | string | 必需 | — |
| content | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"filename",
"content"
],
"additionalProperties": true
}
CLI 调用
cpq call documents.upload \
--body @request.json先运行 cpq operations describe documents.upload 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/email-templates邮件模板草稿读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call email-templates.get先运行 cpq operations describe email-templates.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/email-templates/preview预览邮件模板读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call email-templates.preview \
--body @request.json先运行 cpq operations describe email-templates.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/document-design/draft保存草稿:document-design写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call document-design.draft \
--body @request.json先运行 cpq operations describe document-design.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/document-design/publish发布定义:document-design写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call document-design.publish \
--body @request.json先运行 cpq operations describe document-design.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/email-templates/draft保存草稿:email-templates写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call email-templates.draft \
--body @request.json先运行 cpq operations describe email-templates.draft 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/email-templates/publish发布定义:email-templates写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call email-templates.publish \
--body @request.json先运行 cpq operations describe email-templates.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
报告与审计 16
GET/api/reports/manager报告定义、列、文件夹和调度读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call reports.manager先运行 cpq operations describe reports.manager 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/examples生成可运行的报价分析示例报告写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.examples \
--body @request.json先运行 cpq operations describe reports.examples 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/reports查询报告或导出 CSV/XLSX读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call reports.query先运行 cpq operations describe reports.query 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports按复杂条件查询报告或导出读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.run \
--body @request.json先运行 cpq operations describe reports.run 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/settings保存报告权限设置写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.settings \
--body @request.json先运行 cpq operations describe reports.settings 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/repopulate刷新并校验报告列写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.repopulate \
--body @request.json先运行 cpq operations describe reports.repopulate 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/folders保存报告文件夹写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.folders \
--body @request.json先运行 cpq operations describe reports.folders 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/delete删除报告定义写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.delete \
--body @request.json先运行 cpq operations describe reports.delete 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/schedules保存持久化报告调度写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.schedules \
--body @request.json先运行 cpq operations describe reports.schedules 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/email将报告加入邮件队列写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.email \
--body @request.json先运行 cpq operations describe reports.email 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/reports/email-file下载报告邮件附件读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call reports.email-file先运行 cpq operations describe reports.email-file 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/reports/views可用报告视图读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call reports.views.get先运行 cpq operations describe reports.views.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/reports/views保存报告视图写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call reports.views.save \
--body @request.json先运行 cpq operations describe reports.views.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/logs分页查询运行日志读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
CLI 调用
cpq call logs.get先运行 cpq operations describe logs.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/logs按复杂条件查询日志读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call logs.query \
--body @request.json先运行 cpq operations describe logs.query 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/audit操作审计读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call audit.get先运行 cpq operations describe audit.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
连接与集成 16
GET/api/connections外部连接定义读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call connections.get先运行 cpq operations describe connections.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections保存外部连接定义写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.save \
--body @request.json先运行 cpq operations describe connections.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/connections/cloudcc-accountCloudCC 账号脱敏配置读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call connections.cloudcc.get先运行 cpq operations describe connections.cloudcc.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections/cloudcc-account保存 CloudCC 账号配置写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.cloudcc.save \
--body @request.json先运行 cpq operations describe connections.cloudcc.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections/cloudcc-testCloudCC 连通性测试写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.cloudcc.test \
--body @request.json先运行 cpq operations describe connections.cloudcc.test 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/connections/tasks连接任务与回执读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call connections.tasks.get先运行 cpq operations describe connections.tasks.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections/tasks创建连接任务写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.tasks.create \
--body @request.json先运行 cpq operations describe connections.tasks.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections/send执行外部连接任务写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.send \
--body @request.json先运行 cpq operations describe connections.send 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/connections/receipt外部回执;需 X-CPQ-Signature写操作
外部回执必须通过 X-CPQ-Signature 验签和服务端任务匹配。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call connections.receipt \
--body @request.json先运行 cpq operations describe connections.receipt 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/integrations/jobs邮件与 ERP 集成任务读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call integrations.jobs先运行 cpq operations describe integrations.jobs 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/integrations/deliver投递集成任务写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call integrations.deliver \
--body @request.json先运行 cpq operations describe integrations.deliver 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/integrations/email-reply接收审批邮件回执写操作
使用已配置的邮件网关 Bearer 凭据,或有权限的业务会话。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call integrations.email-reply \
--body @request.json先运行 cpq operations describe integrations.email-reply 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/integrations/eml下载邮件原文读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call integrations.eml先运行 cpq operations describe integrations.eml 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/integrations/erp建立 ERP 订单同步任务写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call integrations.erp \
--body @request.json先运行 cpq operations describe integrations.erp 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/manage/integrations读取integrations读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call manage.integrations.get先运行 cpq operations describe manage.integrations.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/manage/integrations保存integrations写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call manage.integrations.save \
--body @request.json先运行 cpq operations describe manage.integrations.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
资产与订单 8
GET/api/business/policy资产与跨线业务策略读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call business.policy.get先运行 cpq operations describe business.policy.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/business/policy维护资产业务策略写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call business.policy.save \
--body @request.json先运行 cpq operations describe business.policy.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/business/assets分页查询资产读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
CLI 调用
cpq call business.assets.list先运行 cpq operations describe business.assets.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/business/assets建立资产台账写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call business.assets.create \
--body @request.json先运行 cpq operations describe business.assets.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/business/assets/{id}读取资产读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call business.assets.get \
--path '{"id": "实际id"}'先运行 cpq operations describe business.assets.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/business/assets/{id}/preview续费、变更、取消预览读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call business.assets.preview \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe business.assets.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/business/assets/{id}/quote从资产变更创建报价写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call business.assets.quote \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe business.assets.quote 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/business/orders查询报价拆分订单读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| quoteId | query | string | 必需 | — |
CLI 调用
cpq call business.orders \
--query '{"quoteId": "实际quoteId"}'先运行 cpq operations describe business.orders 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
渠道与客户门户 14
GET/api/portal-admin组织与门户申请读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call portal-admin.get先运行 cpq operations describe portal-admin.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal-admin保存门户组织策略写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal-admin.save \
--body @request.json先运行 cpq operations describe portal-admin.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal-admin/review审核门户申请写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal-admin.review \
--body @request.json先运行 cpq operations describe portal-admin.review 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal-admin/member维护门户成员写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal-admin.member \
--body @request.json先运行 cpq operations describe portal-admin.member 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/register申请门户账号写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.register \
--body @request.json先运行 cpq operations describe portal.register 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/portal/me当前门户身份和可用型号读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call portal.me先运行 cpq operations describe portal.me 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/configure门户配置产品读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.configure \
--body @request.json先运行 cpq operations describe portal.configure 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/portal/quotes门户报价列表读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call portal.quotes.list先运行 cpq operations describe portal.quotes.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/quotes门户创建报价;需 requestId写操作
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.quotes.create \
--body @request.json先运行 cpq operations describe portal.quotes.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/portal/quotes/{id}读取门户报价读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call portal.quotes.get \
--path '{"id": "实际id"}'先运行 cpq operations describe portal.quotes.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/quotes/{id}/submit门户确认报价并提交写操作
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.quotes.submit \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe portal.quotes.submit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/portal/assets门户可见资产读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call portal.assets.list先运行 cpq operations describe portal.assets.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/assets/{id}/preview门户资产变更预览读取 / 计算
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.assets.preview \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe portal.assets.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/portal/assets/{id}/quote门户资产变更报价写操作
获准的门户账号;组织、型号、报价、资产范围由服务端限制。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call portal.assets.quote \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe portal.assets.quote 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
AI 与知识 13
GET/api/ai/capabilities当前账号可用 AI 能力读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call ai.capabilities先运行 cpq operations describe ai.capabilities 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/ai/settingsAI 连接与能力配置读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call ai.settings.get先运行 cpq operations describe ai.settings.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/settings保存 AI 草稿写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.settings.save \
--body @request.json先运行 cpq operations describe ai.settings.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/publish发布 AI 配置写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.publish \
--body @request.json先运行 cpq operations describe ai.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/test-connection测试已配置模型服务写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.test-connection \
--body @request.json先运行 cpq operations describe ai.test-connection 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/ai/documents知识资料列表读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call ai.documents.list先运行 cpq operations describe ai.documents.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/documents上传或维护知识资料写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.documents.save \
--body @request.json先运行 cpq operations describe ai.documents.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/ai/runsAI 运行记录读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call ai.runs.list先运行 cpq operations describe ai.runs.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/runs发起 AI 任务写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.runs.create \
--body @request.json先运行 cpq operations describe ai.runs.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/ai/runs/{id}读取 AI 运行结果读取 / 计算
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call ai.runs.get \
--path '{"id": "实际id"}'先运行 cpq operations describe ai.runs.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/runs/{id}/apply应用经过校验的价格建议写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.runs.apply \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe ai.runs.apply 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/runs/{id}/select选择推荐产品写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.runs.select \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe ai.runs.select 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/ai/runs/{id}/configuration读取建议配置写操作
业务账号;继续执行产品线、报价所有权、审批、金额及字段权限。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call ai.runs.configuration \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe ai.runs.configuration 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
账号与企业空间 31
GET/api/public/templatesSaaS 可用行业模板读取 / 计算
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call public.templates先运行 cpq operations describe public.templates 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/public/signup-requests申请注册写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call public.signup \
--body @request.json先运行 cpq operations describe public.signup 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/public/verify-email验证注册邮箱写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call public.verify-email \
--body @request.json先运行 cpq operations describe public.verify-email 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/public/forgot-password发起密码重置写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call public.forgot-password \
--body @request.json先运行 cpq operations describe public.forgot-password 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/public/reset-password完成密码重置写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call public.reset-password \
--body @request.json先运行 cpq operations describe public.reset-password 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/public/staff-enrollment平台管理员首次设置写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call public.staff-enrollment \
--body @request.json先运行 cpq operations describe public.staff-enrollment 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/account/login集中账号登录写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call account.login \
--body @request.json先运行 cpq operations describe account.login 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/account/session集中账号会话读取 / 计算
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call account.session先运行 cpq operations describe account.session 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/account/logout退出集中账号会话写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call account.logout \
--body @request.json先运行 cpq operations describe account.logout 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/me/tenants当前账号的企业空间读取 / 计算
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call me.tenants.list先运行 cpq operations describe me.tenants.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/me/tenants创建企业空间写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call me.tenants.create \
--body @request.json先运行 cpq operations describe me.tenants.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/me/tenant-sessions签发企业一次性登录票据写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call me.tenant-sessions \
--body @request.json先运行 cpq operations describe me.tenant-sessions 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/me/invitations/accept接受成员邀请写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call me.invitations.accept \
--body @request.json先运行 cpq operations describe me.invitations.accept 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/me/ownership/accept接受企业所有权写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call me.ownership.accept \
--body @request.json先运行 cpq operations describe me.ownership.accept 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/me/portal-requests申请加入客户门户写操作
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call me.portal-requests \
--body @request.json先运行 cpq operations describe me.portal-requests 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/me/provisioning查询企业开通进度读取 / 计算
集中账号会话;仅可访问所属企业及获准的开户、邀请、票据等能力。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| tenantId | query | string | 必需 | — |
CLI 调用
cpq call me.provisioning \
--query '{"tenantId": "实际tenantId"}'先运行 cpq operations describe me.provisioning 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/profile企业资料、成员与权限读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call tenant.profile先运行 cpq operations describe tenant.profile 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/entitlements企业额度与使用量读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call tenant.entitlements先运行 cpq operations describe tenant.entitlements 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/invitations邀请成员写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.invitations \
--body @request.json先运行 cpq operations describe tenant.invitations 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/members维护成员角色和状态写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.members \
--body @request.json先运行 cpq operations describe tenant.members 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/ownership发起所有权转移写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.ownership \
--body @request.json先运行 cpq operations describe tenant.ownership 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/close-requests申请关闭企业写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.close-requests \
--body @request.json先运行 cpq operations describe tenant.close-requests 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/support支持请求与授权写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.support \
--body @request.json先运行 cpq operations describe tenant.support 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/secrets维护企业私有密钥写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.secrets \
--body @request.json先运行 cpq operations describe tenant.secrets 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/exports创建企业数据导出写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call tenant.exports.create \
--body @request.json先运行 cpq operations describe tenant.exports.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/exports/{id}/download下载企业数据导出读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call tenant.exports.download \
--path '{"id": "实际id"}'先运行 cpq operations describe tenant.exports.download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/tickets当前企业的服务工单读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| search | query | string | 按需 | — |
| state | query | string | 按需 | — |
| priority | query | string | 按需 | — |
| category | query | string | 按需 | — |
| view | query | string | 按需 | — |
| tenantId | query | string | 按需 | — |
| includeDemo | query | string | 按需 | — |
CLI 调用
cpq call tenant.tickets.list先运行 cpq operations describe tenant.tickets.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/tickets提交企业服务工单写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| subject | string | 必需 | — |
| message | string | 必需 | — |
| requestId | string | 必需 | — |
| category | string · account / configuration / usage / incident / other | 可选 | — |
| priority | string · high / normal / low | 可选 | — |
| attachments | array | 可选 | 提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"subject": {
"type": "string",
"maxLength": 160
},
"message": {
"type": "string",
"maxLength": 6000
},
"requestId": {
"type": "string",
"maxLength": 100
},
"category": {
"type": "string",
"enum": [
"account",
"configuration",
"usage",
"incident",
"other"
]
},
"priority": {
"type": "string",
"enum": [
"high",
"normal",
"low"
]
},
"attachments": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"data": {
"type": "string",
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
],
"additionalProperties": true
},
"description": "提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。"
}
},
"required": [
"subject",
"message",
"requestId"
],
"additionalProperties": true
}
CLI 调用
cpq call tenant.tickets.create \
--body @request.json先运行 cpq operations describe tenant.tickets.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/tickets/{id}读取企业工单与公开消息读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call tenant.tickets.get \
--path '{"id": "实际id"}'先运行 cpq operations describe tenant.tickets.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/tenant/tickets/{id}回复、确认关闭或重开企业工单写操作
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| message | string | 可选 | — |
| attachments | array | 可选 | 提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。 |
| state | string · open / in_progress / waiting_customer / resolved / closed | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"data": {
"type": "string",
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
],
"additionalProperties": true
},
"description": "提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。"
},
"state": {
"type": "string",
"enum": [
"open",
"in_progress",
"waiting_customer",
"resolved",
"closed"
]
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call tenant.tickets.update \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe tenant.tickets.update 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/tenant/tickets/{id}/files/{fileId}下载本企业工单的公开附件读取 / 计算
企业域名的成员会话;邀请、所有权、密钥、导出等另校验企业角色。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| fileId | path | string | 必需 | — |
CLI 调用
cpq call tenant.tickets.download \
--path '{"id": "实际id", "fileId": "实际fileId"}'先运行 cpq operations describe tenant.tickets.download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
平台运营 46
POST/api/platform/login平台管理员登录;生产环境使用 MFA写操作
无需已有会话;登录、注册、初始化仍受凭据、部署模式与频率限制。
未登记固定路径、查询或请求头参数。
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.login \
--body @request.json先运行 cpq operations describe platform.login 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/session平台运营会话读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.session先运行 cpq operations describe platform.session 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/logout退出平台运营写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.logout \
--body @request.json先运行 cpq operations describe platform.logout 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/overview平台运营概览读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.overview先运行 cpq operations describe platform.overview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/tenants查询企业读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| search | query | string | 按需 | — |
| status | query | string | 按需 | — |
CLI 调用
cpq call platform.tenants.list先运行 cpq operations describe platform.tenants.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/tenants/{id}企业详情读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call platform.tenants.get \
--path '{"id": "实际id"}'先运行 cpq operations describe platform.tenants.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/tenants/{id}/suspend停用企业写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.tenants.suspend \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.tenants.suspend 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/tenants/{id}/resume恢复企业写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.tenants.resume \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.tenants.resume 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/tenants/{id}/entitlements调整企业额度写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.tenants.entitlements \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.tenants.entitlements 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/tenants/{id}/support-requests发起企业支持访问申请写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.tenants.support \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.tenants.support 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/tenants/{id}/backups建立企业备份任务写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.tenants.backup \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.tenants.backup 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/tenants/{id}/business-view按支持授权读取企业业务读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| grantId | query | string | 必需 | — |
CLI 调用
cpq call platform.tenants.business-view \
--path '{"id": "实际id"}' \
--query '{"grantId": "实际grantId"}'先运行 cpq operations describe platform.tenants.business-view 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/provisioning/{id}/retry重试开通任务写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.provisioning.retry \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.provisioning.retry 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/templates平台行业模板读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.templates.get先运行 cpq operations describe platform.templates.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/templates维护行业模板写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.templates.save \
--body @request.json先运行 cpq operations describe platform.templates.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/staff平台成员权限读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.staff.get先运行 cpq operations describe platform.staff.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/staff维护平台成员写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
开放 JSON 对象。此目录未穷举领域字段;先读取现有对象,保留完整定义并由服务端校验。
查看完整请求 Schema
{
"type": "object",
"additionalProperties": true
}
CLI 调用
cpq call platform.staff.save \
--body @request.json先运行 cpq operations describe platform.staff.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/audit平台审计读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.audit先运行 cpq operations describe platform.audit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/jobs平台后台任务读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.jobs先运行 cpq operations describe platform.jobs 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/usage平台用量记录读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.usage先运行 cpq operations describe platform.usage 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/overview运营工作台、统计与待办读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| days | query | integer · 7 / 30 / 90 | 按需 | — |
| view | query | string | 按需 | — |
| includeDemo | query | string | 按需 | — |
| showSnoozed | query | string | 按需 | — |
| state | query | string | 按需 | — |
CLI 调用
cpq call platform.console.overview先运行 cpq operations describe platform.console.overview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/tenants按状态、套餐和负责人筛选企业读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
| tag | query | string | 按需 | — |
| status | query | string | 按需 | — |
| plan | query | string | 按需 | — |
| view | query | string | 按需 | — |
| population | query | string | 按需 | — |
| sort | query | string | 按需 | — |
| includeDemo | query | string | 按需 | — |
CLI 调用
cpq call platform.console.tenants先运行 cpq operations describe platform.console.tenants 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/tenants/{id}企业运营档案、额度、跟进与审计读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call platform.console.tenant \
--path '{"id": "实际id"}'先运行 cpq operations describe platform.console.tenant 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/usage分页查询企业有效额度与用量读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
| search | query | string | 按需 | — |
| tag | query | string | 按需 | — |
| status | query | string | 按需 | — |
| plan | query | string | 按需 | — |
| view | query | string | 按需 | — |
| population | query | string | 按需 | — |
| sort | query | string | 按需 | — |
| includeDemo | query | string | 按需 | — |
CLI 调用
cpq call platform.console.usage先运行 cpq operations describe platform.console.usage 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/jobs分页查询后台任务读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| tenantId | query | string | 按需 | — |
| status | query | string | 按需 | — |
| kind | query | string | 按需 | — |
| view | query | string | 按需 | — |
| from | query | number | 按需 | — |
| to | query | number | 按需 | — |
CLI 调用
cpq call platform.console.jobs先运行 cpq operations describe platform.console.jobs 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/mail分页查询邮件投递状态读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| tenantId | query | string | 按需 | — |
| status | query | string | 按需 | — |
| kind | query | string | 按需 | — |
| view | query | string | 按需 | — |
| from | query | number | 按需 | — |
| to | query | number | 按需 | — |
CLI 调用
cpq call platform.console.mail先运行 cpq operations describe platform.console.mail 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/support分页查询支持授权读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| tenantId | query | string | 按需 | — |
| status | query | string | 按需 | — |
| kind | query | string | 按需 | — |
| view | query | string | 按需 | — |
| from | query | number | 按需 | — |
| to | query | number | 按需 | — |
CLI 调用
cpq call platform.console.support先运行 cpq operations describe platform.console.support 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/audit按企业、操作者与时间检索审计读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| tenantId | query | string | 按需 | — |
| actor | query | string | 按需 | — |
| action | query | string | 按需 | — |
| from | query | number | 按需 | — |
| to | query | number | 按需 | — |
CLI 调用
cpq call platform.console.audit先运行 cpq operations describe platform.console.audit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/settings运行状态与平台人员摘要读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call platform.console.settings先运行 cpq operations describe platform.console.settings 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/batch批量调整企业负责人或标签写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| items | array | 必需 | — |
| reason | string | 必需 | — |
| assignee | string | 可选 | — |
| tags | array | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
}
},
"required": [
"id",
"version"
],
"additionalProperties": true
}
},
"reason": {
"type": "string"
},
"assignee": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"items",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.batch \
--body @request.json先运行 cpq operations describe platform.console.batch 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/items/{id}处理运营待办、分配负责人及稍后提醒写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| state | string · open / in_progress / resolved | 必需 | — |
| note | string | 必需 | — |
| assignee | string | 可选 | — |
| snoozeUntil | number | 可选 | Unix 秒;非 0 时须在未来 30 天内。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"state": {
"type": "string",
"enum": [
"open",
"in_progress",
"resolved"
]
},
"note": {
"type": "string"
},
"assignee": {
"type": "string"
},
"snoozeUntil": {
"type": "number",
"minimum": 0,
"description": "Unix 秒;非 0 时须在未来 30 天内。"
}
},
"required": [
"version",
"state",
"note"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.item-update \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.item-update 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/tenants/{id}/profile更新企业运营档案写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| industry | string | 可选 | — |
| source | string | 可选 | — |
| tags | array | 可选 | — |
| assignee | string | 可选 | — |
| category | string · customer / demo | 可选 | — |
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"industry": {
"type": "string"
},
"source": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"assignee": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"customer",
"demo"
]
},
"reason": {
"type": "string"
}
},
"required": [
"version",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.profile \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.profile 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/tenants/{id}/notes添加企业跟进记录写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| body | string | 必需 | — |
| nextAt | number | 可选 | Unix 秒;0 表示不安排下次跟进。 |
查看完整请求 Schema
{
"type": "object",
"properties": {
"body": {
"type": "string",
"maxLength": 2000
},
"nextAt": {
"type": "number",
"minimum": 0,
"description": "Unix 秒;0 表示不安排下次跟进。"
}
},
"required": [
"body"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.note \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.note 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/jobs/{id}/retry重新排队失败的后台任务写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"required": [
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.job-retry \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.job-retry 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/mail/{id}/retry重新排队失败的邮件写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"required": [
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.mail-retry \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.mail-retry 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/tickets平台工单队列与响应指标读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| search | query | string | 按需 | — |
| state | query | string | 按需 | — |
| priority | query | string | 按需 | — |
| category | query | string | 按需 | — |
| view | query | string | 按需 | — |
| tenantId | query | string | 按需 | — |
| includeDemo | query | string | 按需 | — |
CLI 调用
cpq call platform.console.tickets.list先运行 cpq operations describe platform.console.tickets.list 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/tickets为企业创建服务工单写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| subject | string | 必需 | — |
| message | string | 必需 | — |
| requestId | string | 必需 | — |
| category | string · account / configuration / usage / incident / other | 可选 | — |
| priority | string · high / normal / low | 可选 | — |
| attachments | array | 可选 | 提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。 |
| tenantId | string | 必需 | — |
| assignee | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"subject": {
"type": "string",
"maxLength": 160
},
"message": {
"type": "string",
"maxLength": 6000
},
"requestId": {
"type": "string",
"maxLength": 100
},
"category": {
"type": "string",
"enum": [
"account",
"configuration",
"usage",
"incident",
"other"
]
},
"priority": {
"type": "string",
"enum": [
"high",
"normal",
"low"
]
},
"attachments": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"data": {
"type": "string",
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
],
"additionalProperties": true
},
"description": "提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。"
},
"tenantId": {
"type": "string"
},
"assignee": {
"type": "string"
}
},
"required": [
"tenantId",
"subject",
"message",
"requestId"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.tickets.create \
--body @request.json先运行 cpq operations describe platform.console.tickets.create 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/tickets/{id}读取平台工单详情与消息读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
CLI 调用
cpq call platform.console.tickets.get \
--path '{"id": "实际id"}'先运行 cpq operations describe platform.console.tickets.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/tickets/{id}回复、分派、内部备注及工单状态调整写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| message | string | 可选 | — |
| attachments | array | 可选 | 提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。 |
| state | string · open / in_progress / waiting_customer / resolved / closed | 可选 | — |
| assignee | string | 可选 | — |
| priority | string · high / normal / low | 可选 | — |
| visibility | string · public / internal | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"data": {
"type": "string",
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
],
"additionalProperties": true
},
"description": "提供 name 文件名和 data 的 base64 内容;单个附件最多 2 MiB。支持 PDF、PNG、JPG、TXT、LOG、CSV;文本须为 UTF-8。"
},
"state": {
"type": "string",
"enum": [
"open",
"in_progress",
"waiting_customer",
"resolved",
"closed"
]
},
"assignee": {
"type": "string"
},
"priority": {
"type": "string",
"enum": [
"high",
"normal",
"low"
]
},
"visibility": {
"type": "string",
"enum": [
"public",
"internal"
]
}
},
"required": [
"version"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.tickets.update \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.tickets.update 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/tickets/{id}/files/{fileId}下载获准工单附件读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| fileId | path | string | 必需 | — |
CLI 调用
cpq call platform.console.tickets.download \
--path '{"id": "实际id", "fileId": "实际fileId"}'先运行 cpq operations describe platform.console.tickets.download 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/plans套餐版本与预约调整记录读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| page | query | integer | 按需 | — |
| pageSize | query | integer | 按需 | — |
CLI 调用
cpq call platform.console.plans.get先运行 cpq operations describe platform.console.plans.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/plans发布新套餐额度版本写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| plan | string | 必需 | — |
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| limits | object | 必需 | — |
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"plan": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"limits": {
"type": "object",
"additionalProperties": true
},
"reason": {
"type": "string"
}
},
"required": [
"plan",
"version",
"limits",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.plans.publish \
--body @request.json先运行 cpq operations describe platform.console.plans.publish 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/schedules/{id}/cancel取消尚未执行的套餐调整预约写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"required": [
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.schedule-cancel \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.schedule-cancel 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/template-preflight模板导入只读预检与差异读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| id | string | 可选 | — |
| text | string | 可选 | — |
| content | object | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"content": {
"type": "object",
"additionalProperties": true
}
},
"required": [],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.template-preflight \
--body @request.json先运行 cpq operations describe platform.console.template-preflight 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/platform/console/templates/{id}/history行业模板历史版本与差异读取 / 计算
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| page | query | integer | 按需 | — |
| version | query | integer | 按需 | — |
| compare | query | integer | 按需 | 对比的历史版本;默认选择所选版本的上一版,最低为 1。 |
CLI 调用
cpq call platform.console.template-history \
--path '{"id": "实际id"}'先运行 cpq operations describe platform.console.template-history 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/platform/console/templates/{id}/trial将指定模板版本试开通为独立演示企业写操作
平台运营会话;各操作另校验 admin、ops、support、billing、auditor 等角色。企业域名不提供平台 API。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| id | path | string | 必需 | — |
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 读取响应中的当前版本,首次运营档案可为 0。 |
| requestId | string | 必需 | — |
| reason | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"description": "读取响应中的当前版本,首次运营档案可为 0。"
},
"requestId": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"version",
"requestId",
"reason"
],
"additionalProperties": true
}
CLI 调用
cpq call platform.console.template-trial \
--path '{"id": "实际id"}' \
--body @request.json先运行 cpq operations describe platform.console.template-trial 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
数据与系统管理 7
GET/api/users账号权限与版本读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call users.get先运行 cpq operations describe users.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/users维护本机账号或企业业务权限写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| users | array | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"users": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"required": [
"version",
"users"
],
"additionalProperties": true
}
CLI 调用
cpq call users.save \
--body @request.json先运行 cpq operations describe users.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/table/preview解析 CSV/XLSX 上传内容读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| filename | string | 必需 | — |
| content | string | 必需 | — |
| sheet | string | 可选 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
},
"sheet": {
"type": "string"
}
},
"required": [
"filename",
"content"
],
"additionalProperties": true
}
CLI 调用
cpq call table.preview \
--body @request.json先运行 cpq operations describe table.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/import/preview暂存工作簿导入预检写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| filename | string | 必需 | — |
| content | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"filename",
"content"
],
"additionalProperties": true
}
CLI 调用
cpq call import.preview \
--body @request.json先运行 cpq operations describe import.preview 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/import/commit提交已暂存的工作簿导入写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| token | string | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": true
}
CLI 调用
cpq call import.commit \
--body @request.json先运行 cpq operations describe import.commit 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
GET/api/manage/publishing读取publishing读取 / 计算
业务管理员入口;继续执行版本、产品线及领域校验。
未登记固定路径、查询或请求头参数。
CLI 调用
cpq call manage.publishing.get先运行 cpq operations describe manage.publishing.get 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。
POST/api/manage/publishing保存publishing写操作
业务管理员入口;继续执行版本、产品线及领域校验。
| 参数 | 位置 | 类型 | 要求 | 说明 |
|---|---|---|---|---|
| X-CPQ-CSRF | header | string | 按需 | SaaS 会话写请求必需,从会话读取接口取得;CLI/MCP 自动携带。网关凭据回执不适用。 |
JSON 请求体
| 字段 | 类型 / 取值 | 要求 | 说明 |
|---|---|---|---|
| version | integer | 必需 | 最近一次读取或保存返回的版本;不要自行递增。 |
| data | object | 必需 | — |
查看完整请求 Schema
{
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1,
"description": "最近一次读取或保存返回的版本;不要自行递增。"
},
"data": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"version",
"data"
],
"additionalProperties": true
}
CLI 调用
cpq call manage.publishing.save \
--body @request.json先运行 cpq operations describe manage.publishing.save 核对契约。替换示例标识;POST 的 request.json 需按业务契约准备。
成功响应:业务 JSON 或原始文件。错误与认证遵循共同约定;保存与发布使用最新版本。