ListQualityCheckScheme - 获取质检方案列表

更新时间:
复制 MD 格式

获取质检方案列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sca:ListQualityCheckScheme

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

JsonStr

string

是

完整 JSON 字符串信息,具体内容参见以下详细信息。

{ "name": "质检方案A" }

BaseMeAgentId

integer

否

业务空间 Id

123456

属性值类型是否必须描述默认值示例
schemeIdLong否质检方案 ID123
nameString否质检方案名称质检方案 A
typeInteger否质检方案类型,可能值:0(系统内置);1(用户自定义 )1
dataTypeInteger否质检方案数据类型:0(文本),1(音频)1
statusInteger否状态,可能值:0(已删除),1(已发布),2(未发布),3(已更新未发布)1
requireInfosList否控制质检方案字段可选择性返回,RuleDetailInfo:对应 ruleList 字段。CheckTypeListInfo:对应 schemeCheckTypeList 字段。["CheckTypeListInfo","RuleDetailInfo"]{"jsonStr": "{"pageNumber": 1, "pageSize": 1, "requireInfos": ["CheckTypeListInfo"]}"}
pageNumberInteger否当前页数11
pageSizeInteger否每页显示条数1010

返回参数

名称

类型

描述

示例值

object

返回数据

RequestId

string

请求 ID。

82C91484-B2D5-4D2A-A21F-A6D73F4***

Success

boolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null表示失败。

true

ResultCountId

string

内部字段,请忽略。

废弃字段

Code

string

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200

Message

string

出错时表示出错详情,成功时为 successful。

successful

PageNumber

integer

当前页数。

1

PageSize

integer

每页显示条数。

10

Count

integer

总条数。

22

Data

array<object>

质检方案列表数据

array<object>

质检方案详情

SchemeId

integer

质检方案 ID。

112**

Name

string

质检方案名称

test

Description

string

描述信息。

售前使用

DataType

integer

质检方案的数据类型,可能值:0 文本;1 音频。

1

Type

integer

质检方案类型,可能值:0 系统内置;1 自定义创建。

1

TemplateType

integer

质检方案模板的类型,可能值:1 系统内置;2 自定义创建。

1

Status

integer

质检方案的状态,可能值:0 已删除;1 已发布;2 未发布;3 已更新未发布。

1

CreateUserName

string

创建者名字

张三

CreateTime

string

创建时间

2022-05-10T09:34Z

UpdateUserName

string

更新者名字

李四

UpdateTime

string

更新时间

2022-05-10T10:34Z

SchemeCheckTypeList

array<object>

质检维度列表

object

质检维度

CheckType

integer

质检维度 type

1

Enable

integer

启用状态,可能值:0(禁用);1(启用)。

1

CheckName

string

质检维度名称。

服务规范性检测

TargetType

integer

内置字段,请忽略。

10

Score

integer

质检维度分数。

20

RuleList

array<object>

检测项列表。

array<object>

命中规则信息。

Rules

array<object>

规则信息:这里只有一条,预留扩展

object

规则基本信息

Rid

integer

检测项 ID

12

Name

string

检测项名称

测试规则

RuleScoreType

integer

是否计分,可能值:1(不计分);3(计分)

1

ScoreNum

integer

分数

2

ScoreType

integer

加减分,可能值:1(加分);3(减分)

1

CheckType

integer

所属质检维度。

1

TargetType

integer

检测项应用场景,可能值:10(普通检测项);11(SOP 流程检测项)

10

ScoreNumType

integer

计分类型,可能值:0(触发规则后加减分);1(触发规则后一次性得分)

0

Version

integer

质检方案版本

1

示例

正常返回示例

JSON格式

{
  "RequestId": "82C91484-B2D5-4D2A-A21F-A6D73F4***\t",
  "Success": true,
  "ResultCountId": "废弃字段",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "Count": 22,
  "Data": [
    {
      "SchemeId": 0,
      "Name": "test",
      "Description": "售前使用",
      "DataType": 1,
      "Type": 1,
      "TemplateType": 1,
      "Status": 1,
      "CreateUserName": "张三",
      "CreateTime": "2022-05-10T09:34Z",
      "UpdateUserName": "李四",
      "UpdateTime": "2022-05-10T10:34Z",
      "SchemeCheckTypeList": [
        {
          "CheckType": 1,
          "Enable": 1,
          "CheckName": "服务规范性检测",
          "TargetType": 10,
          "Score": 20
        }
      ],
      "RuleList": [
        {
          "Rules": [
            {
              "Rid": 12,
              "Name": "测试规则",
              "RuleScoreType": 1,
              "ScoreNum": 2,
              "ScoreType": 1,
              "CheckType": 1,
              "TargetType": 10,
              "ScoreNumType": 0
            }
          ]
        }
      ],
      "Version": 1
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。