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