Getting a list of analytics engines

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of analytics engines.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/PredictionModule

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

PredictionModule

{
        "label":"...",
        "description":"...",
        "predictionTypes":[{
            "label":"...",
            "description":"...",
            "selected":"..."
        },
        :
        ],
        "params":[{
            "label":"...",
            "description":"...",
            "type":"...",
            "required":"...",
            "defaultValue":,
            "rangeMin":,
            "rangeMax":,
            "selectionItems":[{
                "label":"...",
                "description":"...",
                "selected":"..."
            },
            :
            ],
            "multiSelection":"..."
        },
        :
        ]
}

PredictionModule (Type: PredictionModule)

Attribute	Type	Description
label	string	Label of the analytics engine.
description	string	Description of the analytics engine.
predictionTypes	PredictionModuleValue[]	Predictive modeling type list.
params	PredictionModuleParam[]	Parameter list.

predictionTypes (Type: PredictionModuleValue)

Attribute	Type	Description
label	string	Label of the value.
description	string	Description of the value.
selected	boolean	Indicates whether or not this value is selected.

params (Type: PredictionModuleParam)

Attribute	Type	Description
label	string	Name of parameter.
description	string	Description of parameter.
type	string	Class name of parameter value.
required	boolean	Indicates whether or not this parameter is specified.
defaultValue	Object	Default value.
rangeMin	Object	Minimum value of value range.
rangeMax	Object	Maximum value of value range.
selectionItems	PredictionModuleValue[]	Item list of selection.
multiSelection	boolean	Indicates whether or not multiple items can be selected.

selectionItems (Type: PredictionModuleValue)

Attribute	Type	Description
label	string	Label of the value.
description	string	Description of the value.
selected	boolean	Indicates whether or not this value is selected.

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.