Jump to

• Request
• Response

View all Scope Assignment Baseline Time Phased Data by Scope Assignment

get

/api/restapi/baselineTimePhasedData/scopeAssignment/{scopeItemAssignmentId}

This endpoint returns baseline time phased data that meet the following requirements:

• The object is associated with a scope item assignment with an ID value that matches the value of the {scopeItemAssigmentId} path parameter.

Request

Path Parameters

• scopeItemAssignmentId(required): integer(int64)
  The system-generated identifier of a scope assignment.

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<ApiEntityScopeAssignmentBaselineTimePhasedData>

Type: array

Title: List<ApiEntityScopeAssignmentBaselineTimePhasedData>

Show Source

• Array of: object ApiEntityScopeAssignmentBaselineTimePhasedData
  Title: ApiEntityScopeAssignmentBaselineTimePhasedData

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

  • scopeAssignmentBaselineTimePhasedDataId

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

Nested Schema : ApiEntityScopeAssignmentBaselineTimePhasedData

Type: object

Title: ApiEntityScopeAssignmentBaselineTimePhasedData

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

• scopeAssignmentBaselineTimePhasedDataId

Show Source

• baselineHours(required): number (double)
  Revised hours at the time the baseline was set.
• baselineUnits(required): integer (int64)
  Revised quantity at the time the baseline was set.
• 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

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• scopeAssignmentBaselineTimePhasedCostData: scopeAssignmentBaselineTimePhasedCostData
  An object containing the cost fields associated with the baseline time phased data.
• scopeAssignmentBaselineTimePhasedDataId: integer (int64)
  The unique identifier of baseline data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignmentId(required): integer (int64)
  The unique identifier of a work package.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentBaselineTimePhasedData",
    "required":[
        "baselineHours",
        "baselineUnits",
        "date",
        "scopeItemAssignmentId"
    ],
    "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",
            "readOnly":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"
            ]
        },
        "baselineUnits":{
            "type":"integer",
            "description":"<b>Revised quantity</b> at the time the baseline was set.",
            "format":"int64",
            "exampleSetFlag":false
        },
        "baselineHours":{
            "type":"number",
            "description":"<b>Revised hours</b> at the time the baseline was set.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeAssignmentBaselineTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of baseline 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"
            ]
        },
        "scopeAssignmentBaselineTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the baseline time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentBaselineTimePhasedCostData"
                }
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScopeAssignmentBaselineTimePhasedData object, a unique ScopeAssignmentBaselineTimePhasedData object can be identified by the following combinations of the fields.<ul><li>scopeAssignmentBaselineTimePhasedDataId</li>",
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentBaselineTimePhasedCostData

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

Match All

Show Source

• object ApiEntityScopeAssignmentBaselineTimePhasedCostData
  Title: ApiEntityScopeAssignmentBaselineTimePhasedCostData

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

Nested Schema : ApiEntityScopeAssignmentBaselineTimePhasedCostData

Type: object

Title: ApiEntityScopeAssignmentBaselineTimePhasedCostData

Show Source

• baselineCost(required): number (double)
  The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.
• baselineCostProject: number (double)
  The Revised Cost at the time the current baseline was set. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• scopeAssignmentBaselineTimePhasedDataId(required): integer (int64)
  Time phased baseline data ID.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentBaselineTimePhasedCostData",
    "required":[
        "baselineCost",
        "scopeAssignmentBaselineTimePhasedDataId"
    ],
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineCostProject":{
            "type":"number",
            "description":"The Revised Cost at the time the current baseline was set. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "baselineCost":{
            "type":"number",
            "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeAssignmentBaselineTimePhasedDataId":{
            "type":"integer",
            "description":"Time phased baseline data ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top