Getting margin information used for dynamic threshold calculations

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of the types of margins used for dynamic threshold calculations and display names.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/ThresholdProfileMargins

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

ThresholdMarginInfo

{
        "marginLevel":"...",
        "marginName":"...",
        "isDefault":"..."
}

ThresholdMarginInfo (Type: ThresholdMarginInfo)

Attribute	Type	Description
marginLevel	string	ID of the margin
marginName	string	Display name of the margin
isDefault	boolean	Whether or not the margin is used as an initial value. If the margin is used as an initial value, "true" is set. If the margin is not used as an initial value, "false" is set.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET
http://10.197.198.241:22015/Analytics/v1/objects/ThresholdProfileMargins
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:02 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "marginLevel" : "Severe",
    "marginName" : "Severe"
  }, {
    "marginLevel" : "Normal",
    "marginName" : "Normal",
    "isDefault" : true
  }, {
    "marginLevel" : "Rough",
    "marginName" : "Rough"
  } ],
  "count" : 3
}