Jump to

• Request
• Response

View Scope Assignment Actuals Time Phased Data

get

/api/restapi/actualsTimePhasedData/{scopeAssignmentActualsTimePhasedDataId}

This endpoint returns scope assignment actual time phased data that meet the following requirements:

• The object has an ID that matches the value of the {actualsTimePhasedDataId} path parameter.

Request

Path Parameters

• scopeAssignmentActualsTimePhasedDataId(required): integer(int64)
  The system-generated identifier of actual time phased data.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityScopeAssignmentActualsTimePhasedData

Type: object

Title: ApiEntityScopeAssignmentActualsTimePhasedData

Show Source

• actualsHours: number (double)
  The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
  This is a manual entry field.
• date: string (date-time)
  The date on which work on a work package began.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentActualsTimePhasedCostData: scopeAssignmentActualsTimePhasedCostData
  An object containing the cost fields associated with the actuals time phased data.
• scopeAssignmentActualsTimePhasedDataId: integer (int64)
  The unique identifier of scope actuals time phased 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 scope assignment.
• 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":"ApiEntityScopeAssignmentActualsTimePhasedData",
    "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":"The date on which work on a work package began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentActualsTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope actuals time phased 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"
            ]
        },
        "scopeAssignmentActualsTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the actuals time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedCostData"
                }
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a scope assignment.",
            "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"
            ]
        },
        "actualsHours":{
            "type":"number",
            "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done). <br />This is a manual entry field.",
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentActualsTimePhasedCostData

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

Match All

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

Show Source

• object ApiEntityScopeAssignmentActualsTimePhasedCostData
  Title: ApiEntityScopeAssignmentActualsTimePhasedCostData

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

Nested Schema : ApiEntityScopeAssignmentActualsTimePhasedCostData

Type: object

Title: ApiEntityScopeAssignmentActualsTimePhasedCostData

Show Source

• actualsCost: number (double)
  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualsCostProject field based on the specified exchange rate.
  This is a manual entry field.
• actualsCostProject: number (double)
  The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). 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.
• scopeAssignmentActualsTimePhasedDataId: integer (int64)
  Actuals time phased data ID.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityScopeAssignmentActualsTimePhasedCostData",
    "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"
            ]
        },
        "scopeAssignmentActualsTimePhasedDataId":{
            "type":"integer",
            "description":"Actuals time phased data ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "actualsCostProject":{
            "type":"number",
            "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualsCost":{
            "type":"number",
            "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualsCostProject field based on the specified exchange rate. <br />This is a manual entry field.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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 actuals time phased data does not exist, or you do not have access to it.

Back to Top