Getting a list of predictive reports

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 reports.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/PredictiveReport

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 PredictiveReport 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.

PredictiveReport

{
        "name":"...",
        "description":"...",
        "profileIDs":["...", ...],
        "targets":[{
            "nodeType":"...",
            "resourceIDs":["...", ...],
            "withRelated":"..."
        },
        :
        ],
        "withRelated":"...",
        "owner":"...",
        "lastUpdated":,
        "systemDefined":"...",
        "isOndemand":"...",
        "actionIDs":,
        "lastHistoryID":"..."
}

PredictiveReport (Type: PredictiveReport)

Attribute	Type	Description
name	string	Name of the report.
description	string	Description of the report.
profileIDs	string[]	List of profile IDs.
targets	PredictionTargetCond[]	Target condition list.
withRelated	boolean	Whether or not the related resources are included in the targets.
owner	string	Name of the user who created the report.
lastUpdated	datetime	Last updated time.
systemDefined	boolean	Whether or not this report is system defined.
isOndemand	boolean	Whether or not this report was created for an ad hoc execution.
actionIDs	List	Action ID list.
lastHistoryID	string	Latest predictive report result ID.

targets (Type: PredictionTargetCond)

Attribute	Type	Description
nodeType	enum	Node type. (For details about the valid values, see the table E2ENodeType in List of enumerators.)
resourceIDs	string[]	Resource ID list.
withRelated	boolean	Indicates whether the related resource is the same as the target.

Attribute

Type

Description

nodeType

enum

Node type.

(For details about the valid values, see the table E2ENodeType in List of enumerators.)

resourceIDs

string[]

Resource ID list.

withRelated

boolean

Indicates whether the related resource is the same as the target.

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.