Jump to

• Request
• Response

Batch Update Scope Assignment Actuals Time Phased Data

put

/api/restapi/actualsTimePhasedData/batch

Send a request to this endpoint to update one or more scope assignment actual time phased data.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityScopeAssignmentActualsTimePhasedDataInput>

Type: array

Title: List<ApiEntityScopeAssignmentActualsTimePhasedDataInput>

Show Source

• Array of: object ApiEntityScopeAssignmentActualsTimePhasedDataInput
  Title: ApiEntityScopeAssignmentActualsTimePhasedDataInput

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

  • scopeAssignmentActualsTimePhasedDataId

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

Nested Schema : ApiEntityScopeAssignmentActualsTimePhasedDataInput

Type: object

Title: ApiEntityScopeAssignmentActualsTimePhasedDataInput

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

• scopeAssignmentActualsTimePhasedDataId

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(required): string (date-time)
  The date on which work on a work package began.
• 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.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentActualsTimePhasedCostData(required): 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(required): 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)
  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":"ApiEntityScopeAssignmentActualsTimePhasedDataInput",
    "required":[
        "date",
        "scopeAssignmentActualsTimePhasedCostData",
        "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":"The date on which work on a work package began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "scopeAssignmentActualsTimePhasedCostData":{
            "description":"An object containing the cost fields associated with the actuals time phased data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedCostDataInput"
                }
            ]
        },
        "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"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of a scope assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 ScopeAssignmentActualsTimePhasedData object, a unique ScopeAssignmentActualsTimePhasedData object can be identified by the following combinations of the fields.<ul><li>scopeAssignmentActualsTimePhasedDataId</li>",
    "exampleSetFlag":false
}

Nested Schema : scopeAssignmentActualsTimePhasedCostData

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

Match All

Show Source

• object ApiEntityScopeAssignmentActualsTimePhasedCostDataInput
  Title: ApiEntityScopeAssignmentActualsTimePhasedCostDataInput

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

Nested Schema : ApiEntityScopeAssignmentActualsTimePhasedCostDataInput

Type: object

Title: ApiEntityScopeAssignmentActualsTimePhasedCostDataInput

Show Source

• actualsCost: number (double)
  Read Only: true

  Deprecated. As of 24.5.
  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(required): 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)
  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.
• scopeAssignmentActualsTimePhasedDataId(required): integer (int64)
  Actuals time phased data ID.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityScopeAssignmentActualsTimePhasedCostDataInput",
    "required":[
        "actualsCostProject",
        "scopeAssignmentActualsTimePhasedDataId"
    ],
    "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"
            ]
        },
        "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"
            ]
        },
        "actualsCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Scope Assignment Actuals 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 Actuals Time Phased Data Service.

Back to Top