7.3.6　実行エージェントの操作結果オブジェクト

実行エージェントまたは実行エージェントグループを操作した結果を表すオブジェクトです。

形式

{
  "execAgent":"実行エージェント名または実行エージェントグループ名",
  "rtnCode":"対象処理の結果コード",
  "messageID":"メッセージID",
  "message":"メッセージ文",
  "output":{
    "definitions":[実行エージェント定義情報オブジェクト,...],
    "statuses":[実行エージェントの状況オブジェクト,...],
    "text":"APIの操作結果",
    "serverTime":"接続先ホストのローカル日時"
  }
}

メンバー

返却されるメンバーを次の表に示します。

表7‒48　実行エージェントの操作結果オブジェクトのメンバー一覧
メンバー	データ型	説明
`execAgent`	string	リクエストのメソッドによって，次に示す内容を返却します。 GETの場合長さ0バイトの文字列を返却します。 POSTの場合操作対象の実行エージェント（実行エージェント名または実行エージェントグループ名）を1〜255バイトの文字列で返却します。
`rtnCode`	string	処理結果をコードで返却します。正常終了時，「`0`」が返却されます。
`messageID`	string	メンバー`rtnCode`の値が「`0`」の場合，メッセージIDを返却します。それ以外の場合，この項目は返却しません。
`message`	string	メンバー`rtnCode`の値が「`0`」の場合，メッセージ文を返却します。それ以外の場合，この項目は返却しません。
`output`	object	リクエストのメソッドによって，次に示す内容を返却します。メソッドがGETの場合 APIで取得した情報を配下のオブジェクト（`definitions`または`statuses`）に格納して返却します。メソッドがPOSTの場合，APIによって，次に示す内容を返却します。・ジョブ配信遅延の軽減機能の通信状態確認の場合 APIの操作結果を配下のオブジェクト（`text`）に格納して返却します。・上記以外の場合「`null`」を返却します。
`definitions`	object[]	登録されている実行エージェントまたは実行エージェントグループの定義情報を，実行エージェント定義情報オブジェクトの配列で返却します。 APIによって，次に示す内容を返却します。実行エージェントの定義取得，実行エージェントグループの定義取得の場合実行エージェント定義情報オブジェクトの配列の0番目の要素に，定義情報を格納して返却します。上記以外の場合「`null`」を返却します。実行エージェント定義情報オブジェクトの詳細については，「7.3.7 実行エージェント定義情報のオブジェクト」を参照してください。
`statuses`	object[]	登録されている実行エージェントまたは実行エージェントグループの状況を，実行エージェントの状況オブジェクトの配列で返却します。 APIによって，次に示す内容を返却します。実行エージェントの状況一覧の取得の場合，および実行エージェントグループの状況一覧の取得の場合実行エージェントの状況オブジェクトの配列を返却します。実行エージェントの状況取得の場合実行エージェントの状況オブジェクトの配列の0番目の要素に，実行エージェントの状況を格納して返却します。ただし，`query`で指定された実行エージェントが存在しない場合は，要素数0個の配列を返却します。上記以外の場合「`null`」を返却します。実行エージェントの状況オブジェクトの詳細については，「7.3.8 実行エージェントの状況オブジェクト」を参照してください。
`text`	string	APIの操作結果を文字列で返却します。
`serverTime`	string	JP1/AJS3 - Managerホストのローカル日時を返却します。JP1/AJS3 - Managerのローカル日時は，1970年1月1日0時0分0秒からの経過時間（秒単位）が，次のISO 8601形式に変換されます。「YYYY`-`MM`-`DD`T`hh`:`mm`:`ssTZD」 ISO 8601形式の詳細については，「6.3 APIで利用できるデータ型」を参照してください。また，APIによって，次に示す内容を返却します。実行エージェントの状況一覧の取得の場合，実行エージェントの状況取得の場合，および実行エージェントグループの状況一覧取得の場合上記の日時を格納して返却します。上記以外の場合「`null`」を返却します。

ページの先頭へ

7.3.6 実行エージェントの操作結果オブジェクト

7.3.6　実行エージェントの操作結果オブジェクト