修改任务忽略文件 - UpdateIgnoreFiles
功能介绍
修改任务忽略文件。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v4/task/{task_id}/ignore-files
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过128。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
nodes |
否 |
Array of UpdateIgnoreFilesRepoTreeNode objects |
参数解释: 需要更新忽略状态的文件树的节点的列表。 约束限制： 不涉及。 取值范围: 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数解释: 节点名。 约束限制： 不涉及。 取值范围: 不涉及。 默认取值： 不涉及。 |
|
file_path |
否 |
String |
参数解释: 文件路径。 约束限制： 不涉及。 取值范围: 不涉及。 默认取值： 不涉及。 |
|
is_leaf |
否 |
Boolean |
参数解释: 是否为叶子节点。 约束限制： 不涉及。 取值范围: 不涉及。 默认取值： 不涉及。 |
|
checkbox_status |
否 |
String |
参数解释: 复选框勾选状态，unchecked为未勾选，all为勾选。 约束限制： 不涉及。 取值范围:
默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
String |
参数解释： 更新成功时返回"更新忽略文件成功"。 取值范围： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
修改任务id为10155df661744d1f98f0055f1236702d的任务的忽略文件配置，路径为CppDemo/CppDemoView.h的文件设置为未勾选（即不忽略），路径为CppDemo/KnightMath的文件夹设置为勾选（即忽略）。
PUT https://{endpoint}/v4/task/10155df661744d1f98f0055f1236702d/ignore-files
{
"nodes" : [ {
"file_path" : "CppDemo/CppDemoView.h",
"name" : "CppDemoView.h",
"is_leaf" : true,
"checkbox_status" : "unchecked"
}, {
"file_path" : "CppDemo/KnightMath",
"name" : "KnightMath",
"is_leaf" : false,
"checkbox_status" : "all"
} ]
}
响应示例
状态码：200
Request succeeded!
{
"result" : "更新忽略文件成功"
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
