Jump to

• Request
• Response

Batch Update Project Actuals Line Items

put

/api/restapi/projectActualsLineItem/batch

Send a request to this endpoint to update one or more project actual line items.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProjectActualsLineItemInput>

Type: array

Title: List<ApiEntityProjectActualsLineItemInput>

Show Source

• Array of: object ApiEntityProjectActualsLineItemInput
  Title: ApiEntityProjectActualsLineItemInput

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

  • projectActualsLineItemId
  • projectActualsLineItemCode,projectActualsId
  • projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode

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

Nested Schema : ApiEntityProjectActualsLineItemInput

Type: object

Title: ApiEntityProjectActualsLineItemInput

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

• projectActualsLineItemId
• projectActualsLineItemCode,projectActualsId
• projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode

Show Source

• cbsCodes: array cbsCodes
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• cbsCodeSourceId: string
  Maximum Length: 255

  The unique identifier of CBS data in an external source.
• cbsSheetCodeId: integer (int64)
  The CBS code assigned to the actual line item.
• costCategoryAbbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• costCategoryId: integer (int64)
  The system-generated identifier of cost category associated with the project actual line item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category associated with the project actual line item.
• hours: number (double)
  The number of hours needed to complete the actual line item.
• lineItemType: string
  Allowed Values: [ "LUMP_SUM", "UNIT_PRICE" ]

  The type assigned to an actual line item.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the actual line item.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project actual.
• projectActualsId(required): integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
• projectActualsLineItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for an actual line item.
• projectActualsLineItemCost(required): projectActualsLineItemCost
  The cost fields associated with a line item.
• projectActualsLineItemId: integer (int64)
  The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectActualsSourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• quantity: number (double)
  The quantity of the actual line item.
  If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
  If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual line item data in an external source.
• unitOfMeasureId: integer (int64)
  The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.
• unitOfMeasureValue: string
  Minimum Length: 0

  Maximum Length: 255

  The value of a units of measure.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectActualsLineItemInput",
    "required":[
        "name",
        "projectActualsId",
        "projectActualsLineItemCost"
    ],
    "type":"object",
    "properties":{
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "hours":{
            "type":"number",
            "description":"The number of hours needed to complete the actual line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The quantity of the actual line item. <br />If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered. <br />If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of cost category associated with the project actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "lineItemType":{
            "type":"string",
            "description":"The type assigned to an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LUMP_SUM",
                "UNIT_PRICE"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitOfMeasureValue":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The value of a units of measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryAbbreviation":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsSourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsLineItemCost":{
            "description":"The cost fields associated with a line item.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCostInput"
                }
            ]
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsCodeSourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of CBS data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the cost category associated with the project actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The CBS code assigned to the actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of project actual line item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectActualsLineItem object, a unique ProjectActualsLineItem object can be identified by the following combinations of the fields.<ul><li>projectActualsLineItemId</li><li>projectActualsLineItemCode,projectActualsId</li><li>projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : cbsCodes

Type: array

List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectActualsLineItemCost

The cost fields associated with a line item.

Match All

The cost fields associated with a line item.

Show Source

• object ApiEntityProjectActualsLineItemCostInput
  Title: ApiEntityProjectActualsLineItemCostInput

{
    "description":"The cost fields associated with a line item.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCostInput"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsLineItemCostInput

Type: object

Title: ApiEntityProjectActualsLineItemCostInput

Show Source

• projectActualsLineItemId: integer (int64)
  The system-generated identifier of a project actual line item.
• totalProjectActuals(required): number (double)
  The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.
• unitPriceProjectActuals: number (double)
  The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.

{
    "title":"ApiEntityProjectActualsLineItemCostInput",
    "required":[
        "totalProjectActuals"
    ],
    "type":"object",
    "properties":{
        "totalProjectActuals":{
            "type":"number",
            "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unitPriceProjectActuals":{
            "type":"number",
            "description":"The price associated with the actual line item. If a <b>unit of measure</b> is associated with the actual line item, the <b>unit price</b> is the unit price per measure. This value is based on the record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Project Actuals Line Items Using Project Actuals Line Item IDs

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.

Back to Top