Jump to

• Request
• Response

View a Measure Threshold by Measure

get

/api/restapi/measureThreshold/measure/{measureId}

This endpoint returns measure thresholds that meet the following requirements:

• The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.

Request

Path Parameters

• measureId(required): integer(int64)
  The system-generated identifier of a measure.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityMeasureThreshold>

Type: array

Title: List<ApiEntityMeasureThreshold>

Show Source

• Array of: object ApiEntityMeasureThreshold
  Title: ApiEntityMeasureThreshold

{
    "title":"List<ApiEntityMeasureThreshold>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityMeasureThreshold",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityMeasureThreshold

Type: object

Title: ApiEntityMeasureThreshold

Show Source

• computeAgainstType: string
  Allowed Values: [ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]

  The against type of a threshold.
• desirableState: string
  Allowed Values: [ "HIGH_VALUES", "LOW_VALUES" ]

  The type of direction of a threshold.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureId: integer (int64)
  The unique identifier for the measure.The measure object can also be identified by its unique criteria.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• measureThresholdId: integer (int64)
  The unique identifier of a threshold. This value should not be provided in create operation request data, however, it is required for update requests.
• measureThresholdItems: array measureThresholdItems
  The items that define the threshold for the measure.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityMeasureThreshold",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier for the measure.The measure object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureThresholdItems":{
            "type":"array",
            "description":"The items that define the threshold for the measure.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityMeasureThresholdItem",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "measureThresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "computeAgainstType":{
            "type":"string",
            "description":"The against type of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTUAL_VALUE",
                "PERCENT_OF_TARGET"
            ]
        },
        "desirableState":{
            "type":"string",
            "description":"The type of direction of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HIGH_VALUES",
                "LOW_VALUES"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : measureThresholdItems

Type: array

The items that define the threshold for the measure.

Show Source

• Array of: object ApiEntityMeasureThresholdItem
  Title: ApiEntityMeasureThresholdItem

{
    "type":"array",
    "description":"The items that define the threshold for the measure.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityMeasureThresholdItem",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityMeasureThresholdItem

Type: object

Title: ApiEntityMeasureThresholdItem

Show Source

• color: string
  Maximum Length: 20

  The color representation of the threshold state.
• icon: string
  Allowed Values: [ "THREE_D", "CHECK", "CIRCLE", "CONTENT", "CORRECT", "DIAMOND", "ERROR", "EXCLAMATION", "FLAG", "HAPPY", "OK", "POP_UP", "SAD", "SQUARE", "STAR", "TARGET", "TRIANGLE", "WARNING", "X" ]

  The pictorial representation of the threshold state.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureThresholdId: integer (int64)
  The unique identifier of a threshold.
• operator: string
  Allowed Values: [ "EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "NOT_EQUALS", "LESS_THAN", "BETWEEN", "NOT_BETWEEN" ]

  The logical operator for the threshold used for measuring values.
• targetHighValue: number (double)
  High Value enables you to set a maximum value other threshold values can be measured against.
  The High Value is only editable if Value is selected and the threshold operator is set to "within range" or "not within range".
• targetValue: number (double)
  The measurement used for the threshold range.
• thresholdItemId: integer (int64)
  The unique identifier of a threshold item.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityMeasureThresholdItem",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "color":{
            "maxLength":"20",
            "type":"string",
            "description":"The color representation of the threshold state.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The logical operator for the threshold used for measuring values.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "GREATER_THAN_EQUALS",
                "LESS_THAN_EQUALS",
                "NOT_EQUALS",
                "LESS_THAN",
                "BETWEEN",
                "NOT_BETWEEN"
            ]
        },
        "targetHighValue":{
            "type":"number",
            "description":"High Value enables you to set a maximum value other threshold values can be measured against. <br />The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "icon":{
            "type":"string",
            "description":"The pictorial representation of the threshold state.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "THREE_D",
                "CHECK",
                "CIRCLE",
                "CONTENT",
                "CORRECT",
                "DIAMOND",
                "ERROR",
                "EXCLAMATION",
                "FLAG",
                "HAPPY",
                "OK",
                "POP_UP",
                "SAD",
                "SQUARE",
                "STAR",
                "TARGET",
                "TRIANGLE",
                "WARNING",
                "X"
            ]
        },
        "targetValue":{
            "type":"number",
            "description":"The measurement used for the threshold range.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "measureThresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "thresholdItemId":{
            "type":"integer",
            "description":"The unique identifier of a threshold item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested measure threshold does not exist, or you do not have access to it.

Back to Top