获取代码仓所有文件
功能介绍
获取代码仓所有文件。
调用方法
请参见如何调用API。
URI
GET /v4/tasks/{task_id}/all-files
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_path |
否 |
String |
参数解释: 构建树的目标路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认值:。 不涉及。 |
get_son |
否 |
String |
参数解释: 返回的结果是节点还是一棵树。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Array of RepoTreeNode objects |
参数解释: 代码仓文件树节点列表。 取值范围: 不涉及 |
total |
Integer |
参数解释: 缺陷数。 取值范围: 0-2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 节点名。 取值范围: 不涉及。 |
file_path |
String |
参数解释: 文件路径。 取值范围: 不涉及。 |
is_leaf |
Boolean |
参数解释: 是否为叶子节点。 取值范围: 不涉及。 |
checkbox_status |
String |
参数解释: 复选框勾选状态,unchecked半开;all权限;half空白。 取值范围: 不涉及。 |
sons |
Array of RepoTreeNode objects |
节点列表 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v4/tasks/897acf5exxx48a5013cd/all-files
响应示例
状态码:200
Request succeeded!
{ "data" : [ { "name" : ".gitignore", "file_path" : ".gitignore", "is_leaf" : "ture", "checkbox_status" : "unchecked", "son" : [ ] } ], "total" : 1 }
状态码: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 |
错误码
请参见错误码。