2.17. robot
ユーザーおよび組織のロボットアカウントを管理します。
2.17.1. getUserRobots
ユーザーが利用可能なロボットをリスト表示します。
GET /api/v1/user/robots
承認: oauth2_implicit(user:admin)
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
limit | これが指定されている場合には、返すべきロボットの数。 | integer |
| query |
token | False の場合には、ロボットのトークンは返されません。 | boolean |
| query |
permissions | ロボットのパーミッションがあるリポジトリーおよびチームを含めるかどうか。 | boolean |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.2. getOrgRobotPermissions
組織のロボットのリポジトリーパーミッションリストを返します。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}/permissions
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.3. regenerateOrgRobotToken
組織のロボットのトークンを再生成します。
POST /api/v1/organization/{orgname}/robots/{robot_shortname}/regenerate
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.4. getUserRobotPermissions
ユーザーのロボットのリポジトリーパーミッションリストを返します。
GET /api/v1/user/robots/{robot_shortname}/permissions
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.5. regenerateUserRobotToken
ユーザーのロボットのトークンを再生成します。
POST /api/v1/user/robots/{robot_shortname}/regenerate
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.6. getOrgRobot
指定された名前の組織のロボットを返します。
GET /api/v1/organization/{orgname}/robots/{robot_shortname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.7. createOrgRobot
組織に新しいロボットを作成します。
PUT /api/v1/organization/{orgname}/robots/{robot_shortname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
| path |
orgname | 組織の名前 | string |
要求の body スキーマ (application/json)
ロボット作成のデータ (任意)
| 名前 | 説明 | スキーマ |
|---|---|---|
|
description | ロボットのテキスト形式の説明 (任意) | string |
|
unstructured_metadata | ロボットの非構造化メタデータ (任意) | object |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.8. deleteOrgRobot
既存の組織ロボットを削除します。
DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
| path |
orgname | 組織の名前 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.9. getOrgRobots
組織のロボットをリスト表示します。
GET /api/v1/organization/{orgname}/robots
承認: oauth2_implicit(org:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
orgname | 組織の名前 | string |
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
limit | これが指定されている場合には、返すべきロボットの数。 | integer |
| query |
token | False の場合には、ロボットのトークンは返されません。 | boolean |
| query |
permissions | ロボットのパーミッションがあるリポジトリーおよびチームを含めるかどうか。 | boolean |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.10. getUserRobot
指定の名前のユーザーのロボットを返します。
GET /api/v1/user/robots/{robot_shortname}
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.11. createUserRobot
指定の名前で新たなユーザーロボットを作成します。
PUT /api/v1/user/robots/{robot_shortname}
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
要求の body スキーマ (application/json)
ロボット作成のデータ (任意)
| 名前 | 説明 | スキーマ |
|---|---|---|
|
description | ロボットのテキスト形式の説明 (任意) | string |
|
unstructured_metadata | ロボットの非構造化メタデータ (任意) | object |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.17.12. deleteUserRobot
既存のロボットを削除します。
DELETE /api/v1/user/robots/{robot_shortname}
承認: oauth2_implicit(user:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
robot_shortname | ユーザーまたは組織の接頭辞を含まない、ロボットの省略名 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
