7.1.23 Execution agent definition acquisition API
This API acquires the definitions of the execution agents that are registered on the manager host.
You can use this API function only if the version of JP1/AJS3 - Web Console is 12-50 or later and the version of the connection-destination JP1/AJS3 - Manager is 12-50 or later. Before you use this API function, confirm that: the return value (productVersionNumber) of the version information acquisition API function is 125000 or larger; and the return value (protocolVersionNumber) of the JP1/AJS3 - Manager protocol version acquisition API function is 1250 or larger.
- Execution privileges
-
The logged-in JP1 user must have one of the following JP1 permissions:
-
JP1_JPQ_Admin privileges
-
JP1_JPQ_Operator privileges
-
JP1_JPQ_User privileges
-
- Request format
-
- Request line
GET /application/component/apiVersion/objects/execAgents/definitions?query httpVersion
- API version
-
v1
- Information that uniquely identifies a resource
-
None
- Parameter
-
The following table lists and describes the parameters that can be specified for query.
Table 7‒23: List of parameters for the Execution agent definition acquisition API Parameter
Description of the value
Required?
manager
Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.
Y
mode
Specify a character string that indicates the acquisition-target mode. Specify agent for this parameter.
Y
execAgent
Specify the execution agent name by using a character string in the range from 1 to 255 bytes.
Y
- Status code
-
The following table lists and describes the status codes returned as a response:
Status code
Text description
Description
200
OK
Execution agent definitions were acquired successfully.
400
Bad Request
The query character string is invalid.
401
Unauthorized
Authentication is required.
403
Forbidden
The operator does not have execution permission.
404
Not found
The operator does not have access permission for the resource, or the resource does not exist.
412
Precondition failed
The Web Console server is not available.
500
Server-side error
A processing error occurred in the Web Console server.
- Response format
-
- Response message body
{ "results":[Execution-agent-operation-result-object] }
- Return values
-
If the status code is 200, the following information is returned:
Member
Data type
Description
results
object[]
Returns an array of the execution agent operation result objects. In the returned array, the result of acquiring execution agent definitions is stored in element 0.
Also, if the command terminates abnormally on the manager host, a non-zero value is stored as the result code of the target processing and KNAK3696-E is stored as a message in the returned array.
For details about the execution agent operation result object, see 7.3.6 Execution agent operation result object.
- Example
-
The following shows an example of using the API to acquire the definitions of execution agents.
- Example request:
GET /ajs/api/v1/objects/execAgents/definitions?manager=HOSTM&mode=agent&execAgent=AGT01 HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
- Example response (message body):
{ "results": [ { "rtnCode":"0", "output": { "definitions": [ { "conExe": [ "00:00-00:00=20" ], "status":"BLOCKADE", "description":"test", "execAgent":"AGT01", "execHost":"AGT01" } ], "statuses":null, "text":"", "serverTime":"" }, "execAgent":"" } ] }