Jump to

• Request
• Response

View all Scope Assignment Planned Time Phased Data by Scope Assignment ID

get

/api/restapi/plannedTimePhasedData/scopeAssignment/{scopeItemAssignmentId}

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

Request

Path Parameters

• scopeItemAssignmentId(required): integer(int64)
  ID of the scopeAssignment 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 : List<ApiEntityScopeAssignmentPlannedTimePhasedData>

Type: array

Title: List<ApiEntityScopeAssignmentPlannedTimePhasedData>

Show Source

• Array of: object ApiEntityScopeAssignmentPlannedTimePhasedData
  Title: ApiEntityScopeAssignmentPlannedTimePhasedData

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

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedData

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedData

Show Source

• date: 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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• plannedHours: number (double)
  Expected hours needed to complete all the work on a scope item.
• plannedUnits: 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: integer (int64)
  The unique identifier of a work package.
• 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":"ApiEntityScopeAssignmentPlannedTimePhasedData",
    "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 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"
            ]
        },
        "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/ApiEntityScopeAssignmentPlannedTimePhasedCostData"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentPlannedTimePhasedCostData

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

Match All

Show Source

• object ApiEntityScopeAssignmentPlannedTimePhasedCostData
  Title: ApiEntityScopeAssignmentPlannedTimePhasedCostData

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

Nested Schema : ApiEntityScopeAssignmentPlannedTimePhasedCostData

Type: object

Title: ApiEntityScopeAssignmentPlannedTimePhasedCostData

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

{
    "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostData",
    "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"
            ]
        },
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope item planned cost data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "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 assignment planned time phased data does not exist or you do not have access to it.

Back to Top