2.1 API一覧
JP1/AOで使用できるAPIの一覧を次の表に示します。
API名 |
機能 |
参照先 |
---|---|---|
サービステンプレート一覧の取得 |
JP1/AOに登録されているサービステンプレートの一覧を取得します。 |
|
サービステンプレートの情報取得 |
指定したサービステンプレートの情報を取得します。 |
|
サービステンプレートの削除 |
指定したサービステンプレートを削除します。 |
|
サービステンプレートに対する操作一覧の取得 |
指定したサービステンプレートに対して実行できる操作の一覧を取得します。 |
|
サービステンプレートのインポートに必要なHTMLファイルの取得 |
指定したサービステンプレートのインポートに必要なHTMLファイルを取得します。 |
|
サービステンプレートのインポート |
指定したサービステンプレートをインポートします。 |
|
サービステンプレートのエクスポートに必要な情報の取得 |
指定したサービステンプレートのエクスポートに必要な情報を取得します。 |
|
サービステンプレートのエクスポート |
指定したサービステンプレートをエクスポートします。 |
|
サービステンプレートの詳細説明を表示するURLの取得 |
指定したサービステンプレートの詳細説明を表示するURLを取得します。 |
|
サービステンプレートを基にしたサービスの作成に必要な情報の取得 |
指定したサービステンプレートからサービスを作成する場合に必要な情報を取得します。 |
|
サービステンプレートを基にしたサービスの作成 |
指定したサービステンプレートからサービスを作成します。サービスの作成時に,プロパティを指定できます。 |
API名 |
機能 |
参照先 |
---|---|---|
サービス一覧の取得 |
JP1/AOに登録されているサービスの一覧を取得します。 |
|
サービスの情報取得 |
指定したサービスの情報を取得します。 |
|
サービスの編集 |
指定したサービスを編集します。 |
|
サービスの削除 |
指定したサービスを削除します。 |
|
サービスに対する操作一覧の取得 |
指定したサービスに対して実行できる操作の一覧を取得します。 |
|
サービス実行に必要な情報の取得 |
指定したサービスの実行操作に必要な情報を取得します。 |
|
サービスの実行 |
指定したサービスを実行します。 |
|
サービスのカウンターのリセットに必要な情報の取得 |
指定したサービスのカウンターのリセット(統計情報の初期化)に必要な情報を取得します。 |
|
サービスのカウンターのリセット |
指定したサービスのカウンターをリセット(統計情報を初期化)します。 |
|
サービスの状態を「リリース」に変更する操作に必要な情報の取得 |
指定したサービスの状態を「リリース」に変更する操作に必要な情報を取得します。 |
|
サービスの状態を「リリース」に変更 |
指定したサービスの状態を「リリース」に変更します。 |
|
サービスの状態を「メンテナンス」に変更する操作に必要な情報の取得 |
指定したサービスの状態を「メンテナンス」に変更する操作に必要な情報を取得します。 |
|
サービスの状態を「メンテナンス」に変更 |
指定したサービスの状態を「メンテナンス」に変更します。 |
|
サービスの状態を「無効」に変更する操作に必要な情報の取得 |
指定したサービスの状態を「無効」に変更する操作に必要な情報を取得します。 |
|
サービスの状態を「無効」に変更 |
指定したサービスの状態を「無効」に変更します。 |
|
サービスの詳細説明のURLを取得 |
指定したサービスの詳細説明を表示するURLを取得します。 |
|
サービスが使用するサービステンプレートのバージョン変更に必要な情報の取得 |
指定したサービスが使用するサービステンプレートのバージョン変更に必要な情報を取得します。 |
|
サービスが使用するサービステンプレートのバージョン変更 |
指定したサービスに,任意のバージョンのサービステンプレートを適用します。 |
API名 |
機能 |
参照先 |
---|---|---|
スケジュール一覧の取得 |
タスクに設定されているスケジュール一覧を取得します。 |
|
スケジュールの情報取得 |
指定したスケジュールの情報を取得します。 |
|
スケジュールに対する操作一覧の取得 |
指定したスケジュールに対して実行できる操作の一覧を取得します。 |
|
スケジュールのキャンセルに必要な情報の取得 |
指定したスケジュールをキャンセルするために必要な情報を取得します。 |
|
スケジュールのキャンセル |
指定したスケジュールをキャンセルします。 |
|
スケジュールの一時停止に必要な情報の取得 |
指定したスケジュールを一時停止するために必要な情報を取得します。 |
|
スケジュールの一時停止 |
指定したスケジュールを一時停止します。 |
|
スケジュールの再開に必要な情報の取得 |
指定したスケジュールを再開するために必要な情報を取得します。 |
|
スケジュールの再開 |
指定したスケジュールを再開します。 |
API名 |
機能 |
参照先 |
---|---|---|
タスク一覧の取得 |
タスクの一覧を取得します。 |
|
タスクの情報取得 |
指定したタスクの情報を取得します。 |
|
タスクの編集 |
指定したタスクのノートおよびTODOを編集します。 |
|
タスクの削除 |
指定したタスクを削除します。指定したタスクがデバッグタスク以外の場合は,アーカイブするためのURLを取得します。 |
|
タスク操作一覧の取得 |
指定したタスクに対して実行できる操作の一覧を取得します。 |
|
タスクの実行停止に必要な情報の取得 |
指定したタスクを実行停止するために必要な情報を取得します。 |
|
タスクの実行停止 |
指定したタスクを実行停止します。 |
|
タスクの強制停止に必要な情報の取得 |
指定したタスクを強制停止するために必要な情報を取得します。 |
|
タスクの強制停止 |
指定したタスクを強制停止します。 |
|
タスクの再実行に必要な情報の取得 |
指定したタスクを再実行するために必要な情報を取得します。 |
|
タスクの再実行 |
指定したタスクを再実行します。 |
|
応答待ち中のタスクに応答するために必要な情報の取得 |
応答待ち中のタスクに応答するために必要な情報を取得します。取得するのは,指定したIDのタスクの中で,応答待ち中になった日時が最も古いステップの情報です。 |
|
応答待ち中のタスクに応答 |
指定したIDのタスクの中で,応答待ち中になった日時が最も古いステップに応答入力します。 |
|
タスクのリトライに必要な情報の取得(失敗したステップからリトライ) |
タスクを指定し,失敗したステップからリトライするために必要な情報を取得します。 |
|
失敗したステップからリトライ |
タスクを指定し,失敗したステップからリトライします。 |
|
タスクのリトライに必要な情報の取得(失敗した次のステップからリトライ) |
タスクを指定し,失敗した次のステップからリトライするために必要な情報を取得します。 |
|
失敗した次のステップからリトライ |
タスクを指定し,失敗した次のステップからリトライします。 |
|
タスクのアーカイブに必要な情報の取得 |
指定したタスクをアーカイブするために必要な引数のテンプレートを取得します。 |
|
タスクのアーカイブ |
指定したタスクをアーカイブします。 |
|
ステップ一覧の取得 |
指定したタスクに含まれるステップのうち,[タスク詳細]画面に表示されるステップの一覧を取得します。 |
|
タスクログの取得 |
指定したタスクのタスクログを取得します。 |
API名 |
機能 |
参照先 |
---|---|---|
履歴一覧の取得 |
履歴の一覧を取得します。 |
|
履歴の削除(条件指定) |
クエリパラメータの条件に従って,履歴を削除します。 |
|
履歴の取得 |
指定したIDの履歴を取得します。 |
|
履歴の削除(ID指定) |
指定したIDの履歴を削除します。 |
|
履歴に対する操作一覧の取得 |
指定したIDの履歴に対して実行できる操作の一覧を取得します。 |
API名 |
機能 |
参照先 |
---|---|---|
プロパティ定義一覧の取得 |
プロパティ定義の一覧を取得します。 |
|
プロパティ定義情報の取得 |
指定したプロパティ定義の情報を取得します。 |
|
プロパティ定義に対する操作一覧の取得 |
指定したプロパティ定義に対して実行できる操作の一覧を取得します。 |
|
プロパティ定義およびプロパティ値一覧の取得 |
プロパティ定義およびプロパティ値の情報の一覧を取得します。 |
|
プロパティ値一覧の取得 |
次に示すプロパティ値の一覧を取得します。
|
|
プロパティ値の一括更新 |
次に示すプロパティ値を一括更新します。
|
|
プロパティ値の取得 |
指定したプロパティ値の情報を取得します。 |
|
プロパティ値の更新 |
指定したIDのプロパティ値を更新します。 |
|
プロパティ値に対する操作一覧の取得 |
指定したプロパティ値に対する操作の一覧を取得します。 |
|
プロパティグループ一覧の取得 |
サービスが保持するプロパティが所属しているプロパティグループの一覧を取得します。 |
API名 |
機能 |
参照先 |
---|---|---|
サービスグループ一覧の取得 |
サービスグループ一覧を取得します。 |
|
サービスグループ情報の取得 |
指定したサービスグループの情報を取得します。 |
|
サービスグループに対する操作一覧の取得 |
指定したサービスグループに対して実行できる操作の一覧を取得します。 |
API名 |
機能 |
参照先 |
---|---|---|
タググループ一覧の取得 |
タググループの一覧を取得します。また,タググループに所属するタグ一覧を取得します。 |
|
タグ一覧の取得 |
指定したリソースに設定されているタグの一覧を取得します。 |
API名 |
機能 |
参照先 |
---|---|---|
ユーザー情報の取得 |
APIを実行したユーザーの情報を取得します。 |
|
バージョン情報の取得 |
JP1/AOとAPIのバージョンを取得します。 |