Getting a list of predictive profiles

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of predictive profiles.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/PredictiveProfile

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of PredictiveProfile objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

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.

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. - A query parameter is invalid.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.