Jump to

• Request
• Response

View all Scope Item Assignments by Project

get

/api/restapi/scopeItemAssignment/project/{projectId}

This endpoint returns scope item assignments that meet the following requirements:

• The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.

Request

Path Parameters

• projectId(required): integer(int64)
  The system-generated identifier of a project.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityScopeItemAssignment>

Type: array

Title: List<ApiEntityScopeItemAssignment>

Show Source

• Array of: object ApiEntityScopeItemAssignment
  Title: ApiEntityScopeItemAssignment

{
    "title":"List<ApiEntityScopeItemAssignment>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeItemAssignment",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScopeItemAssignment

Type: object

Title: ApiEntityScopeItemAssignment

Show Source

• actualHoursToDate: number (double)
  Minimum Value: 0

  The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
• actualUnitsToDate: integer (int64)
  The Installed Quantity for the scope assignment.
• approvedChangedHours: number (double)
  The sum of all approved change hours in the change and transfer records for the scope assignment.
• approvedChangedUnits: integer (int64)
  Calculated as the sum of all approved change quantities in the change records for the scope assignment.
• atCompletionHours: number (double)
  The total hours expected for the scope assignment.
  Calculated as Revised Hours plus Adjusted Hours.
• atCompletionUnits: integer (int64)
  The total amount of the scope item to be installed for the scope assignment.
  Calculated as Revised Quantity plus Adjusted Quantity.
• availableHours: number (double)
  The number of hours available for scope assignment.
  Calculated as Revised Hours minus Installed Hours.
• availableUnits: integer (int64)
  Minimum Value: 0

  The amount of material or product available for scope assignment.
  Calculated as Revised Quantity minus Installed Quantity.
• bacHours: number (double)
  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.
• bacUnits: integer (int64)
  The Revised Quantity or At Completion Quantity at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Quantity of the current project if no baseline is set.
• baselineFinishDate: string (date-time)
  The planned finish date for the scope assignment as is set in the current baseline.
  This field is used to spread baseline data fields.
  This field is populated with the Revised Finish date at the time that the current baseline is set.
  If there is an activity link, this field is populated with the activity's Current BL Finish date.
• baselineHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  The Revised Hours at the time the baseline was set.
• baselineStartDate: string (date-time)
  The planned start date for the scope assignment as is set in the current baseline.
  This field is used to spread baseline data fields.
  This field is populated with the Revised Start date at the time that the current baseline is set.
  If there is an activity link, this field is populated with the activity's Current BL Start date.
• baselineUnits: integer (int64)
  Minimum Value: 0

  The Revised Quantity at the time the current baseline was set.
• cbsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
• cbsCodes: array cbsCodes
  Deprecated. As of 23.11.
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• cbsSheetCodeId: integer (int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
• configuredFields: array configuredFields
  The list of configured fields for a scope item assignment.
• costCategoryAbbr: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviation for the cost category name.
• costCategoryId: integer (int64)
  The system-generated identifier of a cost category.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category.
• costCategoryType: string
  Allowed Values: [ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ]

  The classification of the cost category.
  Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
  Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
  Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
  Other: Cost is manually entered as a lump sum.
• currentHoursPerUnit: number (double)
  The number of hours it will take to install or assemble the product or material per unit based on current values.
  Calculated as Revised Hours divided by Revised Quantity.
  This value is recalculated if Revised Quantity or Revised Hours are changed.
• curve: integer (int64)
  The curve profile selected for the scope assignment.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional details for the scope assignment.
• eacHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  Calculated as ETC Hours plus Actual Hours to Date.
• eacUnits: integer (int64)
  Minimum Value: 0

  The estimate of how much material or product will be installed at completion of the scope assignment work.
  Calculated as ETC Quantity plus Actual Quantity to Date.
• earnedHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  Calculated as Performance Percent Complete multiplied by BAC Hours.
• earnedPercentComplete: number (double)
  Minimum Value: 0

  Calculated as Installed Quantity divided by At Completion Quantity.
• earnedUnits: integer (int64)
  Minimum Value: 0

  The amount of material or product that has been installed based on the Performance Percent Complete of the scope assignment and the Budget At Completion Quantity.
  Calculated as Performance Percent Complete multiplied by BAC Quantity.
• effectiveDate: string (date-time)
  The latest date of all Actual to Date and Actual Cost to Date values for the scope assignment.
  This is a read-only field.
• effectiveStartDate: string (date-time)
  The earliest date of all Actual Hours to Date and Actual Cost to Date values for the scope assignment.
  This is a read-only field.
• etcAdjustedHours: number (double)
  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.
• etcAdjustedUnits: integer (int64)
  The scope assignment quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
• etcHours: number (double)
  The estimated number of hours needed to complete the work.
  Calculated as BAC Hours minus Earned Hours.
• etcUnits: integer (int64)
  The estimate of how much quantity is needed to complete the work.
  Calculated as BAC Quantity minus Earned Quantity.
• hoursPerUnit: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  The number of hours it takes to install or assemble the product or material per unit. Defaults to the scope item's Original Productivity Rate, but can be updated for each scope item assignment.
  Calculated as Original Hours divided by Original Quantity.
  If this field is updated, Original Hours is recalculated to equal Original Quantity multiplied by Original Productivity Rate.
• installedFinishDate: string (date-time)
  The date work on the scope assignment completed.
  The latest date of all Installed Quantity values for the scope assignment when Scope Percent Complete equals 100%.
  This field is used to spread Installed data fields.
• installedHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  Hours spent on the scope assignment.
  Calculated as Installed Quantity multiplied by Revised Productivity Rate.
• installedStartDate: string (date-time)
  The date work on the scope assignment began.
  This is the earliest date of all Installed Quantity values for the scope assignment.
  This field is used to spread Installed data fields.
• installedUnits: integer (int64)
  Minimum Value: 0

  The amount of material or product that has been installed to date.
  If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete.
  This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.
• lastInstalledDate: string (date-time)
  The date on which the work package was last installed.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• managerId: integer (int64)
  The manager or person responsible for providing status on the scope assignment.
• manualWeight: number (double)
  Calculated as Scope Percent Complete multiplied by Manual Weight.
• manualWeightFactor: number (double)
  The value used to calculate manual completed weight when progress needs to be weighed against a factor other than quantity, hours, or cost.
  This is a manual entry field when Scope Percent Complete Weight Method is set to Manual.
• milestoneProgressPercent: number (double)
  Minimum Value: 0

  The percentage complete for all milestones for the scope assignment. The calculation is based on the user entered percentage complete for the milestone and the rules defined for the milestone calculations.
• milestones: array milestones
  The milestones of a scope assignment.
• originalFinishDate: string (date-time)
  The date the work on the scope assignment is scheduled to finish.
  This field is populated with the work package's Original Finish date, but it can be manually modified until the original baseline is set.
  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 activity's Planned Finish. After the baseline is set, the field is locked.
  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.
• originalStartDate: string (date-time)
  The date the work on the scope assignment is scheduled to begin.
  This field is populated with its work package's Original Start, but can be manually modified until the original baseline is set.
  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 activity's Planned Start. After the baseline is set, the field is locked.
  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 Original Start date is set and the Original Start date is before the Data Date, the Original Start date inherits the Data Date when the Modify Dates feature is run.
• pendingChangedHours: number (double)
  Calculated as the sum of all pending hour changes in the change records for the scope assignment.
• pendingChangedUnits: integer (int64)
  The sum of all pending change quantities in the change records for the scope assignment.
• percentComplete: number (double)
  Minimum Value: 0

  Calculated as Installed Quantity divided by At Completion Quantity.
• plannedFinishDate: string (date-time)
  The date the work on the scope assignment is scheduled to finish.
  This field is used to spread original data fields.
  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 activity's Planned Finish date.
• plannedHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  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.
• plannedStartDate: string (date-time)
  The date the work on the scope assignment is scheduled to begin.
  This field is used to spread original data fields.
  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 activity's Planned Start date.
• plannedUnits: integer (int64)
  Minimum Value: 0

  The expected amount of material or product required.
• progressStatus: string
  Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ]

  The current status of a scope assignment.
  Not Started: Work using the scope assignment has not begun.
  In Progress: The work is in progress.
  Completed: The work has been completed.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• rateBy: string
  Allowed Values: [ "HOURS", "QUANTITY" ]

  Determines whether the cost is calculated using the Quantity or Hours.
  Quantity: Quantity is used to calculate cost. For example, Original Cost is calculated as Original Quantity times Original Cost Rate.
  Hours: Hours are used to calculate cost. For example, Original Cost is calculated as Original Hours times Original Cost Rate.
• remainingEarlyFinishDate: string (date-time)
  The earliest date the work on the scope assignment is scheduled to finish.
  If there is no activity link, before the original baseline is set, this field is populated with the Original Finish date. After the original baseline is set, this field is populated with the Revised Finish date.
  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 activity's Remaining Early Finish date.
  This field is used to spread Remaining data fields.
• remainingEarlyStartDate: string (date-time)
  The earliest date the work on the scope assignment is scheduled to begin.
  If there is no activity link, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, this field is populated with the Data Date when the Modify Dates feature is run if the scope assignment'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 activity's Remaining Early Start date.
  This field is used to spread Remaining data fields.
• remainingHours: number (double)
  The number of hours left for the scope assignment.
  Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
• remainingLateFinishDate: string (date-time)
  The latest possible date work on the scope assignment must finish to not delay the finish date.
  If there is no activity link, this field is always equal to the Remaining Early Finish date.
  If there is any activity linked, this field is populated with the activity's Remaining Late Finish date.
  This field is used to spread Remaining data fields.
• remainingLateStartDate: string (date-time)
  The latest possible date work on the scope assignment must begin without delaying the finish date.
  If there is no activity link, this field is always equal to the Remaining Early Start date.
  If there is any activity link, this field is populated with the activity's Remaining Late Start date.
  This field is used to spread Remaining data fields.
• remainingUnits: integer (int64)
  The quantity remaining for the scope assignment.
  Calculated as Revised Quantity minus Installed Quantity.
• revisedFinishDate: string (date-time)
  The revised finish date for the scope assignment.
  It is always the latest finish of the scope assignment's Planned Finish date and all approved Change Finish dates.
  This field is used to spread Revised data fields.
• revisedHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
• revisedStartDate: string (date-time)
  The revised start date for the scope assignment.
  It is always the earliest start of the scope assignment's Planned Start date and all approved Change Start dates.
  This field is used to spread Revised data fields.
• revisedUnits: integer (int64)
  Minimum Value: 0

  The total quantity that has been revised to account for approved changes for a scope assignment. This value equals the Original Quantity before the original baseline is set.
  Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.
• scopeItemAssignmentCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentCodeValue: array scopeItemAssignmentCodeValue
  The list of code values for a scope item assignment. This entity can only be used to assign codeValues or create codeValues on the fly.
• scopeItemAssignmentCost: scopeItemAssignmentCost
  An object containing scope assignment cost fields.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• scopeItemId: integer (int64)
  The unique identifier for the scope item.The scope item object can also be identified by its unique criteria.
• status: string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]

  The status of a work package.
• updateDate: string (date-time)
  Date when the record was last updated.
• weightedCost: number (double)
  Minimum Value: 0

  This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost.
  Calculated as Scope Percent Complete times Revised Cost. This field is in base currency and is calculated from weightedCostProject field based on the specified exchange rate.
• weightedCostProject: number (double)
  Minimum Value: 0

  This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost. Calculated as Scope Percent Complete times Revised Cost. This value is based on the project currency.
• weightedHours: number (double)
  Minimum Value: 0

  Maximum Value: 1000000000

  This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Hours.
  Calculated as Scope Percent Complete times Revised Hours.
• weightedUnits: integer (int64)
  Minimum Value: 0

  This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Quantity.
  Calculated as Scope Percent Complete multiplied by Revised Quantity.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workPackageId: integer (int64)
  The unique identifier for the work package.The work package object can also be identified by its unique criteria.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityScopeItemAssignment",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of a work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED",
                "WITHDRAW_APPROVAL",
                "REOPEN"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Additional details for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "etcAdjustedHours":{
            "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "effectiveDate":{
            "type":"string",
            "description":"The latest date of all Actual to Date and Actual Cost to Date values for the scope assignment. <br />This is a read-only field.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentCodeValue":{
            "type":"array",
            "description":"The list of code values for a scope item assignment. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemAssignment",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "deprecated":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a scope item assignment.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "plannedFinishDate":{
            "type":"string",
            "description":"The date the work on the scope assignment is scheduled to finish. <br />This field is used to spread original data fields. <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 activity's Planned Finish date.",
            "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 unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateStartDate":{
            "type":"string",
            "description":"The latest possible date work on the scope assignment must begin without delaying the finish date. <br />If there is no activity link, this field is always equal to the Remaining Early Start date. <br />If there is any activity link, this field is populated with the activity's Remaining Late Start date. <br />This field is used to spread Remaining data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingLateFinishDate":{
            "type":"string",
            "description":"The latest possible date work on the scope assignment must finish to not delay the finish date. <br />If there is no activity link, this field is always equal to the Remaining Early Finish date. <br />If there is any activity linked, this field is populated with the activity's Remaining Late Finish date. <br />This field is used to spread Remaining data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedStartDate":{
            "type":"string",
            "description":"The date the work on the scope assignment is scheduled to begin. <br />This field is used to spread original data fields. <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 activity's Planned Start date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageId":{
            "type":"integer",
            "description":"The unique identifier for the work package.The work package object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "curve":{
            "type":"integer",
            "description":"The curve profile selected for the scope assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The expected amount of material or product required.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "baselineUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The Revised Quantity at the time the current baseline was set.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "atCompletionUnits":{
            "type":"integer",
            "description":"The total amount of the scope item to be installed for the scope assignment. <br />Calculated as Revised Quantity plus Adjusted Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "remainingUnits":{
            "type":"integer",
            "description":"The quantity remaining for the scope assignment. <br />Calculated as Revised Quantity minus Installed Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"The earliest date of all Actual Hours to Date and Actual Cost to Date values for the scope assignment. <br />This is a read-only field.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "bacHours":{
            "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "eacHours":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"Calculated as ETC Hours plus Actual Hours to Date.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedHours":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.",
            "format":"double",
            "exampleSetFlag":false
        },
        "etcHours":{
            "type":"number",
            "description":"The estimated number of hours needed to complete the work. <br />Calculated as BAC Hours minus Earned Hours.",
            "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).",
            "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionHours":{
            "type":"number",
            "description":"The total hours expected for the scope assignment. <br />Calculated as Revised Hours plus Adjusted Hours.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselineHours":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"The Revised Hours at the time the baseline was set.",
            "format":"double",
            "exampleSetFlag":false
        },
        "installedHours":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"Hours spent on the scope assignment. <br />Calculated as Installed Quantity multiplied by Revised Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedHours":{
            "type":"number",
            "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingHours":{
            "type":"number",
            "description":"The number of hours left for the scope assignment. <br />Calculated as Remaining Quantity multiplied by Revised Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedHours":{
            "maximum":"1000000000",
            "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "maximum":"1000000000",
            "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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingEarlyStartDate":{
            "type":"string",
            "description":"The earliest date the work on the scope assignment is scheduled to begin. <br />If there is no activity link, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, this field is populated with the Data Date when the Modify Dates feature is run if the scope assignment'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 activity's Remaining Early Start date. <br />This field is used to spread Remaining data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "milestones":{
            "type":"array",
            "description":"The milestones of a scope assignment.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentMilestone",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "percentComplete":{
            "minimum":"0",
            "type":"number",
            "description":"Calculated as Installed Quantity divided by At Completion Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The amount of material or product that has been installed to date. <br />If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete. <br />This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "scopeItemId":{
            "type":"integer",
            "description":"The unique identifier for the scope item.The scope item object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "milestoneProgressPercent":{
            "minimum":"0",
            "type":"number",
            "description":"The percentage complete for all milestones for the scope assignment. The calculation is based on the user entered percentage complete for the milestone and the rules defined for the milestone calculations.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemAssignmentCost":{
            "description":"An object containing scope assignment cost fields.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentCost"
                }
            ]
        },
        "scopeItemAssignmentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "availableUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The amount of material or product available for scope assignment. <br />Calculated as Revised Quantity minus Installed Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "eacUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The estimate of how much material or product will be installed at completion of the scope assignment work. <br />Calculated as ETC Quantity plus Actual Quantity to Date.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "availableHours":{
            "type":"number",
            "description":"The number of hours available for scope assignment. <br />Calculated as Revised Hours minus Installed Hours.",
            "format":"double",
            "exampleSetFlag":false
        },
        "weightedCost":{
            "minimum":"0",
            "type":"number",
            "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost. <br />Calculated as Scope Percent Complete times Revised Cost. This field is in base currency and is calculated from weightedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "weightedHours":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Hours. <br />Calculated as Scope Percent Complete times Revised Hours.",
            "format":"double",
            "exampleSetFlag":false
        },
        "rateBy":{
            "type":"string",
            "description":"Determines whether the cost is calculated using the Quantity or Hours. <br />Quantity: Quantity is used to calculate cost. For example, Original Cost is calculated as Original Quantity times Original Cost Rate. <br />Hours: Hours are used to calculate cost. For example, Original Cost is calculated as Original Hours times Original Cost Rate.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HOURS",
                "QUANTITY"
            ]
        },
        "etcUnits":{
            "type":"integer",
            "description":"The estimate of how much quantity is needed to complete the work. <br />Calculated as BAC Quantity minus Earned Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "hoursPerUnit":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"The number of hours it takes to install or assemble the product or material per unit. Defaults to the scope item's Original Productivity Rate, but can be updated for each scope item assignment. <br />Calculated as Original Hours divided by Original Quantity. <br />If this field is updated, Original Hours is recalculated to equal Original Quantity multiplied by Original Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "earnedUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The amount of material or product that has been installed based on the Performance Percent Complete of the scope assignment and the Budget At Completion Quantity. <br />Calculated as Performance Percent Complete multiplied by BAC Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "earnedPercentComplete":{
            "minimum":"0",
            "type":"number",
            "description":"Calculated as Installed Quantity divided by At Completion Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "managerId":{
            "type":"integer",
            "description":"The manager or person responsible for providing status on the scope assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "bacUnits":{
            "type":"integer",
            "description":"The Revised Quantity or At Completion Quantity at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Quantity of the current project if no baseline is set.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "progressStatus":{
            "type":"string",
            "description":"The current status of a scope assignment. <br />Not Started: Work using the scope assignment has not begun. <br />In Progress: The work is in progress. <br />Completed: The work has been completed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "COMPLETED"
            ]
        },
        "manualWeightFactor":{
            "type":"number",
            "description":"The value used to calculate manual completed weight when progress needs to be weighed against a factor other than quantity, hours, or cost. <br />This is a manual entry field when Scope Percent Complete Weight Method is set to Manual.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "manualWeight":{
            "type":"number",
            "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "originalStartDate":{
            "type":"string",
            "description":"The date the work on the scope assignment is scheduled to begin. <br />This field is populated with its work package's Original Start, but can be manually modified until the original baseline is set. <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 activity's Planned Start. After the baseline is set, the field is locked. <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 Original Start date is set and the Original Start date is before the Data Date, the Original Start date inherits the Data Date when the Modify Dates feature is run.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "originalFinishDate":{
            "type":"string",
            "description":"The date the work on the scope assignment is scheduled to finish. <br />This field is populated with the work package's Original Finish date, but it can be manually modified until the original baseline is set. <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 activity's Planned Finish. After the baseline is set, the field is locked. <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.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "revisedStartDate":{
            "type":"string",
            "description":"The revised start date for the scope assignment. <br />It is always the earliest start of the scope assignment's Planned Start date and all approved Change Start dates. <br />This field is used to spread Revised data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "revisedFinishDate":{
            "type":"string",
            "description":"The revised finish date for the scope assignment. <br />It is always the latest finish of the scope assignment's Planned Finish date and all approved Change Finish dates. <br />This field is used to spread Revised data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedStartDate":{
            "type":"string",
            "description":"The date work on the scope assignment began. <br />This is the earliest date of all Installed Quantity values for the scope assignment. <br />This field is used to spread Installed data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedFinishDate":{
            "type":"string",
            "description":"The date work on the scope assignment completed. <br />The latest date of all Installed Quantity values for the scope assignment when Scope Percent Complete equals 100%. <br />This field is used to spread Installed data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingEarlyFinishDate":{
            "type":"string",
            "description":"The earliest date the work on the scope assignment is scheduled to finish. <br />If there is no activity link, before the original baseline is set, this field is populated with the Original Finish date. After the original baseline is set, this field is populated with the Revised Finish date. <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 activity's Remaining Early Finish date. <br />This field is used to spread Remaining data fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineStartDate":{
            "type":"string",
            "description":"The planned start date for the scope assignment as is set in the current baseline. <br />This field is used to spread baseline data fields. <br />This field is populated with the Revised Start date at the time that the current baseline is set. <br />If there is an activity link, this field is populated with the activity's Current BL Start date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineFinishDate":{
            "type":"string",
            "description":"The planned finish date for the scope assignment as is set in the current baseline.  <br />This field is used to spread baseline data fields. <br />This field is populated with the Revised Finish date at the time that the current baseline is set. <br />If there is an activity link, this field is populated with the activity's Current BL Finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "weightedCostProject":{
            "minimum":"0",
            "type":"number",
            "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost. Calculated as Scope Percent Complete times Revised Cost. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "approvedChangedUnits":{
            "type":"integer",
            "description":"Calculated as the sum of all approved change quantities in the change records for the scope assignment.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "pendingChangedUnits":{
            "type":"integer",
            "description":"The sum of all pending change quantities in the change records for the scope assignment.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "revisedUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"The total quantity that has been revised to account for approved changes for a scope assignment. This value equals the Original Quantity before the original baseline is set. <br />Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "currentHoursPerUnit":{
            "type":"number",
            "description":"The number of hours it will take to install or assemble the product or material per unit based on current values. <br />Calculated as Revised Hours divided by Revised Quantity. <br />This value is recalculated if Revised Quantity or Revised Hours are changed.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "etcAdjustedUnits":{
            "type":"integer",
            "description":"The scope assignment quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "weightedUnits":{
            "minimum":"0",
            "type":"integer",
            "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Quantity. <br />Calculated as Scope Percent Complete multiplied by Revised Quantity.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "actualUnitsToDate":{
            "type":"integer",
            "description":"The Installed Quantity for the scope assignment.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "costCategoryAbbr":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryType":{
            "type":"string",
            "description":"The classification of the cost category. <br />Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate. <br />Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate. <br />Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate. <br />Other: Cost is manually entered as a lump sum.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LABOR",
                "EQUIPMENT",
                "MATERIALS",
                "OTHER"
            ]
        },
        "lastInstalledDate":{
            "type":"string",
            "description":"The date on which the work package was last installed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : cbsCodes

Type: array

Deprecated. As of 23.11.
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "deprecated":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a scope item assignment.

Show Source

• Array of: object ApiEntityScopeItemAssignmentConfiguredFieldValue
  Title: ApiEntityScopeItemAssignmentConfiguredFieldValue

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

Nested Schema : milestones

Type: array

The milestones of a scope assignment.

Show Source

• Array of: object ApiEntityScopeItemAssignmentMilestone
  Title: ApiEntityScopeItemAssignmentMilestone

{
    "type":"array",
    "description":"The milestones of a scope assignment.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentMilestone",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : scopeItemAssignmentCodeValue

Type: array

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

Show Source

• Array of: object ApiEntityCodeValueScopeItemAssignment
  Title: ApiEntityCodeValueScopeItemAssignment

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

Nested Schema : scopeItemAssignmentCost

An object containing scope assignment cost fields.

Match All

Show Source

• object ApiEntityScopeItemAssignmentCost
  Title: ApiEntityScopeItemAssignmentCost

{
    "description":"An object containing scope assignment cost fields.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentCost"
        }
    ]
}

Nested Schema : ApiEntityScopeItemAssignmentConfiguredFieldValue

Type: object

Title: ApiEntityScopeItemAssignmentConfiguredFieldValue

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
  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)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  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
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  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.
• scopeItemAssignmentConfiguredFieldValueId: integer (int64)
  The unique identifier for the Scope Assignment Configured Field.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeItemAssignmentConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Scope Assignment 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"
            ]
        },
        "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":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityScopeItemAssignmentMilestone

Type: object

Title: ApiEntityScopeItemAssignmentMilestone

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• milestone: milestone
  A milestone assigned to a scope assignment.
• milestoneProgressPercent: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.
• percentComplete: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The user entered percentage complete for the individual milestones for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier of a work package.
• scopeItemAssignmentMilestoneId: integer (int64)
  Unique identifier of the scope item assignment milestone.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeItemAssignmentMilestone",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "percentComplete":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The user entered percentage complete for the individual milestones for the scope assignment.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "milestoneProgressPercent":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.",
            "format":"double",
            "exampleSetFlag":false
        },
        "milestone":{
            "description":"A milestone assigned to a scope assignment.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone"
                }
            ]
        },
        "scopeItemAssignmentMilestoneId":{
            "type":"integer",
            "description":"Unique identifier of the scope item assignment milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : milestone

A milestone assigned to a scope assignment.

Match All

Show Source

• object ApiEntityRuleOfCreditMilestone
  Title: ApiEntityRuleOfCreditMilestone

{
    "description":"A milestone assigned to a scope assignment.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone"
        }
    ]
}

Nested Schema : ApiEntityRuleOfCreditMilestone

Type: object

Title: ApiEntityRuleOfCreditMilestone

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)
  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)
  Date when the record was last updated.

{
    "title":"ApiEntityRuleOfCreditMilestone",
    "required":[
        "milestoneName",
        "percentComplete",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCodeValueScopeItemAssignment

Type: object

Title: ApiEntityCodeValueScopeItemAssignment

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

  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.
• codeValueScopeItemId: integer (int64)
  The unique identifier of a work package code value.
• link: string (url)
  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.
• scopeItemAssignmentId: integer (int64)
  The unique identifier of a work package.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueScopeItemAssignment",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueScopeItemId":{
            "type":"integer",
            "description":"The unique identifier of a work package code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "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":"The name of a code or value.",
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityScopeItemAssignmentCost

Type: object

Title: ApiEntityScopeItemAssignmentCost

Show Source

• actualCostToDate: number (double)
  Minimum Value: 0

  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.
• actualCostToDateProject: number (double)
  Minimum Value: 0

  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.
• adjustedCost: number (double)
  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 field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.
• adjustedCostProject: number (double)
  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 value is based on the project currency.
• approvedChangedCost: number (double)
  The sum of all approved cost changes in the change records for the scope assignment. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.
• approvedChangedCostProject: number (double)
  The sum of all approved cost changes in the change records for the scope assignment. This value is based on the project currency.
• atCompletionCost: number (double)
  The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.
• atCompletionCostProject: number (double)
  The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This value is based on the project currency.
• bacCost: number (double)
  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 field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.
• bacCostProject: number (double)
  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 value is based on the project currency.
• baselineCost: number (double)
  The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.
• baselineCostProject: number (double)
  The Revised Cost at the time the current baseline was set. This value is based on the project currency.
• currentRate: number (double)
  The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This field is in base currency and is calculated from currentRateProject field based on the specified exchange rate.
• currentRateProject: number (double)
  The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This value is based on the project currency.
• eacCost: number (double)
  Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.
• eacCostProject: number (double)
  Calculated as ETC Cost plus Actual Cost to Date. This value is based on the project currency.
• earnedCost: number (double)
  Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.
• earnedCostProject: number (double)
  Calculated as Performance Percent Complete multiplied by BAC Cost. This value is based on the project currency.
• etcCost: number (double)
  The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.
• etcCostProject: number (double)
  The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This value is based on the project currency.
• installedCost: number (double)
  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 field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.
• installedCostProject: number (double)
  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 value is based on the project currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• pendingChangedCost: number (double)
  Calculated as the sum of all pending cost changes in the change records for the scope assignment. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.
• pendingChangedCostProject: number (double)
  Calculated as the sum of all pending cost changes in the change records for the scope assignment. This value is based on the project currency.
• plannedCost: number (double)
  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 field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  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 value is based on the project currency. This value is based on the project currency.
• rate: number (double)
  Minimum Value: 0

  The rate for the project. This field is in base currency and is calculated from rateProject field based on the specified exchange rate.
• rateProject: number (double)
  Minimum Value: 0

  The rate for the project. This value is based on the project currency.
• remainingCost: number (double)
  The remaining cost for the project. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.
• remainingCostProject: number (double)
  The remaining cost for the project. This value is based on the project currency.
• revisedCost: number (double)
  The revised cost of the project. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.
• revisedCostProject: number (double)
  The revised cost of the project. This value is based on the project currency.
• scopeItemAssignmentId(required): integer (int64)
  The unique identifier for the scope item assigned to the work package.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeItemAssignmentCost",
    "required":[
        "scopeItemAssignmentId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "remainingCost":{
            "type":"number",
            "description":"The remaining cost for the project. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCost":{
            "type":"number",
            "description":"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 field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCost":{
            "type":"number",
            "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionCostProject":{
            "type":"number",
            "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCostProject":{
            "type":"number",
            "description":"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 value is based on the project currency. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingCostProject":{
            "type":"number",
            "description":"The remaining cost for the project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedCostProject":{
            "type":"number",
            "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "eacCost":{
            "type":"number",
            "description":"Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "bacCostProject":{
            "type":"number",
            "description":"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 value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "etcCostProject":{
            "type":"number",
            "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "bacCost":{
            "type":"number",
            "description":"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 field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "etcCost":{
            "type":"number",
            "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "eacCostProject":{
            "type":"number",
            "description":"Calculated as ETC Cost plus Actual Cost to Date. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedCost":{
            "type":"number",
            "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostToDate":{
            "minimum":"0",
            "type":"number",
            "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "approvedChangedCostProject":{
            "type":"number",
            "description":"The sum of all approved cost changes in the change records for the scope assignment. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedCost":{
            "type":"number",
            "description":"The revised cost of the project. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedCostProject":{
            "type":"number",
            "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "installedCostProject":{
            "type":"number",
            "description":"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 value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "approvedChangedCost":{
            "type":"number",
            "description":"The sum of all approved cost changes in the change records for the scope assignment. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "installedCost":{
            "type":"number",
            "description":"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 field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedCost":{
            "type":"number",
            "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselineCostProject":{
            "type":"number",
            "description":"The Revised Cost at the time the current baseline was set. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "adjustedCost":{
            "type":"number",
            "description":"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 field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedCostProject":{
            "type":"number",
            "description":"The revised cost of the project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostToDateProject":{
            "minimum":"0",
            "type":"number",
            "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselineCost":{
            "type":"number",
            "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "adjustedCostProject":{
            "type":"number",
            "description":"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 value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "currentRate":{
            "type":"number",
            "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This field is in base currency and is calculated from currentRateProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "rate":{
            "minimum":"0",
            "type":"number",
            "description":"The rate for the project. This field is in base currency and is calculated from rateProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "rateProject":{
            "minimum":"0",
            "type":"number",
            "description":"The rate for the project. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentRateProject":{
            "type":"number",
            "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested scope item assignment does not exist, or you do not have access to it.

Back to Top