Jump to

• Request
• Response

Create a Threshold

post

/api/restapi/threshold

Send a request to this endpoint to create a threshold.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityThresholdInput

Type: object

Title: ApiEntityThresholdInput

This entity represents a Threshold object, a unique Threshold object can be identified by the following combinations of the fields.

• thresholdId

Show Source

• color: string
  Maximum Length: 60

  The bubble color is shown in the monitoring charts when the threshold criterion is met.
• columnId: integer (int64)
  The unique identifier of a column.
• columnUpperId: integer (int64)
  The unique identifier of an upper column.
• costValue: number (double)
  The value which other thresholds are measured against.
• costValueUpper: number (double)
  The cost measured by the threshold.
  Use threshold operators to compare this value to the values in projects and portfolios.
• 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 visual indicator associated with the threshold.
  The selected icon will display when threshold criteria is met.
• integerValue: integer (int32)
  The numeric value measured by the threshold.
  Use threshold operators to compare this value to the values in projects and portfolios.
• integerValueUpper: 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: 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.
• numberValue: number (double)
  The maximum value other threshold values are measured against.
• numberValueUpper: 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(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.
  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: integer (int32)
  Determines the order of a threshold in a list.
• stringValue: string
  Maximum Length: 30

  The value of a threshold string.
• thresholdId: integer (int64)
  The unique identifier of a threshold.
• type: 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: 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: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityThresholdInput",
    "required":[
        "operator"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>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,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stringValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The value of a threshold string.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FIELD",
                "VALUE"
            ]
        },
        "color":{
            "maxLength":"60",
            "type":"string",
            "description":"The bubble color is shown in the monitoring charts when the threshold criterion is met.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"Determines the order of a threshold in a list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The logical operator for the threshold. <br />Values are measured against this logic. <br />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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "GREATER_THAN_EQUALS",
                "LESS_THAN_EQUALS",
                "NOT_EQUALS",
                "LESS_THAN",
                "BETWEEN",
                "NOT_BETWEEN"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"The maximum value other threshold values are measured against.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"The value which other thresholds are measured against.",
            "format":"double",
            "exampleSetFlag":false
        },
        "columnId":{
            "type":"integer",
            "description":"The unique identifier of a column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "icon":{
            "type":"string",
            "description":"The visual indicator associated with the threshold. <br />The selected icon will display when threshold criteria is met.",
            "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"
            ]
        },
        "thresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnUpperId":{
            "type":"integer",
            "description":"The unique identifier of an upper column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costValueUpper":{
            "type":"number",
            "description":"The cost measured by the threshold. <br />Use threshold operators to compare this value to the values in projects and portfolios.",
            "format":"double",
            "exampleSetFlag":false
        },
        "integerValue":{
            "type":"integer",
            "description":"The numeric value measured by the threshold. <br />Use threshold operators to compare this value to the values in projects and portfolios.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "integerValueUpper":{
            "type":"integer",
            "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\". <br />High Value allows you to set a maximum value other threshold values can be measured against.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValueUpper":{
            "type":"number",
            "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\". <br />High Value allows you to set a maximum value other threshold values can be measured against.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "typeUpper":{
            "type":"string",
            "description":"Thresholds can have a type of Value or Field. <br />Value: Uses the threshold logical operator to measure fields against a set numeric value. <br />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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FIELD",
                "VALUE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Threshold object, a unique Threshold object can be identified by the following combinations of the fields.<ul><li>thresholdId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a Threshold

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityThreshold

Type: object

Title: ApiEntityThreshold

Show Source

• color: string
  Maximum Length: 60

  The bubble color is shown in the monitoring charts when the threshold criterion is met.
• columnId: integer (int64)
  The unique identifier of a column.
• columnUpperId: integer (int64)
  The unique identifier of an upper column.
• costValue: number (double)
  The value which other thresholds are measured against.
• costValueUpper: number (double)
  The cost measured by the threshold.
  Use threshold operators to compare this value to the values in projects and portfolios.
• 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 visual indicator associated with the threshold.
  The selected icon will display when threshold criteria is met.
• integerValue: integer (int32)
  The numeric value measured by the threshold.
  Use threshold operators to compare this value to the values in projects and portfolios.
• integerValueUpper: 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: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number (double)
  The maximum value other threshold values are measured against.
• numberValueUpper: 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: 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: integer (int32)
  Determines the order of a threshold in a list.
• stringValue: string
  Maximum Length: 30

  The value of a threshold string.
• thresholdId: integer (int64)
  The unique identifier of a threshold.
• type: 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: 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: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityThreshold",
    "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"
            ]
        },
        "stringValue":{
            "maxLength":"30",
            "type":"string",
            "description":"The value of a threshold string.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FIELD",
                "VALUE"
            ]
        },
        "color":{
            "maxLength":"60",
            "type":"string",
            "description":"The bubble color is shown in the monitoring charts when the threshold criterion is met.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"Determines the order of a threshold in a list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The logical operator for the threshold. <br />Values are measured against this logic. <br />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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EQUALS",
                "GREATER_THAN",
                "GREATER_THAN_EQUALS",
                "LESS_THAN_EQUALS",
                "NOT_EQUALS",
                "LESS_THAN",
                "BETWEEN",
                "NOT_BETWEEN"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"The maximum value other threshold values are measured against.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"The value which other thresholds are measured against.",
            "format":"double",
            "exampleSetFlag":false
        },
        "columnId":{
            "type":"integer",
            "description":"The unique identifier of a column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "icon":{
            "type":"string",
            "description":"The visual indicator associated with the threshold. <br />The selected icon will display when threshold criteria is met.",
            "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"
            ]
        },
        "thresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnUpperId":{
            "type":"integer",
            "description":"The unique identifier of an upper column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costValueUpper":{
            "type":"number",
            "description":"The cost measured by the threshold. <br />Use threshold operators to compare this value to the values in projects and portfolios.",
            "format":"double",
            "exampleSetFlag":false
        },
        "integerValue":{
            "type":"integer",
            "description":"The numeric value measured by the threshold. <br />Use threshold operators to compare this value to the values in projects and portfolios.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "integerValueUpper":{
            "type":"integer",
            "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\". <br />High Value allows you to set a maximum value other threshold values can be measured against.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValueUpper":{
            "type":"number",
            "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\". <br />High Value allows you to set a maximum value other threshold values can be measured against.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "typeUpper":{
            "type":"string",
            "description":"Thresholds can have a type of Value or Field. <br />Value: Uses the threshold logical operator to measure fields against a set numeric value. <br />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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "FIELD",
                "VALUE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Threshold service.

Back to Top