1.4 API一覧

Ops Iで公開している以下のAPIの一覧を示します。

• 標準提供API一覧（v1）
• 標準提供API一覧（v2）
• 標準提供API一覧（oauth2）
• カスタムAPI一覧

APIの詳細については、「APIリファレンス詳細」を参照してください。

（表）標準提供API一覧（v1）

分類	メソッド	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	マニフェストファイルの一覧を取得する。 （アップロードしたマニフェストファイルの情報を取得します）
	GET	/api/v1/documents/{id}	マニフェストファイルの詳細情報を取得する。
	GET	/api/v1/documents/{id}/files	マニフェストファイルのあるリポジトリにあるファイルを取得する。 （Scriptのマニフェストファイル内で定義しているクライアントスクリプト（JavaScript）のファイルをダウンロードするのに使用します）
graphql	POST	/api/v1/graphql	GraphQL のクエリを実行する。 （データの取得、挿入、更新、削除はすべてクエリを送信して実行されるためPOSTのみです） 注意事項 アプリケーションやUIでのバリデーションを無視して直接データベースに作用するため利用には注意が必要です。
repositories	POST	/api/v1/repositories	GitLabにリポジトリを作成する。 必要なWebhookの設定なども実施されるので、GitLab画面上でのリポジトリ作成はしないでください。 また、この作成によりsystem-configsが更新され、マニフェストファイルのアップロードが反映されるようになります。
	GET	/api/v1/repositories	リポジトリ一覧を取得する。
	DELETE	/api/v1/repositories/{id}	リポジトリを削除する。
practice-contexts	GET	/api/v1/practice-contexts	コンテキストの一覧を取得する。 （主にクライアントスクリプトでの後続処理に必要なコンテキストIDの取得に使用します）
	DELETE	/api/v1/practice-contexts	ワークフローを複数削除する。
	GET	/api/v1/practice-contexts/{id}	ワークフローの詳細情報を取得する。
	PATCH	/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	顧客ユーザーの一覧を取得する。
gitops-logs	GET	/api/v1/gitops-logs	アップロードしたマニフェストファイルのバリデーション結果を取得する。
container-items	GET	/api/v1/container-items	ドキュメントの一覧を取得する。
	POST	/api/v1/container-items/{id}/files	ドキュメントのリポジトリにファイルをアップロードする。
files	GET	/api/v1/files/{group}/{repository}/{path}	ファイルの詳細情報を取得する。
	GET	/api/v1/files/{group}/{repository}/{path}/raw	ファイルを取得する。
service-catalogs	GET	/api/v1/service-catalogs	サービス カタログの一覧を取得する。
workflows	POST	/api/v1/workflows/{id}/execute	ワークフローを起票する。
knowledge-articles	GET	/api/v1/knowledge-articles/{id}/attachments/{attachmentID}/download	ナレッジ記事の添付ファイルをダウンロードする。
tickets	GET	/api/v1/tickets/{id}/work-notes/{work-noteID}/attachments/{attachmentID}/download	チケットの作業メモの添付ファイルをダウンロードする。
import-jobs	GET	/api/v1/import-jobs	インポートのジョブ実行結果の一覧を取得する。
	POST	/api/v1/import-jobs	CSVファイルをアップロードし、インポートのジョブを開始する。
	GET	/api/v1/import-jobs/{id}	インポートのジョブ実行結果の詳細を取得する。
	DELETE	/api/v1/import-jobs/{id}	インポートのジョブ実行結果を削除する。
	GET	/api/v1/import-jobs/{id}/errors	インポートのジョブ実行結果のエラーが起きた行をCSVファイルでダウンロードする。
monthly-ai-credit-histories	GET	monthly-ai-credit-histories	AIクレジット（Ops I内のAIの使用量を表す単位）の月ごとの使用量および使用上限を取得する。
script-logs	GET	/api/v1/script-logs	サーバーサイドスクリプトで出力されたログを取得する。
notifications	POST	/api/v1/notifications	Notificationのマニフェストで設定した通知を実行する。

（表）標準提供API一覧（v2）

（表）標準提供API一覧（oauth2）

（表）カスタムAPI一覧