Jump to

• Request
• Response

Read ProjectThreshold

get

/projectThreshold

Reads Project objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ProjectThreshold>

Type: array

Title: List<ProjectThreshold>

Show Source

• Array of: object ProjectThreshold
  Title: ProjectThreshold

  ProjectThreshold Entity

{
    "title":"List<ProjectThreshold>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectThreshold"
    }
}

Nested Schema : ProjectThreshold

Type: object

Title: ProjectThreshold

ProjectThreshold Entity

Show Source

• CreateDate: string (date-time)
  The date this project threshold was created.
• CreateUser: string
  The name of the user that created this project threshold.
• DetailToMonitor: string
  The level of detail to monitor, either Activity or WBS. The project threshold is calculated at the activity level or at the WBS level, whichever is selected.
• FromDate: string (date-time)
  The starting custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored.
• FromDateExpression: string
  The expression for the starting date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5D, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the FromDate and FromDateExpression fields, the FromDateExpression will be ignored.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IssuePriority: string
  The priority of any issues generated from the project threshold.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this project threshold was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project threshold.
• LowerThreshold: number (double)
  The lower value of a project threshold that will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be less than or equal to the lower project threshold value. If the lower project threshold value is null, it is ignored. Example: The Total Float lower project threshold is set to one day. Whenever the observed total float is less than or equal to one day, a project issue is raised
• ObjectId: integer (int32)
  The unique ID generated by the system.
• OBSObjectId(required): integer (int32)
  The unique ID of the associated OBS for this project threshold.
• ProjectId: string
  The Project short code that uniquely identifies the project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project for this project threshold.
• Status: string
  The current status of the project threshold.
• ThresholdParameterObjectId(required): integer (int32)
  The unique ID of the associated threshold parameter for this project threshold.
• ToDate: string (date-time)
  The ending custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored.
• ToDateExpression: string
  The expression for the ending date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5d, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the ToDate and ToDateExpression fields, the ToDateExpression will be ignored.
• UpperThreshold: number (double)
  The upper value of a project threshold parameter which will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be greater than or equal to the upper project threshold value. If the upper project threshold value is null, it is ignored. Example: The Cost % of Planned upper project threshold is set to 120%. Whenever the actual cost is greater than or equal to 120% of planned, an issue is raised.
• WBSCode: string
  The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.
• WBSName: string
  The name of the WBS element.
• WBSObjectId(required): integer (int32)
  The unique ID of the associated WBS for this project threshold.

{
    "title":"ProjectThreshold",
    "required":[
        "OBSObjectId",
        "ProjectObjectId",
        "ThresholdParameterObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this project threshold was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project threshold."
        },
        "DetailToMonitor":{
            "type":"string",
            "description":"The level of detail to monitor, either Activity or WBS. The project threshold is calculated at the activity level or at the WBS level, whichever is selected."
        },
        "FromDate":{
            "type":"string",
            "description":"The starting custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored.",
            "format":"date-time"
        },
        "FromDateExpression":{
            "type":"string",
            "description":"The expression for the starting date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5D, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the FromDate and FromDateExpression fields, the FromDateExpression will be ignored."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "IssuePriority":{
            "type":"string",
            "description":"The priority of any issues generated from the project threshold."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this project threshold was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project threshold."
        },
        "LowerThreshold":{
            "type":"number",
            "description":"The lower value of a project threshold that will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be less than or equal to the lower project threshold value. If the lower project threshold value is null, it is ignored. Example: The Total Float lower project threshold is set to one day. Whenever the observed total float is less than or equal to one day, a project issue is raised",
            "format":"double"
        },
        "OBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated OBS for this project threshold.",
            "format":"int32"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The Project short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project for this project threshold.",
            "format":"int32"
        },
        "Status":{
            "type":"string",
            "description":"The current status of the project threshold."
        },
        "ThresholdParameterObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated threshold parameter for this project threshold.",
            "format":"int32"
        },
        "ToDate":{
            "type":"string",
            "description":"The ending custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored.",
            "format":"date-time"
        },
        "ToDateExpression":{
            "type":"string",
            "description":"The expression for the ending date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5d, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the ToDate and ToDateExpression fields, the ToDateExpression will be ignored."
        },
        "UpperThreshold":{
            "type":"number",
            "description":"The upper value of a project threshold parameter which will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be greater than or equal to the upper project threshold value. If the upper project threshold value is null, it is ignored. Example: The Cost % of Planned upper project threshold is set to 120%. Whenever the actual cost is greater than or equal to 120% of planned, an issue is raised.",
            "format":"double"
        },
        "WBSCode":{
            "type":"string",
            "description":"The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes."
        },
        "WBSName":{
            "type":"string",
            "description":"The name of the WBS element."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated WBS for this project threshold.",
            "format":"int32"
        }
    },
    "description":"ProjectThreshold Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top