2.18. 机器人
管理用户和组织机器人帐户。
2.18.1. getUserRobots
列出用户可用的机器人。
GET /api/v1/user/robots
授权： oauth2_implicit (user:admin)
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
限制 | 如果指定，要返回的机器人数。 | 整数 |
| query |
令牌 | 如果为 false，则不会返回机器人的令牌。 | 布尔值 |
| query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.2. getOrgRobotPermissions
返回机构机器人的存储库权限列表。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.3. regenerateOrgRobotToken
为机构机器人重新生成令牌。
POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.4. getUserRobotPermissions
返回用户机器人的存储库权限列表。
GET /api/v1/user/robots/{robot_shortname}/permissions
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.5. regenerateUserRobotToken
为用户的机器人重新生成令牌。
POST /api/v1/user/robots/{robot_shortname}/regenerate
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 201 | 成功创建 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.6. getOrgRobot
使用指定名称返回机构的机器人。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.7. createOrgRobot
在组织中创建一个新的机器人。
PUT /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
请求正文架构(application/json)
创建机器人的可选数据
| 名称 | 描述 | 模式 |
|---|---|---|
|
description | 机器人的可选文本描述 | 字符串 |
|
unstructured_metadata | 机器人的可选非结构元数据 | 对象 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.8. deleteOrgRobot
删除现有的机构机器人。
DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | string |
| path |
OrgName | 机构名称 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.9. getOrgRobots
列出机构的机器人。
GET /api/v1/organization/{orgname}/robots
授权： oauth2_implicit (org:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
OrgName | 机构名称 | 字符串 |
查询参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| query |
限制 | 如果指定，要返回的机器人数。 | 整数 |
| query |
令牌 | 如果为 false，则不会返回机器人的令牌。 | 布尔值 |
| query |
权限 | 是否包括机器人具有权限的存储库和团队。 | 布尔值 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.10. getUserRobot
使用指定名称返回用户的机器人。
GET /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.11. createUserRobot
使用指定名称创建新用户 robot。
PUT /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
请求正文架构(application/json)
创建机器人的可选数据
| 名称 | 描述 | 模式 |
|---|---|---|
|
description | 机器人的可选文本描述 | 字符串 |
|
unstructured_metadata | 机器人的可选非结构元数据 | 对象 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功调用 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
2.18.12. deleteUserRobot
删除现有的机器人。
DELETE /api/v1/user/robots/{robot_shortname}
授权： oauth2_implicit (user:admin)
路径参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| path |
robot_shortname | 机器人的短名称，没有任何用户或机构前缀 | 字符串 |
响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 204 | 已删除 | |
| 400 | 错误请求 | |
| 401 | 需要会话 | |
| 403 | 未授权访问 | |
| 404 | 未找到 |
