The following operation is the initial step to get information for predictive results.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/services/PredictionHistory/actions/getResult
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of GetPredictionResultParam objects necessary to execute an operation. For details, see the table below. |
GetPredictionResultParam
{
"historyID":"...",
"targetIDs":"...",
"cullTimespan":"...",
"rangeFrom":"...",
"rangeTo":"...",
"onlyModelData":"..."
}
GetPredictionResultParam (Type: GetPredictionResultParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
historyID |
string |
ID of the predictive report result. |
|
targetIDs |
string |
Target ID list. |
|
cullTimespan |
int |
Interval (in minutes) for culling display data. |
|
rangeFrom |
long |
Start time of the performance data range. |
|
rangeTo |
long |
End time of the performance data range. |
|
onlyModelData |
boolean |
Whether the response will have performance data and predictive report results. |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
401 |
Unauthorized |
No login privilege. |
|
403 |
Forbidden |
No reference privilege. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |