Batch Update Thresholds

put

/primeapi/restapi/threshold/batch

Send a request to this endpoint to update one or more thresholds.

Request

Supported Media Types
Body ()
One or more threshold objects.
Root Schema : List<ApiEntityThreshold>
Type: array
Title: List<ApiEntityThreshold>
Show Source
Nested Schema : ApiEntityThreshold
Type: object
Show Source
  • The bubble color is shown in the monitoring charts when the threshold criterion is met.
  • The unique identifier of a column.
  • The unique identifier of an upper column.
  • Cost
  • Cost
  • 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.
  • The numeric value measured by the threshold.
    Use threshold operators to compare this value to the values in projects and portfolios.
  • 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.
  • The maximum value other threshold values are 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".
    High Value allows you to set a maximum value other threshold values can be measured against.
  • 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.
  • Determines the order of a threshold in a list.
  • The value of a threshold string.
  • The unique identifier of a threshold.
  • 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.
  • 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.
  • 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

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi//1","2":"https://:/primeapi/restapi//2"}}

400 Response

Invalid input for the Threshold service.