Batch Update Thresholds
put
/primeapi/restapi/threshold/batch
Send a request to this endpoint to update one or more thresholds.
Request
Supported Media Types
- application/json
One or more threshold objects.
Nested Schema : ApiEntityThreshold
Type:
Show Source
object
-
color(optional):
string
The bubble color is shown in the monitoring charts when the threshold criterion is met.
-
columnId(optional):
integer(int64)
The unique identifier of a column.
-
columnUpperId(optional):
integer(int64)
The unique identifier of an upper column.
-
costValue(optional):
object Cost
-
costValueUpper(optional):
object Cost
-
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 visual indicator associated with the threshold.
The selected icon will display when threshold criteria is met. -
integerValue(optional):
integer(int32)
The numeric value measured by the threshold.
Use threshold operators to compare this value to the values in projects and portfolios. -
integerValueUpper(optional):
integer(int32)
The High Value is only editable if Value is selected and the threshold operator is set to "within range" or "not within range".
High Value allows you to set a maximum value other threshold values can be measured against. -
link(optional):
string(url)
Read Only:
true
-
numberValue(optional):
number(double)
The maximum value other threshold values are measured against.
-
numberValueUpper(optional):
number(double)
The High Value is only editable if Value is selected and the threshold operator is set to "within range" or "not within range".
High Value allows you to set a maximum value other threshold values can be measured against. -
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.
Values are measured against this logic.
For example, a threshold with an operator of Equals will only display an indicator if the budget plan or project value it measures equals the value set in the threshold. -
sequenceNumber(optional):
integer(int32)
Determines the order of a threshold in a list.
-
stringValue(optional):
string
The value of a threshold string.
-
thresholdId(optional):
integer(int64)
The unique identifier of a threshold.
-
type(optional):
string
Allowed Values:
[ "FIELD", "VALUE" ]
The type of a threshold. Thresholds of the value type use logical operators to measure fields against a set numeric value. Thresholds of the field type measure the value of one field against the value of another field. -
typeUpper(optional):
string
Allowed Values:
[ "FIELD", "VALUE" ]
Thresholds can have a type of Value or Field.
Value: Uses the threshold logical operator to measure fields against a set numeric value.
Field: Checks specified fields against a second field. For example, a threshold measuring Annual Discount Rate with an operator of Equals and a type of Field set to Forecast, will indicate if a project's Annual Discount Rate equals its Forecast. -
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.
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi/
400 Response
Invalid input for the Threshold service.