获取规则的基本信息。
目前该API接口已标记为弃用,推荐使用替代API:Qualitycheck(2019-01-15) - GetRuleV4。
接口说明
该接口返回的规则 id 和 name 等基本信息,可以和 获取规则详情 配合使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sca:GetRule |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JsonStr |
string |
是 |
完整 JSON 字符串信息,具体内容参见以下详细信息。 |
{"ruleIds":"123"} |
| BaseMeAgentId |
integer |
否 |
业务空间 Id |
请求参数 Json 字符串信息
| 属性 | 值类型 | 是否必须 | 说明 |
| ruleIds | List<String> | 否 | 规则标识 ID,多个 ID 以逗号分隔。 |
| businessCategoryName | List<String> | 否 | 所属业务分类名称 |
| status | Integer | 否 | 状态,可选值:0:待生效,1:生效中,2:已失效,3:全部。默认值为 1。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。 |
200 |
| Message |
string |
出错时表示出错详情,成功时为 successful。 |
successful |
| RequestId |
string |
请求 ID |
F190ADE9-619A-447D-84E3-7E241A5C428E |
| Success |
boolean |
请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null表示失败。 |
true |
| Data |
object |
返回结果 |
|
| Rules |
object |
||
| RuleInfo |
array<object> |
分析结果信息列表 |
|
|
array<object> |
规则列表。 |
||
| Status |
integer |
状态,可能值:0:待生效,1:生效中,2:已失效。 |
1 |
| Type |
integer |
【已废弃】规则类型 |
1 |
| ScoreSubId |
integer |
评分小项 id。 |
22 |
| IsOnline |
integer |
【已废弃】是否已经上线,0:未上线;1:已上线。目前值固定为 1. |
1 |
| CreateTime |
string |
创建时间 |
2016-08-05 10:37:10 |
| CreateEmpid |
string |
规则创建者 ID |
123 |
| LastUpdateEmpid |
string |
最近更新的用户 ID |
123 |
| IsDelete |
integer |
是否删除,可能值:0:未删除,1:已删除。 |
0 |
| Rid |
string |
规则 ID |
4 |
| RuleScoreType |
integer |
是否计分,可能值:1:不计分,3:计分。 |
1 |
| EndTime |
string |
到期时间 |
2016-08-05 10:37:10 |
| Weight |
string |
【已废弃】规则权重 |
1 |
| StartTime |
string |
开始时间 |
2016-08-05 10:37:10 |
| RuleLambda |
string |
【已废弃】规则条件间关系 |
a && b |
| ScoreSubName |
string |
评分子项名称,当 |
评分子项 |
| AutoReview |
integer |
审核选项,可能值:1:不自动审核,3:自动审核。 |
1 |
| Comments |
string |
备注 |
测试规则 |
| LastUpdateTime |
string |
最近更新时间 |
2019-10-28 14:23:28 |
| ScoreName |
string |
评分大项名称,当 |
评分大项 |
| Name |
string |
规则名称 |
demo |
| ScoreId |
integer |
评分大项 ID。 |
123 |
| BusinessCategoryNameList |
object |
||
| BusinessCategoryNameList |
array |
所属业务分类列表 |
|
|
string |
所属业务分类列表 |
["业务A","业务B"] |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "F190ADE9-619A-447D-84E3-7E241A5C428E",
"Success": true,
"Data": {
"Rules": {
"RuleInfo": [
{
"Status": 1,
"Type": 1,
"ScoreSubId": 22,
"IsOnline": 1,
"CreateTime": "2016-08-05 10:37:10",
"CreateEmpid": "123",
"LastUpdateEmpid": "123",
"IsDelete": 0,
"Rid": "4",
"RuleScoreType": 1,
"EndTime": "2016-08-05 10:37:10",
"Weight": "1",
"StartTime": "2016-08-05 10:37:10",
"RuleLambda": "a && b",
"ScoreSubName": "评分子项",
"AutoReview": 1,
"Comments": "测试规则",
"LastUpdateTime": "2019-10-28 14:23:28",
"ScoreName": "评分大项",
"Name": "demo",
"ScoreId": 123,
"BusinessCategoryNameList": {
"BusinessCategoryNameList": [
"[\"业务A\",\"业务B\"]"
]
}
}
]
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。