https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/index.html Recent content in APIリファレンス Home on JP1 Cloud Service 運用統合 APIリファレンス Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/introduction/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/introduction/index.html 本書はJP1 Cloud Service/Operations IntegrationのAPIの利用方法について説明するものです。 ■ 対象製品 JP1 Cloud Service/Operations Integration 02-90 ■ 輸出時の注意 本製品を輸出される場合には、外国為替および外国貿易法の規制ならびに米国の輸出管理規制など外国の輸出関連法規をご確認のうえ、必要な手続きをお取りください。 なお、不明な場合は、弊社担当営業にお問い合わせください。 ■ 商標類 記載の会社名、製品名などは、それぞれの会社の商標または登録商標です。 ■ マニュアルの体系 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 02-90 RHEL Red Hat(R) Enterprise Linux(R) Windows Server Microsoft(R) Windows Server(R) 2025 Standard https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/history/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/history/index.html 変更内容（JCSM72-0290-01） JP1 Cloud Service/Operations Integration 02-90 追加・変更内容 変更箇所 お客様のAIエージェントと連携することで、チケットの操作やOps Iの定義の作成・編集を効率的に行うことができるようにしました。 1.5 標準提供API（v1）の「GET /api/v1/gitops-logs」にクエリパラメータfilterBy、sortByを追加しました。 2.1.1 標準提供API（v1）の「GET /api/v1/practice-contexts」のクエリパラメータpageSizeの上限を10,000に変更しました。 標準提供API（v1）の「GET /api/v1/users」のクエリパラメータpageSizeの上限を1,000に変更しました。 カスタムAPIの「GET /capi/v1/tickets」のクエリパラメータpageSizeの上限を10,000に変更しました。 2.1.1、2.2 API「GET /api/v1/import-jobs」に、フィルタ、ソート、ページング機能を追加しました。 1.4、2.1.1 API「GET /api/v1​/practice-contexts​/{id}​」のレスポンスにparamsを追加しました。 この変更により、ワークフロー実行時に指定したパラメータを参照できます。 2.1.1 dtos.ContextDTOにparamsを追加しました。 2.1.1 dtos.CategoriesDTOにcustomersとgroupsを追加しました。 2.1.1 API「GET /api/v1/service-catalogs」のレスポンスで、以下を参照できるようにしました。 実行時に指定したパラメータ アクセスを許可するグループ アクセスを許可する顧客 2.1.1 標準提供API（v1）に「PATCH /api/v1/practice-contexts/{id}」を追加しました。 1.4、2.1.1 「GET /api/v1/practice-contexts」と「GET /api/v1/practice-contexts/{id}」で、以下のプロパティを取得できるようにしました。 description category dueDate note1 note2 note3 この変更により、ワークフロー一覧に追加で表示したカラムの情報を取得できるようになりました。 2.1.1 カスタムAPIに「DELETE /capi/v1/tickets」を追加しました。 1.4、2.2 標準提供API（v1）に「DELETE /api/v1/practice-contexts」を追加しました。 1.4、2.1.1 API「GET /api/v1/users」と「GET /api/v1/users/{id}」でユーザーが所属する「顧客」を取得できるようにしました。 また、API「GET /api/v1/users」では「顧客」名でフィルタやソートが行えるようにしました。 2.1.1 Ops Iの提供するAPIに標準提供API（v2）を追加し、以下の項目に関するAPIを追加しました。この変更により、以下の項目に関する情報の取得や更新、関連リソースの取得や更新をAPIで行えるようになりました。 ユーザー グループ ロール 1.4、2.1.2 API「POST /api/v1/graphql」でデータの取得を行う際に、一度に取得するレコード数を指定するlimitパラメータと取得するレコードの開始位置を指定するoffsetパラメータを指定できるようにしました。この変更により、データの取得を分割して行えるようになりました。 2. https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/table-of-contents/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/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 YAMLファイル（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/JCSM72029001/apireference/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/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/JCSM72029001/detail/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/detail/index.html APIリファレンス詳細では各APIの詳細を説明します。 APIは以下に分けて掲載しています。 標準提供API： ユーザー、グループ管理やYAMLファイルの登録状況確認などに使用します。 APIのカスタムはできません。 カスタムAPI： チケット管理に使用します。 チケット画面のカスタムをする際はAPIもあわせてカスタムする必要があります。 注意事項 リクエストボディおよびレスポンスの説明に「（Reserved Field）」と記載があるフィールドは予約フィールドです。 レスポンスに含まれる予約フィールドの値は参照しないでください。 POSTメソッドのリクエストボディの予約フィールドには、フィールドの説明に記載された値を設定してください。 PUTメソッドのリクエストボディには、GETメソッドを実行して取得したレスポンスボディに対して、APIの説明に記載のある更新がサポートされているフィールドだけ変更して設定してください。 章構成 2.1 標準提供API 2.2 カスタムAPI https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/appendix/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM72029001/appendix/index.html 以下の項目について説明します。 章構成 3.1 各バージョンの変更内容