https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/index.html Recent content in 1. APIリファレンス概要 on JP1 Cloud Service 運用統合 APIリファレンス Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_pre/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_pre/index.html APIを実行するために事前にAPI認証作業を行う必要があります。 （1）Ops Iトークンの取得 Pre-Installedロール「System Security Administrator」を付与されているシステム管理者が、任意のユーザーに対して、Ops Iトークンを発行することができます。Ops Iトークンに有効期限はありません。 Ops Iトークンを取得するには、システム管理画面のナビゲーションエリアで、ユーザー管理の配下にあるユーザーを選択します。コンフィグレーションエリアのユーザー名をクリックすると、ユーザー詳細画面が表示されるので、関連するリソースエリアのトークンタブにある[トークン発行]ボタンをクリックします。ダイアログに発行されたOps Iトークンが表示されるので、システム管理者はメモなどで保存してください。発行されたOps Iトークンは別の画面に遷移すると確認することができなくなります。 Ops Iトークンの取得状況は、トークンタブから確認することができます。Ops Iトークンを発行済みのユーザーの場合は、トークンタブにトークン発行日時が表示されます。 また、Ops Iトークンを発行済みのユーザーの場合は、トークンタブに[トークン破棄]ボタンが表示されます。Ops Iトークンが不要になった場合、システム管理者は[トークン破棄]ボタンをクリックし、表示された「トークンの破棄」ダイアログで[OK]ボタンをクリックすることで、Ops Iトークンを破棄することができます。 （2）Ops Iトークンの提供・設定 システム管理者は取得したOps Iトークンを、APIを実行するユーザーにメールなどで提供します。 APIを実行するユーザーは、Ops Iトークンをヘッダーとして設定することで、APIを実行することができます。 また、「Ops Iアクセストークンの取得（非推奨）」で取得したOps Iアクセストークンをヘッダーとして設定し、APIを実行することも可能です。（非推奨） ＜実行例＞ Ops Iトークンをヘッダーとして設定する場合 # curl -XGET "Ops IのURL/api/v1/gitops-logs" ¥ -H "X-OpsI-Token: Ops Iトークン" ＜実行例＞ Ops Iアクセストークンをヘッダーとして設定する場合 # curl -XGET "Ops IのURL/api/v1/gitops-logs" ¥ -H "Authorization: Bearer Ops Iアクセストークン" （3）Ops Iアクセストークンの取得（非推奨） APIを実行するユーザーは、API「refresh-token」により、Ops Iアクセストークンを取得できます。その際、「Ops Iトークンの提供・設定」で提供されたOps Iトークンをヘッダーとして設定する必要があります。Ops Iアクセストークンの有効期限は30分です。実行例を以下に示します。 ＜実行例＞ /oauth2/refresh-token # curl -XPOST "Ops IのURL/oauth2/refresh-token" ¥ https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_usecase/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_usecase/index.html Ops IのAPIを使用してどのような使い方ができるのか、具体的なユースケースとその作業の流れにより説明します。 （1）ワークフローの特定のステップに対応するアクティビティの担当者を変更する 以下に作業の流れを示します。 （表）「ワークフローの特定のステップに対応するアクティビティの担当者を変更する」の流れ # 項目 1 ワークフローのコンテキストIDを取得する 2 ワークフローの詳細情報を取得する 3 スケジュールの情報を取得する 4 スケジュールの情報からワークフローの担当者を変更する 上記手順の詳細、実行例については「ワークフローの特定のステップに対応するアクティビティの担当者を変更する」を参照してください。 （2）ロールにカスタムACLを割り当てる、割り当てを解除する 以下に作業の流れを示します。 （表）「ロールにカスタムACLを割り当てる、割り当てを解除する」の流れ # 項目 1 ACLの一覧を取得する 2 ACLの詳細情報を取得する 3 ロールにACLを割り当てる 4 ロールに割り当てられたACLを取得する 5 ロールに割り当てられたACLを解除する 上記手順の詳細、実行例については「ロールにカスタムACLを割り当てる、割り当てを解除する」を参照してください。 （3）YAMLファイル（manifest.yaml）登録用のリポジトリを削除する 以下に作業の流れを示します。 （表）「YAMLファイル（manifest.yaml）登録用のリポジトリを削除する」の流れ # 項目 1 リポジトリ一覧を取得する 2 リポジトリを削除する 上記手順の詳細、実行例については「YAMLファイル（manifest.yaml）登録用のリポジトリを削除する」を参照してください。 リポジトリの作成はOps Iのリポジトリ管理で行います。詳細については「JP1 Cloud Service 運用統合 利用ガイド」の「機能＞システム＞リポジトリ管理」を参照してください。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/example/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/example/index.html 「APIを使うユースケースと作業の流れ」で説明した各ユースケースの流れに対する使用するAPIを具体的にあげて詳細を説明します。 API実行時にリクエストボディが必要な場合、実行例ではjsonファイルを参照させる形式としています。リクエストボディの詳細については、「APIリファレンス詳細」を参照してください。 節構成 1.3.1 ワークフローの特定のステップに対応するアクティビティの担当者を変更する 1.3.2 ロールにカスタムACLを割り当てる、割り当てを解除する 1.3.3 YAMLファイル（manifest.yaml）登録用のリポジトリを削除する https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_list/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/api_list/index.html 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 YAMLファイルの一覧を取得する （アップロードしたYAMLファイルの情報を取得します） GET /api/v1/documents/{id} YAMLファイルの詳細情報を取得する GET /api/v1/documents/{id}/files YAMLファイルのあるリポジトリにあるファイルを取得する。 （ScriptのYAMLファイル内で定義しているクライアントスクリプト（JavaScript）のファイルをダウンロードするのに使用します） graphql POST /api/v1/graphql GraphQL のクエリを実行する。 （データの取得、挿入、更新、削除はすべてクエリを送信して実行されるためPOSTのみです） 注意事項 アプリケーションやUIでのバリデーションを無視して直接DBに作用するため利用には注意が必要です。 repositories POST /api/v1/repositories GitLabにリポジトリを作成する。 必要なWebhookの設定なども実施されるので、GitLab画面上でのリポジトリ作成はしないでください。 また、この作成によりsystem-configsが更新され、YAMLファイルのアップロードが反映されるようになります。 GET /api/v1/repositories リポジトリ一覧を取得する DELETE /api/v1/repositories/{id} リポジトリを削除する practice-contexts GET /api/v1/practice-contexts コンテキストの一覧を取得する https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/mcpserver/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/mcpserver/index.html Ops IではMCPサーバーを公開しています。 AIエージェントはMCPサーバーへ接続することで、ユーザーの代わりにOps Iの操作を行うことができます。 AIエージェントは、用途別に分かれたエンドポイント（URL）を経由してMCPサーバーに接続でき、そのエンドポイントに属するツールを実行できます。 また、MCPサーバーへの接続、利用には認証が必要です。ユーザーに適切な権限を付与し、Ops Iトークンを発行した上で、接続設定を行ってください。 この章ではエンドポイントと必要な権限、ツールについて説明します。ユースケースや設定例については「JP1 Cloud Service 運用統合 利用ガイド」の「お客様での運用設計・構築＞AIエージェントとの連携」および「お客様での運用設計・構築＞AIエージェントとの連携＞AIエージェントとの連携例」を参照してください。 （1） エンドポイント AIエージェントからMCPサーバーにはStreamable HTTP方式で接続します。 MCPサーバーへの接続、利用にはエンドポイントごとに認証が必要です。通信時にX-Ops I TokenヘッダーでOps Iトークンを指定する必要があります。 エンドポイントと、エンドポイントを利用するために必要な権限について説明します。 （表）エンドポイントと必要な権限 エンドポイント 必要な権限（Primitiveロール） 説明 /ai/v1/itsm/mcp 以下のいずれか itsm_adminitsm_manageritsm_user ツール「extract_symptoms_from_ticket」または「generate_knowledge_article_from_ticket」を利用する場合 ai_extension_user チケット・ナレッジ記事の操作 /ai/v1/manual/mcp なし 定義ファイルに関するドキュメントの取得 （2）ツール一覧 エンドポイントごとに利用できるツールを以下に示します。 （表）ツール一覧 ツール名 説明 エンドポイント：/ai/v1/itsm/mcp search_tickets_by_symptoms 現象からインシデントチケットまたは問い合わせチケットを検索する extract_symptoms_from_ticket インシデントチケットまたは問い合わせチケットのIDから現象を抽出する get_ticket_by_id チケットIDからインシデントチケットまたは問い合わせチケットの情報を取得する get_work_notes インシデントチケットまたは問い合わせチケットのチケットIDから作業メモを取得する generate_knowledge_article_from_ticket インシデントチケットまたは問い合わせチケットの内容をナレッジ記事のフォーマットにまとめて返却する メモ 返却されたナレッジ記事はOps Iには保存されていません。 search_knowledge_articles_by_symptoms 現象からナレッジ記事を検索する create_incident インシデントチケットを作成する update_incident インシデントチケットを更新する create_work_note インシデントチケットまたは問い合わせチケットの作業メモを投稿する get_tickets チケットの一覧を取得する エンドポイント：/ai/v1/manual/mcp get_opsi_manifest_doc​ YAMLファイルの共通仕様や以下の種別の定義情報を取得する workflowuiuipathdatamodelcatalogscriptlibraryattachmentdistributionaclstatementnotificationnotifierapplicationメモ ui、scriptのUIバージョン1.0の定義については対応していません。 get_custom_script_doc​ Ops Iのカスタムスクリプトに関する定義情報を取得する get_playbook_doc​ Playbookの実行環境の情報を取得する 「現象」については「JP1 Cloud Service 運用統合 利用ガイド」の「機能＞基本的な画面構成＞AI拡張機能」を参照してください。 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/errorinfo/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/apireference/errorinfo/index.html APIの実行がエラーになった場合、「（表）APIが返却するステータスコード」に記載されているレスポンスが返却されます。発生するエラーによっては、記載されていないレスポンス形式（例：HTML）やレスポンスの内容が返されることがあります。記載されていないレスポンスが返された場合は、ステータスコードやメッセージの内容を参考に、リクエストを見直してください。 （表）API が返却するステータスコード ステータスコード 説明 400 リクエストボディのJSON構文が不適切な場合 リクエストボディが求められているオブジェクトと異なる場合 リクエストボディに指定された値に誤りがある場合 401 Ops Iトークンが不正な値の場合 403 ユーザーにAPIを実行可能な権限が割り当てられていない場合 APIのパスの指定が間違っている場合 404 指定したオブジェクトが存在しない場合 上記以外 API ごとに異なるため「標準提供API」または「カスタムAPI」を参照してください。