Jump to

• Request
• Response

Update a Work Package

put

/api/restapi/workPackage

Send a request to this endpoint to update a work package.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityWorkPackageInput

Type: object

Title: ApiEntityWorkPackageInput

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

• workPackageId
• workPackageCode,projectId,wbsId
• workPackageCode,projectCode,workspaceCode,wbsId
• workPackageCode,projectId,wbsCodes
• workPackageCode,projectCode,workspaceCode,wbsCodes

Show Source

• activityPercentComplete: number (double)
  Minimum Value: 0

  The percentage complete for all activities assigned to the work package.
• activityWeightMethod: string
  Allowed Values: [ "DURATION", "LABOR_UNITS", "NON_LABOR_UNITS", "MANUAL" ]

  The method used to calculate Activity Percent Complete. Methods are Duration, Labor Units, Non Labor Units, and Manual.
  Duration: Planned Duration, also known as Original Duration, is used for Weight.
  Labor Units: At Completion Labor Units is used for Weight.
  Non Labor Units: At Completion NonLabor Units is used for Weight.
  Manual: Weight is added manually.
• actualHoursToDate: number (double)
  Minimum Value: 0

  The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
  This is the cumulative value for all scope assignments in the work package.
• approvedChangedHours: number (double)
  The sum of all approved change hours in the change and transfer records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package.
• atCompletionHours: number (double)
  Minimum Value: 0

  The total hours expected to be spend at the completion of the scope assignment.
  Calculated as Revised Hours plus Adjusted Hours.
  This is the cumulative value for all scope assignments in the work package.
• bacHours: number (double)
  Minimum Value: 0

  The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
  This is the cumulative value for all scope assignments in the work package.
• baselineFinishDate: string (date-time)
  The planned finish date for the work package as is set in the current baseline.
  This field is populated with the Revised Finish date at the time that the current baseline is set.
• baselineHours: number (double)
  Minimum Value: 0

  The Revised Hours at the time the baseline was set.
  This is the cumulative value for all scope assignments in the work package.
• baselineStartDate: string (date-time)
  The planned start date for the work package as is set in the current baseline.
  This field is populated with the Revised Start date at the time that the current baseline is set.
• budgetCompleteMethod: string
  Allowed Values: [ "REVISED", "AT_COMPLETION" ]

  The setting allows users to select which value to use for populating BAC fields when a baseline is set. Choose At Completion to include adjusted values.
• codeValues: array codeValues
  The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a work package.
• curveId: integer (int64)
  The curve profile used for time phase distribution of scope assignments.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Provides additional details about the work package.
• eacHours: number (double)
  Minimum Value: 0

  The total hours estimated to be earned at the completion of the work package.
  Calculated as ETC Hours plus Actual Hours to Date.
  This is the cumulative value for all scope assignments in the work package.
• eacWithSpendsHours: number (double)
  Calculated as ETC Hours plus Spends Hours for all scope assignments in the work package.
• earnedHours: number (double)
  Minimum Value: 0

  The portion of budgeted hours that is currently earned for the work package.
  Calculated as Performance Percent Complete multiplied by BAC Hours.
  This is the cumulative value for all scope assignments in the work package.
• earnedPercentComplete: number (double)
  Minimum Value: 0

  Calculated as Earned Hours divided by BAC Hours for all scope assignments in the work package.
• effectiveDate: string (date-time)
  The latest Effective Finish date of all scope assignments in the work package.
  This is a read-only field.
• effectiveStartDate: string (date-time)
  The earliest Effective Start date of all scope assignments in the work package.
  This is a read-only field.
• etcAdjustedHours: number (double)
  Minimum Value: 0

  The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
  This is the cumulative value for all scope assignments in the work package.
• etcHours: number (double)
  Minimum Value: 0

  The estimated number of hours needed to complete the work.
  Calculated as BAC Hours minus Earned Hours.
  This is the cumulative value for all scope assignments in the work package.
• installedFinishDate: string (date-time)
  The date work on the work package is complete.
  This is the latest Installed Finish date of all scope assignments in the work package.
• installedHours: number (double)
  Minimum Value: 0

  Hours spent on the scope assignment.
  Calculated as Installed Quantity multiplied by Revised Productivity Rate.
  This is the cumulative value for all scope assignments in the work package.
• installedStartDate: string (date-time)
  The date work on the work package began.
  This is the earliest Installed Start date of all scope assignments in the work package.
• installedUnits: integer (int64)
  Installed quantity of scope assignments in the work package.
• 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.
• manager: integer (int64)
  The manager or person responsible for the work package.
• milestoneProgressType: string
  Allowed Values: [ "SEQUENTIAL", "NON_SEQUENTIAL" ]

  Determines how the milestones are progressed if the Progress Measure is set to Milestone Percent Complete.
  Sequential: Milestones must be progressed in order.
  Non Sequential: Milestones can be progressed in whatever order necessary.
• originalFinishDate(required): string (date-time)
  The date the work on the work package is scheduled to finish.
  This field is populated with the Data Date plus 4 days when the work package is created, but it can be manually modified until the Original Baseline is set.
  If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run.
  If there is no activity link, the field is locked when the original baseline is set.
  If there is an activity link, before the original baseline is set the field is populated with the earliest Planned Finish date of all linked activities. After the baseline is set, the field is locked.
• originalStartDate(required): string (date-time)
  The date the work on the work package is scheduled to begin.
  This field is populated with the Data Date with the work package is created, but it can be manually modified until the Original Baseline is set.
  If the Data Date is specified, Original Start cannot be set to a date earlier than the Data Date. If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start is populated with the Data Date when the Modify Dates feature is run.
  If there is no activity link, this field is locked when the original baseline is set.
  If there is an activity link, before the original baseline is set this field is populated with the earliest Planned Start dates of all linked activities. After the baseline is set, the field is locked.
• pendingChangedHours: number (double)
  Calculated as the sum of all pending hour changes in the change and transfer records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package.
• percentComplete: number (double)
  The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
  The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
  Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
  The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
  Weight for the Manual option is calculated as Manual Weight Factor multiplied by Scope Percent Complete.
  Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Weight divided by the sum of Manual Weight Factors for all scope assignments in the work package.
• percentCompleteMethod: string
  Allowed Values: [ "MILESTONE_PERCENT_COMPLETE", "PHYSICAL_PERCENT_COMPLETE" ]

  The method used to measure progress.
  Milestone Percent Complete: This option uses a selected Rule of Credit to measure progress.
  Physical Percent Complete: This option allows users to manually enter Installed Quantity for scope assignments.
• percentCompleteWeightedBy: string
  Allowed Values: [ "COST", "QUANTITY", "HOURS", "MANUAL" ]

  The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
  The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
  Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
  The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
  Completed Weight for the Manual option is calculated as Manual Weight multiplied by Scope Percent Complete.
  Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Completed Weight divided by the sum of Manual Weight for all scope assignments in the work package.
• plannedFinishDate: string (date-time)
  The date the work on the work package is scheduled to finish.
  If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
  If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
  If there is an activity link, this field is populated with the latest Planned Finish date of all activities in the work package.
• plannedHours: number (double)
  Minimum Value: 0

  The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
  Calculated as Original Quantity multiplied by Original Productivity Rate.
  Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.
  This is the cumulative value for all scope assignments in the work package.
• plannedStartDate: string (date-time)
  The date the work on the work package is scheduled to begin.
  If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
  If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
  If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
  If there is an activity link, this field is populated with the earliest Planned Start date of all the activities in the work package.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• remainingEarlyFinishDate: string (date-time)
  The earliest date the work on the work package is scheduled to finish.
  If there is no activity link, this field is populated with the latest Remaining Early Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated the Original Finish date before the original baseline is set and the Revised Finish date after the original baseline is set.
  This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
  If there is an activity linked, this field is populated with the latest Remaining Early Finish date of all linked activities.
• remainingEarlyStartDate: string (date-time)
  The earliest date the work on the work package is scheduled to begin.
  If the work package does not have scope assignments, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, it inherits the Data Date when the Modify Dates feature is run if the work package's Scope Percent Complete is not equal to 100%.
  This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
  If there is any activity linked, this field is populated with the earliest Remaining Early Start date of all linked activities.
• remainingHours: number (double)
  Minimum Value: 0

  The number of hours left for the scope assignment.
  Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
  This is the cumulative value for all scope assignments in the work package.
• remainingLateFinishDate: string (date-time)
  The latest possible date work on the work package must finish to not delay the finish date.
  If there is no activity link, this field is populated with the latest Remaining Late Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated with the Remaining Early Finish date.
  If there is an activity linked, this field is populated with the latest Remaining Late Finish date of all linked activities.
• remainingLateStartDate: string (date-time)
  The latest possible date work on the work package must begin without delaying the finish date.
  If there is no activity link, this field is always equal to the Remaining Late Start date of all scope assignments in the work package. If the work package does not have scope assignments, this field is populated with the Remaining Early Start date.
  If there is any activity linked, this field is populated with the earliest Remaining Late Start date of all activities.
• revisedFinishDate: string (date-time)
  The revised finish date for the work package.
  If the work package does not have scope assignments, this field is populated with the Original Finish date until the original baseline is set.
  When the Modify Dates feature is run after the original baseline is set, the Revised Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, the Revised Finish date is updated to be the same date relative to the Revised Start date as it was before the Data Date was modified.
  If the work package has scope assignments, the date is always the latest finish of its scope assignments' Planned Finish dates and all approved Change Finish dates.
• revisedHours: number (double)
  Minimum Value: 0

  Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
  This is the cumulative value for all scope assignments in the work package.
• revisedStartDate: string (date-time)
  The revised start date for the work package.
  If the work package does not have scope assignments, this field is populated with the Original Start date until the original baseline is set.
  This field is populated with the Data Date when the Modify Dates feature is run after the original baseline is set if the Revised Start date is before the Data Date and the work package's Scope Percent Complete is equal to 0%.
  If the work package has scope assignments, is always the earliest start of its scope assignments' Planned Start dates and all approved Change Start dates.
• ruleOfCredit: ruleOfCredit
  The name of the rule of credit which includes a set of milestones for which progress is measured.
• spendsHours: number (double)
  Minimum Value: 0

  Calculated as the sum of Actual Hours to Date for all scope assignments in the work package.
• status: string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]

  The status of the work package.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• wbsCodes: array wbsCodes
  The list of WBS codes in a hierarchy of a work package.
• wbsId(required): integer (int64)
  The unique identifier for the wbs.The wbs object can also be identified by its unique criteria.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workPackageCost: workPackageCost
  Deprecated. As of 23.12.
  The cost of the work package.
• workPackageId: integer (int64)
  The ID for the work package.
• workPackageName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the work package.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified unique identifier of the workspace.

{
    "title":"ApiEntityWorkPackageInput",
    "required":[
        "originalFinishDate",
        "originalStartDate",
        "projectId",
        "wbsId",
        "workPackageName"
    ],
    "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"
            ]
        },
        "installedUnits":{
            "type":"integer",
            "description":"Installed quantity of scope assignments in the work package.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED",
                "WITHDRAW_APPROVAL",
                "REOPEN"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Provides additional details about the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "etcAdjustedHours":{
            "minimum":"0",
            "type":"number",
            "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "effectiveDate":{
            "type":"string",
            "description":"The latest Effective Finish date of all scope assignments in the work package. <br />This is a read-only field.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "manager":{
            "type":"integer",
            "description":"The manager or person responsible for the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a work package.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkPackageConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueWorkPackageInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedFinishDate":{
            "type":"string",
            "description":"The date the work on the work package is scheduled to finish. <br />If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set. <br />If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run. <br />If there is an activity link, this field is populated with the latest Planned Finish date of all activities in the work package.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateStartDate":{
            "type":"string",
            "description":"The latest possible date work on the work package must begin without delaying the finish date. <br />If there is no activity link, this field is always equal to the Remaining Late Start date of all scope assignments in the work package. If the work package does not have scope assignments, this field is populated with the Remaining Early Start date. <br />If there is any activity linked, this field is populated with the earliest Remaining Late Start date of all activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateFinishDate":{
            "type":"string",
            "description":"The latest possible date work on the work package must finish to not delay the finish date. <br />If there is no activity link, this field is populated with the latest Remaining Late Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated with the Remaining Early Finish date. <br />If there is an activity linked, this field is populated with the latest Remaining Late Finish date of all linked activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityPercentComplete":{
            "minimum":"0",
            "type":"number",
            "description":"The percentage complete for all activities assigned to the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedStartDate":{
            "type":"string",
            "description":"The date the work on the work package is scheduled to begin. <br />If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set. <br />If the Data Date is specified, the date cannot be set to a date earlier than the Data Date. <br />If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run. <br />If there is an activity link, this field is populated with the earliest Planned Start date of all the activities in the work package.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "wbsId":{
            "type":"integer",
            "description":"The unique identifier for the wbs.The wbs object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workPackageId":{
            "type":"integer",
            "description":"The ID for the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workPackageName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "percentCompleteWeightedBy":{
            "type":"string",
            "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow. <br />The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete. <br />Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity. <br />The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n. <br />Completed Weight for the Manual option is calculated as Manual Weight multiplied by Scope Percent Complete. <br />Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Completed Weight divided by the sum of Manual Weight for all scope assignments in the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "COST",
                "QUANTITY",
                "HOURS",
                "MANUAL"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified unique identifier of the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ruleOfCredit":{
            "description":"The name of the rule of credit which includes a set of milestones for which progress is measured.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput"
                }
            ]
        },
        "workPackageCost":{
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The cost of the work package.",
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWorkPackageCostInput"
                }
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The curve profile used for time phase distribution of scope assignments.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"The earliest Effective Start date of all scope assignments in the work package. <br />This is a read-only field.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "bacHours":{
            "minimum":"0",
            "type":"number",
            "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "eacHours":{
            "minimum":"0",
            "type":"number",
            "description":"The total hours estimated to be earned at the completion of the work package. <br />Calculated as ETC Hours plus Actual Hours to Date. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedHours":{
            "minimum":"0",
            "type":"number",
            "description":"The portion of budgeted hours that is currently earned for the work package. <br />Calculated as Performance Percent Complete multiplied by BAC Hours. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "etcHours":{
            "minimum":"0",
            "type":"number",
            "description":"The estimated number of hours needed to complete the work. <br />Calculated as BAC Hours minus Earned Hours. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualHoursToDate":{
            "minimum":"0",
            "type":"number",
            "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done). <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "approvedChangedHours":{
            "type":"number",
            "description":"The sum of all approved change hours in the change and transfer records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionHours":{
            "minimum":"0",
            "type":"number",
            "description":"The total hours expected to be spend at the completion of the scope assignment. <br />Calculated as Revised Hours plus Adjusted Hours. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselineHours":{
            "minimum":"0",
            "type":"number",
            "description":"The Revised Hours at the time the baseline was set. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "installedHours":{
            "minimum":"0",
            "type":"number",
            "description":"Hours spent on the scope assignment. <br />Calculated as Installed Quantity multiplied by Revised Productivity Rate. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedHours":{
            "type":"number",
            "description":"Calculated as the sum of all pending hour changes in the change and transfer records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingHours":{
            "minimum":"0",
            "type":"number",
            "description":"The number of hours left for the scope assignment. <br />Calculated as Remaining Quantity multiplied by Revised Productivity Rate. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedHours":{
            "minimum":"0",
            "type":"number",
            "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "minimum":"0",
            "type":"number",
            "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment. <br />Calculated as Original Quantity multiplied by Original Productivity Rate. <br />Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity. <br />This is the cumulative value for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingEarlyStartDate":{
            "type":"string",
            "description":"The earliest date the work on the work package is scheduled to begin. <br />If the work package does not have scope assignments, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, it inherits the Data Date when the Modify Dates feature is run if the work package's Scope Percent Complete is not equal to 100%. <br />This field is blank when the scope assignment's Scope Percent Complete becomes 100%. <br />If there is any activity linked, this field is populated with the earliest Remaining Early Start date of all linked activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "percentComplete":{
            "type":"number",
            "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow. <br />The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete. <br />Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity. <br />The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n. <br />Weight for the Manual option is calculated as Manual Weight Factor multiplied by Scope Percent Complete. <br />Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Weight divided by the sum of Manual Weight Factors for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedPercentComplete":{
            "minimum":"0",
            "type":"number",
            "description":"Calculated as Earned Hours divided by BAC Hours for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalStartDate":{
            "type":"string",
            "description":"The date the work on the work package is scheduled to begin. <br />This field is populated with the Data Date with the work package is created, but it can be manually modified until the Original Baseline is set. <br />If the Data Date is specified, Original Start cannot be set to a date earlier than the Data Date. If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start is populated with the Data Date when the Modify Dates feature is run. <br />If there is no activity link, this field is locked when the original baseline is set. <br />If there is an activity link, before the original baseline is set this field is populated with the earliest Planned Start dates of all linked activities. After the baseline is set, the field is locked.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "originalFinishDate":{
            "type":"string",
            "description":"The date the work on the work package is scheduled to finish. <br />This field is populated with the Data Date plus 4 days when the work package is created, but it can be manually modified until the Original Baseline is set. <br />If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run. <br />If there is no activity link, the field is locked when the original baseline is set. <br />If there is an activity link, before the original baseline is set the field is populated with the earliest Planned Finish date of all linked activities. After the baseline is set, the field is locked.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "revisedStartDate":{
            "type":"string",
            "description":"The revised start date for the work package. <br />If the work package does not have scope assignments, this field is populated with the Original Start date until the original baseline is set. <br />This field is populated with the Data Date when the Modify Dates feature is run after the original baseline is set if the Revised Start date is before the Data Date and the work package's Scope Percent Complete is equal to 0%. <br />If the work package has scope assignments, is always the earliest start of its scope assignments' Planned Start dates and all approved Change Start dates.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "revisedFinishDate":{
            "type":"string",
            "description":"The revised finish date for the work package. <br />If the work package does not have scope assignments, this field is populated with the Original Finish date until the original baseline is set. <br />When the Modify Dates feature is run after the original baseline is set, the Revised Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, the Revised Finish date is updated to be the same date relative to the Revised Start date as it was before the Data Date was modified. <br />If the work package has scope assignments, the date is always the latest finish of its scope assignments' Planned Finish dates and all approved Change Finish dates.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedStartDate":{
            "type":"string",
            "description":"The date work on the work package began. <br />This is the earliest Installed Start date of all scope assignments in the work package.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedFinishDate":{
            "type":"string",
            "description":"The date work on the work package is complete. <br />This is the latest Installed Finish date of all scope assignments in the work package.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingEarlyFinishDate":{
            "type":"string",
            "description":"The earliest date the work on the work package is scheduled to finish. <br />If there is no activity link, this field is populated with the latest Remaining Early Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated the Original Finish date before the original baseline is set and the Revised Finish date after the original baseline is set. <br />This field is blank when the scope assignment's Scope Percent Complete becomes 100%. <br />If there is an activity linked, this field is populated with the latest Remaining Early Finish date of all linked activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineStartDate":{
            "type":"string",
            "description":"The planned start date for the work package as is set in the current baseline. <br />This field is populated with the Revised Start date at the time that the current baseline is set.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineFinishDate":{
            "type":"string",
            "description":"The planned finish date for the work package as is set in the current baseline. <br />This field is populated with the Revised Finish date at the time that the current baseline is set.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendsHours":{
            "minimum":"0",
            "type":"number",
            "description":"Calculated as the sum of Actual Hours to Date for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "eacWithSpendsHours":{
            "type":"number",
            "description":"Calculated as ETC Hours plus Spends Hours for all scope assignments in the work package.",
            "format":"double",
            "exampleSetFlag":false
        },
        "activityWeightMethod":{
            "type":"string",
            "description":"The method used to calculate Activity Percent Complete. Methods are Duration, Labor Units, Non Labor Units, and Manual. <br />Duration: Planned Duration, also known as Original Duration, is used for Weight. <br />Labor Units: At Completion Labor Units is used for Weight. <br />Non Labor Units: At Completion NonLabor Units is used for Weight. <br />Manual: Weight is added manually.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DURATION",
                "LABOR_UNITS",
                "NON_LABOR_UNITS",
                "MANUAL"
            ]
        },
        "budgetCompleteMethod":{
            "type":"string",
            "description":"The setting allows users to select which value to use for populating BAC fields when a baseline is set. Choose At Completion to include adjusted values.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "REVISED",
                "AT_COMPLETION"
            ]
        },
        "percentCompleteMethod":{
            "type":"string",
            "description":"The method used to measure progress. <br />Milestone Percent Complete: This option uses a selected Rule of Credit to measure progress. <br />Physical Percent Complete: This option allows users to manually enter Installed Quantity for scope assignments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MILESTONE_PERCENT_COMPLETE",
                "PHYSICAL_PERCENT_COMPLETE"
            ]
        },
        "milestoneProgressType":{
            "type":"string",
            "description":"Determines how the milestones are progressed if the Progress Measure is set to Milestone Percent Complete. <br />Sequential: Milestones must be progressed in order. <br />Non Sequential: Milestones can be progressed in whatever order necessary.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SEQUENTIAL",
                "NON_SEQUENTIAL"
            ]
        },
        "wbsCodes":{
            "type":"array",
            "description":"The list of WBS codes in a hierarchy of a work package.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "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 WorkPackage object, a unique WorkPackage object can be identified by the following combinations of the fields.<ul><li>workPackageId</li><li>workPackageCode,projectId,wbsId</li><li>workPackageCode,projectCode,workspaceCode,wbsId</li><li>workPackageCode,projectId,wbsCodes</li><li>workPackageCode,projectCode,workspaceCode,wbsCodes</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueWorkPackageInput
  Title: ApiEntityCodeValueWorkPackageInput

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

  • codeValueWorkPackageId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "type":"array",
    "description":"The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueWorkPackageInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a work package.

Show Source

• Array of: object ApiEntityWorkPackageConfiguredFieldValueInput
  Title: ApiEntityWorkPackageConfiguredFieldValueInput

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

  • workPackageConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a work package.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkPackageConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ruleOfCredit

The name of the rule of credit which includes a set of milestones for which progress is measured.

Match All

Show Source

• object ApiEntityRuleOfCreditInput
  Title: ApiEntityRuleOfCreditInput

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

  • rocId
  • rocName,workspaceId
  • rocName,workspaceCode

{
    "description":"The name of the rule of credit which includes a set of milestones for which progress is measured.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput"
        }
    ]
}

Nested Schema : wbsCodes

Type: array

The list of WBS codes in a hierarchy of a work package.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of WBS codes in a hierarchy of a work package.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : workPackageCost

Deprecated. As of 23.12.
The cost of the work package.

Match All

Show Source

• object ApiEntityWorkPackageCostInput
  Title: ApiEntityWorkPackageCostInput

{
    "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The cost of the work package.",
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWorkPackageCostInput"
        }
    ]
}

Nested Schema : ApiEntityCodeValueWorkPackageInput

Type: object

Title: ApiEntityCodeValueWorkPackageInput

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

• codeValueWorkPackageId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  Deprecated. As of 23.11.
  The name of a code or value.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueWorkPackageId: integer (int64)
  The unique identifier of a work package code value.
• 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.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• sequenceNumber: integer (int32)
  Deprecated. As of 23.11.
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workPackageId: integer (int64)
  The unique identifier of a work package.

{
    "title":"ApiEntityCodeValueWorkPackageInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "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"
            ]
        },
        "workPackageId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueWorkPackageId":{
            "type":"integer",
            "description":"The unique identifier of a work package code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "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"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of a code or value.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueWorkPackage object, a unique CodeValueWorkPackage object can be identified by the following combinations of the fields.<ul><li>codeValueWorkPackageId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkPackageConfiguredFieldValueInput

Type: object

Title: ApiEntityWorkPackageConfiguredFieldValueInput

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

• workPackageConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• 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
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workPackageConfiguredFieldValueId: integer (int64)
  The unique identifier for the Work Package Configured Field.
• workPackageId: integer (int64)
  The ID for the work package.

{
    "title":"ApiEntityWorkPackageConfiguredFieldValueInput",
    "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"
            ]
        },
        "workPackageId":{
            "type":"integer",
            "description":"The ID for the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workPackageConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Work Package Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a WorkPackageConfiguredFieldValue object, a unique WorkPackageConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>workPackageConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRuleOfCreditInput

Type: object

Title: ApiEntityRuleOfCreditInput

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

• rocId
• rocName,workspaceId
• rocName,workspaceCode

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 23.12.
  The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited.
• 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.
• milestones(required): array milestones
  The milestones associated with the rule of credit.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the rule of credit.
• rocId: integer (int64)
  Unique identifier of the rule of credit.
• rocName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the rule of credit.
• type: string
  Allowed Values: [ "MANUAL", "ZERO_TO_ONE_HUNDRED" ]

  Determines how each milestone in a rule of credit can be progressed.
  Manual: Allows partial completion of a milestone, entered as a percentage.
  0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.
• 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.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityRuleOfCreditInput",
    "required":[
        "milestones",
        "rocName",
        "workspaceId"
    ],
    "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"
            ]
        },
        "type":{
            "type":"string",
            "description":"Determines how each milestone in a rule of credit can be progressed. <br />Manual: Allows partial completion of a milestone, entered as a percentage. <br />0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "ZERO_TO_ONE_HUNDRED"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "milestones":{
            "type":"array",
            "description":"The milestones associated with the rule of credit.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 RuleOfCredit object, a unique RuleOfCredit object can be identified by the following combinations of the fields.<ul><li>rocId</li><li>rocName,workspaceId</li><li>rocName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : milestones

Type: array

The milestones associated with the rule of credit.

Show Source

• Array of: object ApiEntityRuleOfCreditMilestoneInput
  Title: ApiEntityRuleOfCreditMilestoneInput

{
    "type":"array",
    "description":"The milestones associated with the rule of credit.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRuleOfCreditMilestoneInput

Type: object

Title: ApiEntityRuleOfCreditMilestoneInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.12.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• milestoneId: integer (int64)
  Unique identifier of the rule of credit milestone.
• milestoneName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the milestone for the rule of credit.
• percentComplete(required): number (double)
  Minimum Value: 0

  Maximum Value: 1

  The percentage of work to be completed for the milestone in relation to the entire rule of credit.
• ruleOfCreditId: integer (int64)
  The unique identifier of a rule of credit.
• sequenceNumber(required): integer (int32)
  The number that specifies the position of a milestone in a milestone list.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityRuleOfCreditMilestoneInput",
    "required":[
        "milestoneName",
        "percentComplete",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of a milestone in a milestone list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ruleOfCreditId":{
            "type":"integer",
            "description":"The unique identifier of a rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "percentComplete":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The percentage of work to be completed for the milestone in relation to the entire rule of credit.",
            "format":"double",
            "exampleSetFlag":false
        },
        "milestoneName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the milestone for the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "milestoneId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkPackageCostInput

Type: object

Title: ApiEntityWorkPackageCostInput

Show Source

• actualCostToDate: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.
• actualCostToDateProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• adjustedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.
• adjustedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• approvedChangedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The sum of all approved cost changes in the change records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.
• approvedChangedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The sum of all approved cost changes in the change records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• atCompletionCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost at the completion of the scope assignment.
  Calculated as Revised Cost plus Adjusted Cost.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.
• atCompletionCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost at the completion of the scope assignment.
  Calculated as Revised Cost plus Adjusted Cost.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• bacCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.
• bacCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• baselineCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Revised Cost at the time the current baseline was set.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.
• baselineCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Revised Cost at the time the current baseline was set.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• eacCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost estimated to be earned as the completion of the work package.
  Calculated as ETC Cost plus Actual Cost to Date.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.
• eacCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost estimated to be earned as the completion of the work package.
  Calculated as ETC Cost plus Actual Cost to Date.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• eacWithSpendsCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as ETC Cost plus Spends Cost for all scope assignments in the work package. This field is in base currency and is calculated from eacWithSpendsCostProject field based on the specified exchange rate.
• eacWithSpendsCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as ETC cost plus spends cost for all scope assignments in the work package. This value is based on the project currency.
• earnedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The portion of the budgeted cost that is currently earned for the work package.
  Calculated as Performance Percent Complete multiplied by BAC Cost.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.
• earnedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The portion of the budgeted cost that is currently earned for the work package.
  Calculated as Performance Percent Complete multiplied by BAC Cost.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• etcCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The estimate of the cost needed to complete the work.
  Calculated as BAC Cost minus Earned Cost.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.
• etcCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The estimate of the cost needed to complete the work.
  Calculated as BAC Cost minus Earned Cost.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• installedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost incurred on the scope assignment as of the current date.
  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.
• installedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The total cost incurred on the scope assignment as of the current date.
  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.
  This is the cumulative value for all scope assignments in the work package. of a project. This value is based on the project currency.
• 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.
• pendingChangedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as the sum of all pending cost changes in the change records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.
• pendingChangedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as the sum of all pending cost changes in the change records for the scope assignment.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• plannedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The original cost of the scope assignment.
  If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
  If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The original cost of the scope assignment.
  If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
  If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• remainingCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The amount left to be spent.
  If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.
• remainingCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The amount left to be spent.
  If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
  If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• revisedCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.
  This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.
• revisedCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.
  This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.
• spendsCost: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as the sum of Actual Cost to Date for all scope assignments in the work package. This field is in base currency and is calculated from spendsCostProject field based on the specified exchange rate.
• spendsCostProject: number (double)
  Read Only: true

  Deprecated. As of 23.12.
  Calculated as the sum of actual cost to date for all scope assignments in the work package. This value is based on the project currency.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workPackageId: integer (int64)
  Read Only: true

  Deprecated. As of 23.12.
  The ID for the work package.

{
    "title":"ApiEntityWorkPackageCostInput",
    "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"
            ]
        },
        "workPackageId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The ID for the work package.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "remainingCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The amount left to be spent. <br />If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The original cost of the scope assignment. <br />If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours. <br />If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "atCompletionCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost at the completion of the scope assignment. <br />Calculated as Revised Cost plus Adjusted Cost. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "atCompletionCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost at the completion of the scope assignment. <br />Calculated as Revised Cost plus Adjusted Cost. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The original cost of the scope assignment. <br />If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours. <br />If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "remainingCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The amount left to be spent. <br />If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate. <br />If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "earnedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The portion of the budgeted cost that is currently earned for the work package. <br />Calculated as Performance Percent Complete multiplied by BAC Cost. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "eacCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost estimated to be earned as the completion of the work package. <br />Calculated as ETC Cost plus Actual Cost to Date. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "bacCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "etcCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The estimate of the cost needed to complete the work. <br />Calculated as BAC Cost minus Earned Cost. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "bacCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "etcCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The estimate of the cost needed to complete the work. <br />Calculated as BAC Cost minus Earned Cost. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "eacCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost estimated to be earned as the completion of the work package. <br />Calculated as ETC Cost plus Actual Cost to Date. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "earnedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The portion of the budgeted cost that is currently earned for the work package. <br />Calculated as Performance Percent Complete multiplied by BAC Cost. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostToDate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "approvedChangedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The sum of all approved cost changes in the change records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "revisedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pendingChangedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as the sum of all pending cost changes in the change records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency. ",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "installedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost incurred on the scope assignment as of the current date. <br />If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. <br />If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. <br />This is the cumulative value for all scope assignments in the work package. of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "approvedChangedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The sum of all approved cost changes in the change records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "installedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The total cost incurred on the scope assignment as of the current date. <br />If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. <br />If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "pendingChangedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as the sum of all pending cost changes in the change records for the scope assignment. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "baselineCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Revised Cost at the time the current baseline was set. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "adjustedCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "revisedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostToDateProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "baselineCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The Revised Cost at the time the current baseline was set. <br />This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "adjustedCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. <br />This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendsCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as the sum of Actual Cost to Date for all scope assignments in the work package. This field is in base currency and is calculated from spendsCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendsCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as the sum of <b>actual cost to date</b> for all scope assignments in the work package. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "eacWithSpendsCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as ETC Cost plus Spends Cost for all scope assignments in the work package. This field is in base currency and is calculated from eacWithSpendsCostProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "eacWithSpendsCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Calculated as <b>ETC cost</b> plus <b>spends cost</b> for all scope assignments in the work package. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update a Work Package

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Work Package Change Request Service.

Back to Top