1.4 API一覧
Ops Iで公開している以下のAPIの一覧を示します。
APIの詳細については、「APIリファレンス詳細」を参照してください。
| 分類 | メソッド | URL | 機能 |
|---|---|---|---|
| users | GET | /api/v1/users | ユーザーの一覧を取得する |
| GET | /api/v1/users/{id} | 指定したIDのユーザーの詳細情報を取得する | |
| groups | GET | /api/v1/groups | グループの一覧を取得する |
| GET | /api/v1/groups/{id} | グループの詳細情報を取得する | |
| schedules | GET | /api/v1/schedules/{id} | スケジュールの情報を取得する |
| PUT | /api/v1/schedules/{id} | スケジュールの情報を更新する （ワークフローの担当者などを更新するのに使用します） |
|
| documents | GET | /api/v1/documents | YAMLファイルの一覧を取得する （アップロードした manifest.yaml の情報を取得します） |
| GET | /api/v1/documents/{id} | YAMLファイルの詳細情報を取得する | |
| GET | /api/v1/documents/{id}/files | YAMLファイルのあるリポジトリにあるファイルを取得する。 （Kind:script のmanifest.yaml内で定義しているクライアントスクリプト（JavaScript）のファイルをダウンロードするのに使用します） |
|
| graphql | POST | /api/v1/graphql | GraphQL のクエリを実行する。 （データの取得、挿入、更新、削除はすべてクエリを送信して実行されるためPOSTのみです） 注意 アプリやUIでのバリデーションを無視して直接DBに作用するため利用には注意が必要です。 |
| repositories | POST | /api/v1/repositories | GitLabにリポジトリを作成する。 必要なWebhookの設定なども実施されるので、GitLab画面上でのリポジトリ作成はしないでください。 また、この作成によりsystem-configsが更新され、manifest.yamlのアップロードが反映されるようになります。 |
| GET | /api/v1/repositories | リポジトリ一覧を取得する | |
| DELETE | /api/v1/repositories/{id} | リポジトリを削除する | |
| practice-contexts | GET | /api/v1/practice-contexts | Practice-contextの一覧を取得する （主にクライアントスクリプトでの後続処理に必要なContextIDの取得に使用します） |
| GET | /api/v1/practice-contexts/{id} | ワークフローの詳細情報を取得する | |
| DELETE | /api/v1/practice-contexts /{id} | ワークフローとそのサブフローを削除する | |
| acls | GET | /api/v1/acls | ACLの一覧を取得する |
| GET | /api/v1/acls/{name} | ACLの詳細情報を取得する | |
| GET | /api/v1/acls/roles/{roleName} | ロールに割り当てられたACLを取得する | |
| POST | /api/v1/acls/roles/{roleName} | ロールにACLを割り当てる | |
| DELETE | /api/v1/acls/roles/{roleName} | ロールに割り当てられたACLを解除する | |
| Customer Users | GET | /api/v1/customer-users | カスタマーユーザーの一覧を取得する |
| Refresh Token | POST | /oauth2/refresh-token | Ops Iトークンを用いてOps Iアクセストークンを取得する。 （REST APIコールに実際に付与するOps Iアクセストークンを取得します。詳細は、「Ops Iアクセストークンの取得」を参照してください。） |
| gitops-logs | GET | /api/v1/gitops-logs | アップロードしたmanifest.yamlのバリデーション結果を取得する |
| 分類 | メソッド | URL | 機能 |
|---|---|---|---|
| tickets | GET | /capi/v1/tickets | チケットの一覧を取得する |
| POST | /capi/v1/tickets | チケットを作成する | |
| GET | /capi/v1/tickets/{id} | チケットの詳細情報を取得する | |
| PATCH | /capi/v1/tickets/{id} | チケットの情報の一部を更新する | |
| GET | /capi/v1/tickets/{id}/related-tickets | チケットの関連チケット情報を取得する | |
| queues | GET | /capi/v1/queues | OTOBOのキュー情報を取得する |