6.4.1　指定値の詳細

リクエストとして指定する値の詳細について次に説明します。

メソッド

リクエストのメソッドを指定します。APIがサポートするメソッドを次に示します。

アプリケーション識別子

APIを提供するアプリケーションの識別子を指定します。固定で「ajs」を指定してください。

コンポーネント識別子

コンポーネントの識別子を指定します。固定で「api」を指定してください。

APIのバージョン

APIごとに異なるため，各APIの説明を参照してください。

ドメイン

APIの操作対象となるドメインを指定します。APIで管理できるドメインおよびリソースを次の表に示します。

表6‒6　 APIで管理できるドメインおよびリソース
ドメイン	リソース識別子	リソース識別子の説明
`objects`	`statuses`	ステータス監視のリソース
`objects`	`definitions`	ユニット定義のリソース

リソース識別子

APIの操作対象となるリソース識別子を指定します。APIで管理できるリソースは，表6-6を参照してください。

リソースおよびリソースの操作を一意に識別させるための値

必要に応じて，リソースを一意に識別する値およびアクションの種類を指定します。詳細については，各APIの説明を参照してください。

クエリ文字列

必要に応じて，クエリ文字列を指定します。クエリ文字列は，URIの末尾に続けて，「?」を付けて，次のように指定します。

パラメーター名=値

パラメーターが複数あるときは「&」で区切って，次のように指定します。

パラメーター名=値&パラメーター名=値

プロトコルバージョン

固定で「HTTP/1.1」を指定してください。

リクエストヘッダー

リクエストヘッダーは「リクエストヘッダー:指定値」の形式で指定します。リクエストヘッダーを複数指定する場合は，改行文字で区切ってください。指定できるリクエストヘッダーの一覧を次の表に示します。

表6‒7　リクエストヘッダー一覧
リクエストヘッダー	説明	必須・任意
`Host`	ホストの情報を次の形式で指定します。 host`:`port hostにはWeb Consoleサーバのホスト名またはIPアドレスを指定します。 portにはポート番号を指定します。デフォルトのポート番号は，22252です。	必須
`X-AJS-Authorization`	認証情報を指定します。詳細については，「6.2 API利用時の認証」を参照してください。	必須
`Content-Type`	リクエストのメッセージボディのデータ形式を指定します。固定で「`application/json`」を指定します。	任意
`Accept-Language`	レスポンスでJP1/AJS3 - Web Consoleが発行するメッセージ文の言語コードを指定します。「`Accept-Language`」を指定しなかった場合は，システムのデフォルトの言語コードとなります。指定できる言語コードを次に示します。 `ja`：日本語 `en`：英語 `zh`：中国語なお，「`Accept-Language`」で制御できるのは，JP1/AJS3 - Web Consoleが発行するKNAKで始まるメッセージのメッセージ文だけです。メッセージ内に含まれるユニット名，コメント，実行結果詳細，引き継ぎ結果などの言語コードは，制御できません。	任意

メッセージボディ

入力情報をJSON形式で指定します。文字コードはUTF-8を使用してください。