Jump to

• Request
• Response

Update a Scope Assignment Planned Time Phased Data Object

put

/api/restapi/plannedTimePhasedData

Updates the scopeAssignment planned time phased data for the specified scopeAssignment planned time phased data ID.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityScopeAssignmentPlannedTimePhasedDataInput

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedDataInput

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

• scopeAssignmentPlannedTimePhasedDataId

Show Source

• date(required): string (date-time)
  Date used for updating the dates of scope assignments and work packages when they are not linked to activities.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedHours(required): number (double)
  Expected hours needed to complete all the work on a scope item.
• plannedUnits(required): integer (int64)
  Expected amount of material or product required for a scope item.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentPlannedTimePhasedCostData: scopeAssignmentPlannedTimePhasedCostData
  An object containing the cost fields associated with the planned time phased data.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment plan 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  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":"ApiEntityScopeAssignmentPlannedTimePhasedDataInput",
    "required":[
        "date",
        "plannedHours",
        "plannedUnits",
        "scopeItemAssignmentId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "date":{
            "type":"string",
            "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment plan 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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "plannedUnits":{
            "type":"integer",
            "description":"Expected amount of material or product required for a scope item.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "type":"number",
            "description":"Expected hours needed to complete all the work on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "scopeAssignmentPlannedTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the planned time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput"
                }
            ]
        }
    },
    "description":"This entity represents a ScopeAssignmentPlannedTimePhasedData object, a unique ScopeAssignmentPlannedTimePhasedData object can be identified by the following combinations of the fields.<ul><li>scopeAssignmentPlannedTimePhasedDataId</li>",
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentPlannedTimePhasedCostData

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

Match All

Show Source

• object ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput
  Title: ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

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

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedCost(required): number (double)
  Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.
• plannedCostProject: number (double)
  Original cost for the project scope item. This value is based on the project currency.
• scopeAssignmentPlannedTimePhasedDataId(required): integer (int64)
  The unique identifier of scope item planned cost data.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput",
    "required":[
        "plannedCost",
        "scopeAssignmentPlannedTimePhasedDataId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope item planned cost data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedCost":{
            "type":"number",
            "description":"Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedCostProject":{
            "type":"number",
            "description":"Original cost for the project scope item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update Scope Assignment Original Time Phased Data Using Codes

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.

Back to Top