Create a Measure Threshold
post
/api/restapi/measureThreshold
Send a request to this endpoint to create a measure threshold. An application object will be created using the JSON data provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityMeasureThresholdInput
Type:
object
Title:
Show Source
ApiEntityMeasureThresholdInput
-
computeAgainstType(required): string
Allowed Values:
[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]
The against type of a threshold. -
desirableState(required): string
Allowed Values:
[ "HIGH_VALUES", "LOW_VALUES" ]
The type of direction of a threshold. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
measureId(required): 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
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : measureThresholdItems
Type:
array
The items that define the threshold for the measure.
Show Source
-
Array of:
object ApiEntityMeasureThresholdItemInput
Title:
ApiEntityMeasureThresholdItemInput
Nested Schema : ApiEntityMeasureThresholdItemInput
Type:
object
Title:
Show Source
ApiEntityMeasureThresholdItemInput
-
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)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
measureThresholdId(required): integer
(int64)
The unique identifier of a threshold.
-
operator(required): 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(required): number
(double)
The measurement used for the threshold range.
-
thresholdItemId: integer
(int64)
The unique identifier of a threshold item.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityMeasureThreshold
Type:
object
Title:
Show Source
ApiEntityMeasureThreshold
-
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.
Nested Schema : measureThresholdItems
Type:
array
The items that define the threshold for the measure.
Show Source
-
Array of:
object ApiEntityMeasureThresholdItem
Title:
ApiEntityMeasureThresholdItem
Nested Schema : ApiEntityMeasureThresholdItem
Type:
object
Title:
Show Source
ApiEntityMeasureThresholdItem
-
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.
400 Response
Invalid input for a baseline threshold.