https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/index.html Recent content in APIリファレンス Home on JP1 Cloud Service 運用統合 APIリファレンス Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/introduction/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/introduction/index.html 本書はJP1 Cloud Service/Operations IntegrationのAPIの利用方法について説明するものです。 ■ 対象製品 JP1 Cloud Service/Operations Integration 03-00 ■ 輸出時の注意 本製品を輸出される場合には、外国為替および外国貿易法の規制ならびに米国の輸出管理規制など外国の輸出関連法規をご確認のうえ、必要な手続きをお取りください。 なお、不明な場合は、弊社担当営業にお問い合わせください。 ■ 商標類 記載の会社名、製品名などは、それぞれの会社の商標または登録商標です。 ■ マニュアルの体系 Ops Iのマニュアルは、本書を含めて3冊のドキュメントから構成されています。 本書では、Ops IのAPIの利用方法について説明しています。 JP1 Cloud Service 運用統合 利用ガイド JP1 Cloud Service 運用統合 利用ガイド（ITSM操作編） JP1 Cloud Service 運用統合 APIリファレンス ＜本書＞ ■ このマニュアルでの表記 このマニュアルでは、名称を省略して表記しています。このマニュアルでの表記を次に示します。 略称 正式名称 .NET Microsoft(R) .NET Excel Microsoft(R) Excel IdP Identity Provider アイデンティティプロバイダー JP1/AJS3 JP1/Automatic Job Management System 3 JP1/IM JP1/Integrated Management 3 JP1/Integrated Management 2 JP1/Integrated Management OIDC OpenID Connect Ops I JP1 Cloud Service/Operations Integration 03-00 RHEL Red Hat(R) Enterprise Linux(R) Windows Server Microsoft(R) Windows Server(R) 2025 Standard https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/history/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/history/index.html 変更内容（JCSM72-0300-01） JP1 Cloud Service/Operations Integration 03-00 追加・変更内容 変更箇所 AIクレジットについての説明を追加しました。 1.5 MCPサーバーの「/ai/v1/itsm/mcp」エンドポイントに以下のツールを追加しました。 get_knowledge_articles get_knowledge_article_by_id 1.5 MCPサーバーの「/ai/v1/itsm/mcp」エンドポイントのPrimitiveロール「ai_extension_user」を必要とするツールとして、以下のMCPツールを追加しました。 search_tickets_by_symptoms search_knowledge_articles_by_symptoms これらのMCPツールを利用する場合、実行ユーザーにai_extension_userロールを割り当ててください。 1.5 MCPサーバーの「/ai/v1/manual/mcp」エンドポイントの「get_opsi_manifest_doc」を利用することで、以下のマニフェストの情報を取得できるようにしました。 businessLogicTrigger 1.5 以下の標準APIを追加しました。 GET /api/v1/script-logs GET /api/v1/tickets/{id}/work-notes/{work-noteID}/attachments/{attachmentID}/download POST /api/v1/notifications GET /api/v1/monthly-ai-credit-histories 以下のカスタムAPIを追加しました。 GET /capi/v1/tickets/{id}/work-notes GET /capi/v1/tickets/{id}/related-links 1.4、2.1.1、2.2 API「POST /capi/v1/tickets」のarticleフィールドが非推奨になりました。 2.2 API「GET /api/v1/groups」、API「GET /api/v2/groups/{id}」、API「GET /api/v2/users/{id}/groups」、API「GET /api/v2/roles/{id}/groups」のレスポンスに次のフィールドを追加しました。 parentId：親グループのID path：グループパス displayName：グループの表示名 displayPath：グループの表示パス depth：グループの階層数 2.1.1、2.1.2 API「GET /api/v2/groups/{id}/group-relations」のレスポンスに次のフィールドを追加しました。 path：グループパス displayName：グループの表示名 displayPath：グループの表示パス 2.1.2 API「GET /api/v1/users API」、API「GET /api/v1/users/{id}」のレスポンスであるassignedGroupsフィールドの子フィールドとして以下を追加しました。 path：グループパス displayName：グループの表示名 displayPath: グループの表示パス email: グループに割り当てられたメールアドレス description: グループの説明 2.1.1 API「PUT /api/v2/groups/{id}」のリクエストボディにparentId（親グループのID）、displayName（グループの表示名）が指定できるようになりました。これによりグループの親グループや表示名の設定をREST APIで行えるようになります。 2. https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/table-of-contents/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/table-of-contents/index.html 1. APIリファレンス概要 1.1 前提知識 1.1（1） Ops Iトークンの取得 1.1（2） Ops Iトークンの提供・設定 1.1（3） Ops Iアクセストークンの取得（非推奨） 1.2 APIを使うユースケースと作業の流れ 1.3 APIの詳細と実行例 1.3.1 ワークフローの特定のステップに対応するアクティビティの担当者を変更する 1.3.2 ロールにカスタムACLを割り当てる、割り当てを解除する 1.3.3 マニフェストファイル（manifest.yaml）登録用のリポジトリを削除する 1.4 API一覧 1.5 MCPサーバー 1.5 （1）エンドポイント 1.5 （2）ツール一覧 1.6 エラー情報 2. APIリファレンス詳細 2.1 標準提供API 2.1.1 標準提供API（v1） 2.1.2 標準提供API（v2） 2.2 カスタムAPI 3. 付録 3.1 各バージョンの変更内容 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/apireference/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/apireference/index.html Ops IではAPIを使用することで、さまざまな情報の作成・取得・削除ができます。 注意事項 APIを使用する際は、パスパラメータあるいはクエリパラメータには、「UTF-8」でURLエンコードした値を指定してください。 章構成 1.1 前提知識 1.2 APIを使うユースケースと作業の流れ 1.3 APIの詳細と実行例 1.4 API一覧 1.5 MCPサーバー 1.6 エラー情報 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/detail/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/detail/index.html APIリファレンス詳細では各APIの詳細を説明します。 APIは以下に分けて掲載しています。 標準提供API： ユーザー、グループ管理やマニフェストファイルの登録状況確認などに使用します。 APIのカスタムはできません。 カスタムAPI： チケット管理に使用します。 チケット画面のカスタムをする際はAPIもあわせてカスタムする必要があります。 注意事項 リクエストボディおよびレスポンスの説明に「（Reserved Field）」と記載があるフィールドは予約フィールドです。 レスポンスに含まれる予約フィールドの値は参照しないでください。 POSTメソッドのリクエストボディの予約フィールドには、フィールドの説明に記載された値を設定してください。 PUTメソッドのリクエストボディには、GETメソッドを実行して取得したレスポンスボディに対して、APIの説明に記載のある更新がサポートされているフィールドだけ変更して設定してください。 章構成 2.1 標準提供API 2.2 カスタムAPI https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/appendix/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72030001/appendix/index.html 以下の項目について説明します。 章構成 3.1 各バージョンの変更内容