Jump to

• Request
• Response

Batch Update Scope Assignment Installed Time Phased Data

put

/api/restapi/installedTimePhasedData/batch

Updates the scopeAssignment installed time phased data objects for the specified scopeAssignment installed time phased data IDs.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityScopeAssignmentInstalledTimePhasedDataInput>

Type: array

Title: List<ApiEntityScopeAssignmentInstalledTimePhasedDataInput>

Show Source

• Array of: object ApiEntityScopeAssignmentInstalledTimePhasedDataInput
  Title: ApiEntityScopeAssignmentInstalledTimePhasedDataInput

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

  • scopeAssignmentInstalledTimePhasedDataId

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

Nested Schema : ApiEntityScopeAssignmentInstalledTimePhasedDataInput

Type: object

Title: ApiEntityScopeAssignmentInstalledTimePhasedDataInput

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

• scopeAssignmentInstalledTimePhasedDataId

Show Source

• date(required): string (date-time)
  Date used for updating scope assignments and work packages when they are not linked to activities.
• installedHours(required): number (double)
  Hours spent on the scope assignment.
  Calculated as Installed Quantity multiplied by Revised Productivity Rate.
• installedUnits(required): number (double)
  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.
• 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(required): 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.
• 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":"ApiEntityScopeAssignmentInstalledTimePhasedDataInput",
    "required":[
        "date",
        "installedHours",
        "installedUnits",
        "scopeItemAssignmentId"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "installedHours":{
            "type":"number",
            "description":"Hours spent on the scope assignment. <br />Calculated as Installed Quantity multiplied by Revised Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "milestones":{
            "type":"array",
            "description":"The milestones associated with the installed time phased data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScopeAssignmentTimePhasedMilestoneInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scopeItemCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedUnits":{
            "type":"number",
            "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":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "scopeAssignmentInstalledTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the installed time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput"
                }
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScopeAssignmentInstalledTimePhasedData object, a unique ScopeAssignmentInstalledTimePhasedData object can be identified by the following combinations of the fields.<ul><li>scopeAssignmentInstalledTimePhasedDataId</li>",
    "exampleSetFlag":false
}

Nested Schema : milestones

Type: array

The milestones associated with the installed time phased data.

Show Source

• Array of: object ApiEntityScopeAssignmentTimePhasedMilestoneInput
  Title: ApiEntityScopeAssignmentTimePhasedMilestoneInput

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

Nested Schema : scopeAssignmentInstalledTimePhasedCostData

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

Match All

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

Show Source

• object ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput
  Title: ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput

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

Nested Schema : ApiEntityScopeAssignmentTimePhasedMilestoneInput

Type: object

Title: ApiEntityScopeAssignmentTimePhasedMilestoneInput

Show Source

• milestoneId(required): 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(required): integer (int64)
  The unique identifier of scope assignment installed time phase data.
• scopeItemAssignmentSpreadMilestoneId: integer (int64)
  The unique identifier of a scope assignment spread milestone.

{
    "title":"ApiEntityScopeAssignmentTimePhasedMilestoneInput",
    "required":[
        "milestoneId",
        "scopeAssignmentInstalledTimePhasedDataId"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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
        },
        "milestoneProgressPercent":{
            "maximum":1,
            "minimum":0,
            "type":"number",
            "description":"The milestone progress percent complete.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput

Type: object

Title: ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput

Show Source

• 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.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of installed cost data.

{
    "title":"ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput",
    "type":"object",
    "properties":{
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of installed cost data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Scope Assignment Installed Time Phased Data

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

Invalid input for the Scope Assignment Installed Time Phased Data Service.

Back to Top