Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 


2.2.5 リクエスト形式

APIでJP1/AOが提供する機能を利用するためのリクエスト形式を次に示します。

図2‒1 リクエスト形式(ドメインがobjectsの場合の例)

[図データ]

リクエスト形式の構成内容について,次の表で説明します。

表2‒10 リクエスト形式の構成内容

項目

説明

参照先

メソッド

リソースに対する操作を指定します。

2.2.7 サポートするメソッド

URL

APIのコレクション名

APIのコレクションの名称です。固定値として「Automation」を指定します。

APIのバージョン

使用するAPIのバージョンを指定します。

各APIの「APIのバージョン」を参照してください。

ドメイン名

実行するAPIの操作対象となるリソースのドメイン名を指定します。なお,このリクエスト形式に該当するのは,ドメインが「objects」の場合です。

2.2.8 APIで管理できるドメイン名とリソース

リソース

JP1/AOが提供する機能をAPIのリソースとして提供しています。実行したい処理に応じてリソースを指定します。

クエリパラメータ

リクエストに検索条件を付加することで,レスポンスの出力内容をフィルタリングしたり,ソートしたりすることができます。

2.2.9 クエリパラメータ

プロトコル

APIが使用する通信プロトコルとして「HTTP」を指定します。通信プロトコルにhttpsを使用する場合も,「HTTP」と指定してください。

2.2.1 通信方式

プロトコルのバージョン

APIが使用する通信プロトコルのバージョンとして「1.1」を指定します。

リクエストヘッダー

Host

ホストの情報を指定します。

2.2.10 リクエストヘッダー

Accept

レスポンスのデータ形式を指定します。

Accept-Language

レスポンスの言語コードを指定します。

User-Agent

APIクライアントのソフトウェア情報を指定します。

(凡例)

-:該当しません。

注※

コレクションとは,処理の対象となるデータを指します。

リクエスト形式の構成内容や詳細は,APIごとに異なるため,各APIの「リクエスト形式」を参照してください。