• [0]: object ApiEntityScopeItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityScopeItem"
    }
}

• approvedChangedHours: object Hour
• approvedChangedUnits: object Quantity
• assignedHours: object Hour
• assignedUnits: object Quantity
• atCompletionUnits: object Quantity
• baselineHours: object Hour
• baselineUnits: object Quantity
• costSheetItemId(optional): integer(int64)
  The cost breakdown structure code assigned to the scope item.
• currentHoursPerUnit(optional): number(double)
  The number of hours required to install a single quantity of the scope item material or product based on current values.
  For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
  This field is recalculated if Current Hours are changed.
• description: string
  Allowed Values: [ "Length[0-4000]" ]

  Details describing the scope item.
• effectiveFinish(optional): string(date-time)
  The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.
• effectiveStart(optional): string(date-time)
  The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.
• etcAdjustedUnits: object Quantity
• itemCode(optional): string
  Allowed Values: [ "Length[1-60]" ]

  The unique identifier for the scope item.
• itemCodeUpper(optional): string
  Allowed Values: [ "Length[1-60]" ]

  The code of an upper scope item.
• itemName(optional): string
  Allowed Values: [ "Length[1-255]" ]

  The name of the scope item.
• itemNameUpper(optional): string
  Allowed Values: [ "Length[1-255]" ]

  The name of an upper scope item.
• link(optional): string(url)
  Read Only: true
• pbsId(optional): integer(int64)
  The parent PBS for the scope item.
• pendingChangedHours: object Hour
• pendingChangedUnits: object Quantity
• percentComplete: object Percent
• plannedHours(optional): object Hour
• plannedHoursPerUnit(optional): number(double)
  The number of hours required to install or assemble a single quantity of the scope item material or product.
  For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
  Calculated as Original Hours divided by Original Quantity.
• plannedUnits(optional): object Quantity
• projectId(optional): integer(int64)
  The ID for the project where the scope item exists.
• remainingUnits: object Quantity
• revisedHours: object Hour
• revisedUnits: object Quantity
• scopeItemCodeValue(optional): array scopeItemCodeValue
  Unique Items Required: true

  A code value object.
• scopeItemConfiguredFields(optional): object ApiEntityScopeItemConfiguredFields
• scopeItemId(optional): integer(int64)
• status(optional): string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED" ]

  The state of the scope item in the change request.
• unAssignedHours: object Hour
• unAssignedUnits: object Quantity
• unitOfMeasureId: integer(int64)
  The name of the measurement type used to describe the quantity of a scope item.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "approvedChangedHours",
        "approvedChangedUnits",
        "assignedHours",
        "assignedUnits",
        "atCompletionUnits",
        "baselineHours",
        "baselineUnits",
        "description",
        "etcAdjustedUnits",
        "pendingChangedHours",
        "pendingChangedUnits",
        "percentComplete",
        "remainingUnits",
        "revisedHours",
        "revisedUnits",
        "unAssignedHours",
        "unAssignedUnits",
        "unitOfMeasureId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "unitOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The name of the measurement type used to describe the quantity of a scope item."
        },
        "description":{
            "type":"string",
            "description":"Details describing the scope item.",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the scope item in the change request.",
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier for the scope item.",
            "enum":[
                "Length[1-60]"
            ]
        },
        "itemCodeUpper":{
            "type":"string",
            "description":"The code of an upper scope item.",
            "enum":[
                "Length[1-60]"
            ]
        },
        "revisedHours":{
            "description":"The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set. <br />Calculated as the sum of Original Hours plus Approved Changed Hours, if any.",
            "$ref":"#/definitions/Hour"
        },
        "baselineHours":{
            "description":"The Revised Hours at the time the baseline was set.",
            "$ref":"#/definitions/Hour"
        },
        "pbsId":{
            "type":"integer",
            "format":"int64",
            "description":"The parent PBS for the scope item."
        },
        "assignedUnits":{
            "description":"The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.",
            "$ref":"#/definitions/Quantity"
        },
        "baselineUnits":{
            "description":"The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.",
            "$ref":"#/definitions/Quantity"
        },
        "itemName":{
            "type":"string",
            "description":"The name of the scope item.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "assignedHours":{
            "description":"The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.",
            "$ref":"#/definitions/Hour"
        },
        "itemNameUpper":{
            "type":"string",
            "description":"The name of an upper scope item.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "scopeItemId":{
            "type":"integer",
            "format":"int64"
        },
        "revisedUnits":{
            "description":"The total quantity that has been revised to account for approved changes for a scope item. <br />Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.",
            "$ref":"#/definitions/Quantity"
        },
        "etcAdjustedUnits":{
            "description":"The scope item 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. <br />This is a manual entry field.",
            "$ref":"#/definitions/Quantity"
        },
        "percentComplete":{
            "description":"Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.",
            "$ref":"#/definitions/Percent"
        },
        "atCompletionUnits":{
            "description":"The total amount of the scope item to be installed for the project. <br />Calculated as Revised Quantity plus Adjusted Quantity.",
            "$ref":"#/definitions/Quantity"
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the project where the scope item exists."
        },
        "plannedUnits":{
            "description":"The original expected amount of material or product required for a scope item.",
            "$ref":"#/definitions/Quantity"
        },
        "plannedHours":{
            "description":"The original expected hours needed to complete all the work on a scope item. <br />Calculated as Original Quantity multiplied by Original Productivity Rate.",
            "$ref":"#/definitions/Hour"
        },
        "plannedHoursPerUnit":{
            "type":"number",
            "format":"double",
            "description":"The number of hours required to install or assemble a single quantity of the scope item material or product. <br />For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. <br />Calculated as Original Hours divided by Original Quantity."
        },
        "effectiveFinish":{
            "type":"string",
            "format":"date-time",
            "description":"The latest Effective Finish date for Actual to Date values of all scope item's scope assignments."
        },
        "unAssignedHours":{
            "description":"The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.",
            "$ref":"#/definitions/Hour"
        },
        "pendingChangedUnits":{
            "description":"The total quantity waiting for approval on a scope item.",
            "$ref":"#/definitions/Quantity"
        },
        "pendingChangedHours":{
            "description":"The total number of hours waiting for approval on a scope item.",
            "$ref":"#/definitions/Hour"
        },
        "unAssignedUnits":{
            "description":"The total number of hours waiting for approval on a scope item.",
            "$ref":"#/definitions/Quantity"
        },
        "approvedChangedHours":{
            "description":"The total number of hours approved for scope item changes.",
            "$ref":"#/definitions/Hour"
        },
        "remainingUnits":{
            "description":"The quantity remaining for the scope item. <br />Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.",
            "$ref":"#/definitions/Quantity"
        },
        "currentHoursPerUnit":{
            "type":"number",
            "format":"double",
            "description":"The number of hours required to install a single quantity of the scope item material or product based on current values. <br />For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. <br />This field is recalculated if Current Hours are changed."
        },
        "effectiveStart":{
            "type":"string",
            "format":"date-time",
            "description":"The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments."
        },
        "approvedChangedUnits":{
            "description":"The total quantity approved for scope item changes.",
            "$ref":"#/definitions/Quantity"
        },
        "costSheetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The cost breakdown structure code assigned to the scope item."
        },
        "scopeItemCodeValue":{
            "type":"array",
            "description":"A code value object.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueScopeItem"
            }
        },
        "scopeItemConfiguredFields":{
            "description":"An object containing configured fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntityScopeItemConfiguredFields"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

• bigDecimal(optional): number
• double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

• [0]: object ApiEntityCodeValueScopeItem

{
    "type":"array",
    "description":"A code value object.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueScopeItem"
    }
}

• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing cost fields in the form of key-value pairs.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing non-cost and non-text fields in the form of key-value pairs.
• primaryKey(optional): integer(int64)
• scopeItem(optional): object ApiEntityScopeItem
• scopeItemId(optional): integer(int64)
  The system-generated identifier of a scope item.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing text fields in the form of key-value pairs.
• uniqueName(optional): string
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"An object containing cost fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "scopeItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a scope item."
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64"
        },
        "scopeItem":{
            "description":"A scope item object.",
            "$ref":"#/definitions/ApiEntityScopeItem"
        },
        "uniqueName":{
            "type":"string"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• codeType(optional): object ApiEntityCodeType
• codeValue(optional): object ApiEntityCodeValue
• codeValueScopeItemId(optional): integer(int64)
  The unique identifier for the code value assigned to the scope item.
• link(optional): string(url)
  Read Only: true
• scopeItemId(optional): integer(int64)
  The unique identifier of a scope item.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The name of the scope item code value.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"The code type associated with a code value.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "scopeItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a scope item."
        },
        "codeValueScopeItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the code value assigned to the scope item."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• assignments(optional): array assignments
  Unique Items Required: true

  CodeType assignments.
• codeTypeCode: string
  Allowed Values: [ "Length[1-40]" ]

  This field displays the name of a code or value.
• codeTypeId(optional): integer(int64)
  The system-generated identifier of a code type.
• codeTypeName: string
  Allowed Values: [ "Length[1-40]" ]

  The name of a code or value.
• link(optional): string(url)
  Read Only: true
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the workspace code.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspace: integer(int64)
  The ID of the owning workspace.

{
    "type":"object",
    "required":[
        "codeTypeCode",
        "codeTypeName",
        "pushDownType",
        "workspace"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a code type."
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "assignments":{
            "type":"array",
            "description":"CodeType assignments.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeEntityType"
            }
        },
        "codeTypeCode":{
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "workspace":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the owning workspace."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• codeTypeId: integer(int64)
  The ID for the code type.
• codeTypeName: string
  The name of a code or value.
• codeValueCode: string
  Allowed Values: [ "LENGTH[1-32]" ]

  The unique identifier for the code value.
• codeValueId(optional): integer(int64)
  The unique identifier for the code value.
• codeValueName: string
  Allowed Values: [ "LENGTH[1-100]" ]

  The name of the code value.
• link(optional): string(url)
  Read Only: true
• parentCodeValue(optional): integer(int64)
  The parent code value.
• sequenceNumber: integer(int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeTypeId",
        "codeTypeName",
        "codeValueCode",
        "codeValueName",
        "sequenceNumber"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the code value."
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the code type."
        },
        "codeValueName":{
            "type":"string",
            "description":"The name of the code value.",
            "enum":[
                "LENGTH[1-100]"
            ]
        },
        "codeValueCode":{
            "type":"string",
            "description":"The unique identifier for the code value.",
            "enum":[
                "LENGTH[1-32]"
            ]
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The number that specifies the position of the code value item within the code type list."
        },
        "parentCodeValue":{
            "type":"integer",
            "format":"int64",
            "description":"The parent code value."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityCodeEntityType

{
    "type":"array",
    "description":"CodeType assignments.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeEntityType"
    }
}

• codeType: object ApiEntityCodeType
• entityType: string
  Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]

  Indicates the type of object the code is associated to.
• link(optional): string(url)
  Read Only: true
• primaryKey: integer(int64)
  The unique identifier of a code type table.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeType",
        "entityType",
        "primaryKey"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeType":{
            "description":"The unique identifier of a code type.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "entityType":{
            "type":"string",
            "description":"Indicates the type of object the code is associated to.",
            "enum":[
                "SCOPE_ITEM",
                "PROJECT",
                "SCOPE_ASSIGNMENT",
                "WBS",
                "WORK_PACKAGE",
                "ACTIVITY",
                "RESOURCE",
                "PBS",
                "CONTRACT",
                "RISK",
                "COMMITMENT",
                "REPORT",
                "TASKS",
                "STRATEGY",
                "PORTFOLIO",
                "FUND",
                "SUBMITTAL",
                "CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "CHANGE_EVENT",
                "CHANGES_ESTIMATES",
                "IDEA",
                "RFI",
                "CUSTOM_LOG_ITEM"
            ]
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a code type table."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing cost fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}