7.1.3 Execution result details acquisition API
This API acquires execution details about a unit for which execution has ended.
For details about the execution result, see 12.3.39 Execution Result Details dialog box in the JP1/Automatic Job Management System 3 Operator's Guide.
- Execution privileges
-
The logged in user must have one of the following JP1 permissions for the unit whose information is to be acquired:
-
JP1_AJS_Admin privileges
-
JP1_AJS_Manager privileges
-
JP1_AJS_Editor privileges
-
JP1_AJS_Operator privileges
-
JP1_AJS_Guest privileges
-
- Request format
-
- Request line
GET /application/component/apiVersion/objects/statuses/unitName:execID/actions/execResultDetails/invoke?query httpVersion
- API version
-
v1
- Information that uniquely identifies a resource
-
The table below describes the information that uniquely identifies a resource.
If a parameter is not specified or is specified incorrectly, an error with the status code 404 occurs because the resource cannot be uniquely identified.
Information that uniquely identifies a resource
Data type
Description
Required?
unitName
string
Specify the full name of the unit to be requested, by using a character string in the range from 1 to 930 bytes.
Y
execID
string
Specify the execution ID by using a character string in the format of @[mmmm]{A to Z}nnnn (for example, @10A200).
Y
- Legend:
-
Y: Required
- Parameter
-
The following table lists and describes the parameters that can be specified for query.
Table 7‒3: List of parameters for the execution result details 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
serviceName
Specify the scheduler service name by using a character string in the range from 1 to 30 bytes.
Y
- Legend:
-
Y: Required
- Status code
-
The following table lists and describes the status codes returned as a response:
Status code
Message
Description
200
OK
The execution result details were successfully acquired.
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.
409
Conflict
The processing cannot be continued because the request is inconsistent with the current resource status.
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
{ "execResultDetails":"execution-result-details", "all":whether-all-information-sets-could-be-acquired }
- Return values
-
If the status code is 200, the following information is returned:
Member
Data type
Description
execResultDetails
string
Returns execution result details as a character string of no more than 5 megabytes. If the character string exceeds 5 megabytes, end characters might not be identified as characters because information exceeding 5 megabytes is truncated.
Execution result details contain a linefeed code (\n or \r\n) for the environment in which the job is executed. Replace the linefeed code according to the environment in which they will be displayed.
If there are no execution result details, a null character string (0 bytes) is returned.
all
boolean
Returns irrespective of whether all execution result details could be acquired.
If all execution result details could be acquired, true is returned. If some execution result details could not be acquired, false is returned.
- Example
-
The following shows an example of using the API to acquire the execution result details for the specified job.
- Example request:
GET /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet%2FJob:%40A100/actions/execResultDetails/invoke?manager=HOSTM&serviceName=AJSROOT1 HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
- Example response:
HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store, no-cache, max-age=0 Date: Mon, 08 Aug 2016 09:39:28 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server { "execResultDetails": "execution-result-details", "all": true }