Jump to

• Request
• Response

View Scope Assignment Installed Time Phased Data

get

/api/restapi/installedTimePhasedData/{scopeAssignmentInstalledTimePhasedDataId}

Returns the scope assignment installed time phased data for the specified scopeAssignment installed time phased data ID.

Request

Path Parameters

• scopeAssignmentInstalledTimePhasedDataId(required): integer(int64)
  ID of the scopeAssignment installed time phased data to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityScopeAssignmentInstalledTimePhasedData

Type: object

Title: ApiEntityScopeAssignmentInstalledTimePhasedData

Show Source

• date: string (date-time)
  Date used for updating scope assignments and work packages when they are not linked to activities.
• installedHours: number (double)
  Hours spent on the scope assignment.
  Calculated as Installed Quantity multiplied by Revised Productivity Rate.
• installedUnits: integer (int64)
  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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• milestones: array milestones
  The milestones associated with the installed time phased data.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentInstalledTimePhasedCostData: scopeAssignmentInstalledTimePhasedCostData
  An object containing the cost fields associated with the installed time phased data.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier of a work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• updateDate: string (date-time)
  Date when the record was last updated.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityScopeAssignmentInstalledTimePhasedData",
    "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"
            ]
        },
        "date":{
            "type":"string",
            "description":"Date used for updating scope assignments and work packages when they are not linked to activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "installedHours":{
            "type":"number",
            "description":"Hours spent on the scope assignment. <br />Calculated as Installed Quantity multiplied by Revised Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "milestones":{
            "type":"array",
            "description":"The milestones associated with the installed time phased data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScopeAssignmentTimePhasedMilestone",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a 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"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentInstalledTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the installed time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedCostData"
                }
            ]
        },
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "installedUnits":{
            "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
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : milestones

Type: array

The milestones associated with the installed time phased data.

Show Source

• Array of: object ApiEntityScopeAssignmentTimePhasedMilestone
  Title: ApiEntityScopeAssignmentTimePhasedMilestone

{
    "type":"array",
    "description":"The milestones associated with the installed time phased data.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeAssignmentTimePhasedMilestone",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : scopeAssignmentInstalledTimePhasedCostData

An object containing the cost fields associated with the installed time phased data.

Match All

Show Source

• object ApiEntityScopeAssignmentInstalledTimePhasedCostData
  Title: ApiEntityScopeAssignmentInstalledTimePhasedCostData

{
    "description":"An object containing the cost fields associated with the installed time phased data.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedCostData"
        }
    ]
}

Nested Schema : ApiEntityScopeAssignmentTimePhasedMilestone

Type: object

Title: ApiEntityScopeAssignmentTimePhasedMilestone

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.
• milestoneId: integer (int64)
  The unique identifier of a rule of credit milestone.
• milestoneProgressPercent: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The milestone progress percent complete.
• percentComplete: 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.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment installed time phase data.
• scopeItemAssignmentSpreadMilestoneId: integer (int64)
  The unique identifier of a scope assignment spread milestone.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentTimePhasedMilestone",
    "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 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
        },
        "milestoneId":{
            "type":"integer",
            "description":"The unique identifier of a rule of credit milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment installed time phase data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentSpreadMilestoneId":{
            "type":"integer",
            "description":"The unique identifier of a scope assignment spread milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "milestoneProgressPercent":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The milestone progress percent complete.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityScopeAssignmentInstalledTimePhasedCostData

Type: object

Title: ApiEntityScopeAssignmentInstalledTimePhasedCostData

Show Source

• 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.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of installed cost data.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentInstalledTimePhasedCostData",
    "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"
            ]
        },
        "installedCostProject":{
            "type":"number",
            "description":"The total cost incurred on the scope assignment as of the current date. <br />If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. <br />If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "installedCost":{
            "type":"number",
            "description":"The total cost incurred on the scope assignment as of the current date. <br />If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. <br />If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of installed cost data.",
            "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
}

404 Response

The requested scope assignment installed time phased data does not exist or you do not have access to it.

Back to Top