Show Source

• [0]: object ApiEntityMeasureThreshold

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityMeasureThreshold"
    }
}

Show Source

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

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

  The type of direction of a threshold.
• link(optional): string(url)
  Read Only: true
• measureId(optional): integer(int64)
  The unique identifier of a measure.
• measureThresholdItems(optional): array measureThresholdItems
  Unique Items Required: true
• thresholdId(optional): integer(int64)
  The unique identifier of a threshold.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "measureThresholdItems":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityMeasureThresholdItem"
            }
        },
        "desirableState":{
            "type":"string",
            "description":"The type of direction of a threshold.",
            "enum":[
                "HIGH_VALUES",
                "LOW_VALUES"
            ]
        },
        "computeAgainstType":{
            "type":"string",
            "description":"The against type of a threshold.",
            "enum":[
                "ACTUAL_VALUE",
                "PERCENT_OF_TARGET"
            ]
        },
        "measureId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a measure."
        },
        "thresholdId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a threshold."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Show Source

• [0]: object ApiEntityMeasureThresholdItem

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityMeasureThresholdItem"
    }
}

Show Source

• color(optional): string
  The color representation of the threshold state.
• icon(optional): 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(optional): string(url)
  Read Only: true
• measureThresholdId(optional): integer(int64)
  The unique identifier of a threshold.
• operator(optional): 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(optional): 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(optional): number(double)
  The measurement used for the threshold range.
• thresholdItemId(optional): integer(int64)
  The unique identifier of a threshold item.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "color":{
            "type":"string",
            "description":"The color representation of the threshold state."
        },
        "targetHighValue":{
            "type":"number",
            "format":"double",
            "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\"."
        },
        "measureThresholdId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a threshold."
        },
        "operator":{
            "type":"string",
            "description":"The logical operator for the threshold used for measuring values.",
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "GREATER_THAN_EQUALS",
                "LESS_THAN_EQUALS",
                "NOT_EQUALS",
                "LESS_THAN",
                "BETWEEN",
                "NOT_BETWEEN"
            ]
        },
        "thresholdItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a threshold item."
        },
        "icon":{
            "type":"string",
            "description":"The pictorial representation of the threshold state.",
            "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",
            "format":"double",
            "description":"The measurement used for the threshold range."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}