You can update recovery action history.
Execution permission
Admin, Modify
Request line
PUT baseURL/v1/objects/RecoveryAction/{id}
Request body
The structure of the request body and the object attributes are as follows:PredictiveProfile
{ "name":"...", "description":"...", "predictionPeriod":"...", "calculationPeriod":"...", "dataInterval":"...", "metrics":[{ "metricType":"...", "threshold":"...", "proportion":"..." }, : ], "moduleID":"...", "predictionTypes":["...", ...], "withRelated":"...", "params":[{ "value":, "items":["...", ...] }, : ], "owner":"...", "lastUpdated":, "systemDefined":"...", "isOndemand":"...", "numOfReports":"..." }
PredictiveProfile (Type: PredictiveProfile)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the profile. |
description |
string |
Description of the profile. |
predictionPeriod |
long |
Time period of the predictive operation. |
calculationPeriod |
long |
Time period of the original data. |
dataInterval |
long |
Data acquisition interval (in minutes). |
metrics |
PredictionMetric[] |
Metric settings list. |
moduleID |
string |
Module ID. |
predictionTypes |
string[] |
Predictive modeling types. |
withRelated |
boolean |
Whether or not the related resources are included in the targets. |
params |
PredictionModuleSetting[] |
Parameter settings for the analytics engine. |
owner |
string |
Name of the user who created the profile. |
lastUpdated |
datetime |
Last updated time. |
systemDefined |
boolean |
Whether or not this profile is system defined. |
isOndemand |
boolean |
Whether or not this profile was created for an ad hoc execution. |
numOfReports |
boolean |
Number of reports using this profile. |
metrics (Type: PredictionMetric)
Attribute |
Type |
Description |
---|---|---|
metricType |
enum |
Metric type. (For details about the valid values, see the table MetricType in List of enumerators.) |
threshold |
float |
A threshold value. |
proportion |
boolean |
Direction of threshold. |
params (Type: PredictionModuleSetting)
Attribute |
Type |
Description |
---|---|---|
value |
Object |
Value for the analytics engine. |
items |
string[] |
Key list for the possible selection. |
Response body
The structure of the response body and the object attributes is as follows:PredictiveProfile
{ "name":"...", "description":"...", "predictionPeriod":"...", "calculationPeriod":"...", "dataInterval":"...", "metrics":[{ "metricType":"...", "threshold":"...", "proportion":"..." }, : ], "moduleID":"...", "predictionTypes":["...", ...], "withRelated":"...", "params":[{ "value":, "items":["...", ...] }, : ], "owner":"...", "lastUpdated":, "systemDefined":"...", "isOndemand":"...", "numOfReports":"..." }
PredictiveProfile (Type: PredictiveProfile)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the profile. |
description |
string |
Description of the profile. |
predictionPeriod |
long |
Time period of the predictive operation. |
calculationPeriod |
long |
Time period of the original data. |
dataInterval |
long |
Data acquisition interval (in minutes). |
metrics |
PredictionMetric[] |
Metric settings list. |
moduleID |
string |
Module ID. |
predictionTypes |
string[] |
Predictive modeling types. |
withRelated |
boolean |
Whether or not the related resources are included in the targets. |
params |
PredictionModuleSetting[] |
Parameter settings for the analytics engine. |
owner |
string |
Name of the user who created the profile. |
lastUpdated |
datetime |
Last updated time. |
systemDefined |
boolean |
Whether or not this profile is system defined. |
isOndemand |
boolean |
Whether or not this profile was created for an ad hoc execution. |
numOfReports |
boolean |
Number of reports using this profile. |
metrics (Type: PredictionMetric)
Attribute |
Type |
Description |
---|---|---|
metricType |
enum |
Metric type. (For details about the valid values, see the table MetricType in List of enumerators.) |
threshold |
float |
A threshold value. |
proportion |
boolean |
Direction of threshold. |
params (Type: PredictionModuleSetting)
Attribute |
Type |
Description |
---|---|---|
value |
Object |
Value for the analytics engine. |
items |
string[] |
Key list for the possible selection. |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
The format of the request body is invalid. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No update privilege. |
404 |
Not Found |
The resource was not found. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |