7.3.6 Execution agent operation result object

This object indicates the result of an operation performed on an execution agent or execution agent group.

Format

{
  "execAgent":"execution-agent-name-or-execution-agent-group-name",
  "rtnCode":"result-code-of-target-processing",
  "messageID":"message-ID",
  "message":"message-text",
  "output":{
    "definitions":[execution-agent-definition-information-object,...],
    "statuses":[execution-agent-status-object,...],
    "text":"API-operation-result",
    "serverTime":"local-time-on-connection-destination-host"
  }
}

Member

The following table lists and describes the members to be returned.

Table 7‒47: List of members of the Execution agent operation result object

Member	Data type	Description
execAgent	string	Returns information according to the requested method as follows: If the GET method is requested Returns a character string of 0 bytes. If the POST method is requested Returns the operation-target execution agent (execution agent name or execution agent group name) by using a character string in the range from 1 to 255 bytes.
rtnCode	string	Returns a code that indicates the processing result. If the processing terminates normally, 0 is returned.
messageID	string	Returns the message ID if the value of the rtnCode member is 0. In cases other than the above, this item returns nothing.
message	string	Returns the message text if the value of the rtnCode member is 0. In cases other than the above, this item returns nothing.
output	object	Returns information according to the requested method as follows: If the GET method is requested This item returns a subordinate object (definitions or statuses) that contains the information acquired by the API. If the POST method is requested, this item returns information according to the API as follows: - In the case of the API that checks the communication status of the job distribution delay reduction function This item returns a subordinate object (text) that contains the API operation result. - In cases other than the above This item returns the string null.
definitions	object[]	Returns the definition information of the registered execution agents or execution agent groups as an array of execution agent definition information objects. The returned information varies according to the API operation as follows: In the case of acquiring the definitions of execution agents or execution agent groups In the returned array of execution agent definition information objects, the definition information is stored in element 0. In cases other than the above This item returns the string null. For details about the execution agent definition information object,see 7.3.7 Execution agent definition information object.
statuses	object[]	Returns the statuses of the registered execution agents or execution agent groups as an array of execution agent status objects. The returned information varies according to the API operation as follows: In the case of acquiring a list of the statuses of execution agents or execution agent groups An array of execution agent status objects is returned. In the case of acquiring the status of an execution agent In the returned array of execution agent status objects, the status of the execution agent is stored in element 0. Note that, if the execution agent specified by query does not exist, a zero-element array is returned. In cases other than the above This item returns the string null. For details about the execution agent status object, see 7.3.8 Execution agent status object.
text	string	Returns a character string that indicates the API operation result.
serverTime	string	Returns the local date and time of the JP1/AJS3 - Manager host. The number of seconds that elapsed since 0:00:00 on January 1, 1970 is returned in ISO 8601 format as follows: YYYY-MM-DDThh:mm:ssTZD For details about the ISO 8601 format, see 6.3 Data types usable for an API. The returned information varies according to the API operation as follows: In the cases of acquiring a status list of execution agents, the statuses of execution agents, or a status list of execution agent groups The time at which this information was acquired is returned. In cases other than the above This item returns the string null.

To Page Top