Canceling a predictive operation

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can cancel a predictive operation.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/PredictionTask/actions/cancel/invoke

Request body

The structure of the request body and the object attributes are 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 PredictionTask objects necessary to execute an operation. For details, see the table below.

PredictionTask

{
        "name":"...",
        "taskState":"..."
}

PredictionTask (Type: PredictionTask)

Attribute	Type	Description
name	string	Name of the task.
taskState	enum	Executing status of the task. (For details about the valid values, see the table PredictionExecState in List of enumerators.)

Attribute

Type

Description

name

string

Name of the task.

taskState

enum

Executing status of the task.

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

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of PredictionTask objects. For details, see the table below.