Update a Commitment Line Item
put
/primeapi/restapi/commitmentLineItem
Send a request to this endpoint to update a commitment. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
Supported Media Types
- application/json
A line item object.
Root Schema : ApiEntityCommitmentLineItem
Type:
Show Source
object
-
commitmentId:
integer(int64)
The unique identifier of the commitment.
-
commitmentLineItemCost(optional):
object ApiEntityCommitmentLineItemCost
-
costCategoryId(optional):
integer(int64)
The system-generated identifier of a cost category.
-
costSheetItem(optional):
integer(int64)
The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
-
currencyId(optional):
integer(int64)
The unique identifier of a currency.
-
description(optional):
string
Allowed Values:
[ "Length[0-4000]" ]
Additional details for the commitment. -
itemCode:
string
Allowed Values:
[ "Length[0-60]" ]
The user-specified identifier of a line item. -
lineItemId(optional):
integer(int64)
The unique identifier for the line item. This value should not be provided in create operation request data, however, it is required for update requests.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type of a line item. -
link(optional):
string(url)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[0-255]" ]
The name of a line item. -
pegRate(optional):
number
Read Only:
true
The peg rate of a line item. -
quantity(optional):
object Quantity
-
sourceId(optional):
string
The unique identifier of a commitment line item in an external source.
-
unitsOfMeasureId(optional):
integer(int64)
The unique identifier for the unit of measure.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCommitmentLineItemCost
Type:
Show Source
object
-
lineItemId(optional):
integer(int64)
-
link(optional):
string(url)
Read Only:
true
-
total(optional):
object Cost
-
totalCommitment(optional):
object Cost
-
totalContract(optional):
object Cost
-
totalLineItem(optional):
object Cost
-
totalProject(optional):
object Cost
-
unitPrice(optional):
object Cost
-
unitPriceCommitment(optional):
object Cost
-
unitPriceContract(optional):
object Cost
-
unitPriceLineItem(optional):
object Cost
-
unitPriceProject(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Quantity
Type:
object
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
204 Response
Successful operation with no content.
400 Response
Invalid input for the Commitment Line Item service. Verify the request contains valid data, then resubmit the request.