Analyze Configuration Test Data
post
/v2/scheduler/analyzeUnitTestState
After requesting the "Start Configuration Test for a Cluster" service with /startClusterUnitTest endpoint, use this service to analyze the configuration. IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service for all calls to scheduler services. IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service for all calls to scheduler services.
Request
Supported Media Types
- application/json
Header Parameters
-
jde-AIS-Auth: string
Token
-
jde-AIS-Auth-Device: string
Device Name
-
jde-AIS-MonitorOnStart: boolean
Monitor on Start
-
jde-AIS-MonitorRequest: string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
Top level object for all AIS service requests, containing authentication information applicable to all services.
Root Schema : AISRequest
Type:
objectTop level object for all AIS service requests, containing authentication information applicable to all services.
Show Source
-
deviceName:
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
environment:
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
jasserver:
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
password:
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken:
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
role:
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
token:
string
The AIS token, which is required if other authentication methods are not being used.
-
username:
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
Response
Supported Media Types
- application/json
200 Response
Successful Execution
400 Response
Bad Request - Invalid JSON Input
403 Response
Authorization Failure
415 Response
Invalid Content-Type Header - Must use application/json
444 Response
Invalid Token
Root Schema : ServiceErrorResponse
Type:
objectError Response
Show Source
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
500 Response
Server Failed to Process Request
Root Schema : ServiceErrorResponse
Type:
objectError Response
Show Source
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a scheduler analyzeUnitTestState request, which is called a few minutes after starting the unit tests. The service checks the sequence of jobs running based on the startClusterUnitTest hosts. The key value is "testSucceed": "true". If this value is "false", other information may help in determining what is wrong with the configuration.
The token passed in this example was received from a separate token request. You can also use other supported authentication methods.
IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service for all calls to scheduler services.
curl -X POST -H "Content-Type:application/json" http://ais_server_host/jderest/v2/scheduler/analyzeUnitTestState -d
{
"token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}
Example Response
The following example shows the contents of the response body.
{
"unitTestResults": {
"testSucceeded": true,
"errorEventIndex": [],
"errorEvent": [],
"unitTestEvents": [
{
"unitTestJobBehavior": {
"unitTestStartupHost": {
"protocol": "ais_host_protocol",
"host": "ais_host_1",
"port": "ais_port"
},
"id": "a",
"unitTestHostActions": [
{
"unitTestHost": {
"protocol": "ais_host_protocol",
"host": "ais_host_2",
"port": "ais_port",
"id": "b"
},
"unitTestAction": "Start",
"httpStatusCode": "SC_OK",
"httpStatusCodeText": "OK"
},
{
"unitTestHost": {
"protocol": "ais_host_protocol",
"host": "ais_host",
"port": "ais_host_port",
"id": "a"
},
"unitTestAction": "Stop",
"httpStatusCode": "SC_UNKNOWN_ASYNC",
"httpStatusCodeText": "Unknown return value, asynchronous"
}
],
"unitTestHostCount": 2,
"runningOnSingleServer": false
},
"executionHost": "ais_host_url_1"
},
{
"unitTestJobBehavior": {
"unitTestStartupHost": {
"protocol": "ais_host_protocol",
"host": "ais_host_1",
"port": "ais_host_port"
},
"id": "b",
"unitTestHostActions": [
{
"unitTestHost": {
"protocol": "ais_host_protocol",
"host": "ais_host_1",
"port": "ais_host_port",
"id": "a"
},
"unitTestAction": "Start",
"httpStatusCode": "SC_OK",
"httpStatusCodeText": "OK"
},
{
"unitTestHost": {
"protocol": "ais_host_protocol",
"host": "ais_host_2",
"port": "ais_host_port",
"id": "b"
},
"unitTestAction": "Stop",
"httpStatusCode": "SC_UNKNOWN_ASYNC",
"httpStatusCodeText": "Unknown return value, asynchronous"
}
],
"unitTestHostCount": 2,
"runningOnSingleServer": false
},
"executionHost": "ais_host_url_1"
}
],
"jobsStopped": null
}
}