View a Change Order SOV by Parent and Code
get
/primeapi/restapi/changeOrderSOV/workspace/{worksaceCode}/project/{projectCode}/changeOrder/{changeOrderCode}/associatedAgreement/{associatedAgreementCode}/type/{agreementType}/lineItem/{lineItemCode}/code/{changeOrderSOVCode}
This endpoint returns change order SOVs that meet the following requirements:
- The object is a child of another object with an ID value that matches the value of the {parentId} path parameter.
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
agreementType: string
The type of a change order.Allowed Values:
[ "CONTRACT", "COMMITMENT" ]
-
associatedAgreementCode: string
The user-specified identifier of an agreement.
-
changeOrderCode: string
The user-specified identifier of a change order
-
changeOrderSOVCode: string
The user-specified identifier of a change order schedule of values.
-
lineItemCode: string
The user-specified identifier of a line item.
-
projectCode: string
The user-specified identifier of a project.
-
worksaceCode: string
The user-specified identifier of a WBS.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityChangeOrderSOV
Type:
Show Source
object
-
abbreviation(optional):
string
The abbreviated name of a cost category.
-
associatedAgreementCode(optional):
string
The user-specified identifier of an agreement.
-
cbsCode(optional):
string
Read Only:
true
The user-specified identifier of a CBS. -
changeOrderCode(optional):
string
The user-specified identifier of a change order
-
changeOrderId(optional):
integer(int64)
The system-generated identifier of a change order.
-
changeOrderLineItemCode(optional):
string
The user-specified identifier of a line item.
-
changeOrderLineItemId:
integer(int64)
The system-generated identifier of a line item.
-
changeOrderSovCost:
object ApiEntityChangeOrderSOVCost
-
changeOrderType(optional):
string
Allowed Values:
[ "CONTRACT", "COMMITMENT" ]
The type of a change order. -
costCategoryId(optional):
integer(int64)
The type of expense described by the line item. Typical categories include Material, Other, Equipment, and Labor.
-
costCategoryName(optional):
string
The name of a cost category.
-
costSheetItemId(optional):
integer(int64)
The CBS code assigned to the schedule of values line item.
-
description(optional):
string
A brief explanation of the line item.
-
isSummarySOV(optional):
boolean
Indicates whether the schedule of values is a summary schedule of values.
-
itemCode(optional):
string
A unique identifier for the line item.
-
itemSuffix(optional):
integer(int64)
The suffix of a schedule of values code.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
The name of the line item.
-
parentChangeOrderSovCode(optional):
string
The user-specified identifier of the parent object.
-
parentChangeOrderSovId(optional):
integer(int64)
The system-generated identifier of a schedule of values.
-
percentComplete(optional):
object Percent
-
periodAppliedDate(optional):
string(date-time)
The billing period of the payment application to which the change order schedule of values is applied.
-
projectCode(optional):
string
The user-specified identifier of a project.
-
quantity(optional):
object Quantity
-
sovId(optional):
integer(int64)
The system-generated identifier of a schedule of values. This value should not be provided in create operation request data, however, it is required for update requests.
-
sovType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
Describes how the line item is billed, either as a Lump Sum or Unit Price. -
unitsOfMeasureCode(optional):
string
The user-specified identifier of a project.
-
unitsOfMeasureId(optional):
integer(int64)
The units in which the line item is measured.
-
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. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityChangeOrderSOVCost
Type:
Show Source
object
-
balanceRemaining(optional):
object Cost
-
balanceRemainingAssociatedAgreement(optional):
object Cost
-
balanceRemainingCommitment(optional):
object Cost
-
balanceRemainingContract(optional):
object Cost
-
balanceRemainingLineItem(optional):
object Cost
-
balanceRemainingProject(optional):
object Cost
-
balanceRemainingWorkspace1(optional):
object Cost
-
balanceRemainingWorkspace2(optional):
object Cost
-
balanceRemainingWorkspace3(optional):
object Cost
-
changeOrderSovId(optional):
integer(int64)
The system-generated identifier of a schedule of values. This value should not be provided in create operation request data, however, it is required for update requests.
-
link(optional):
string(url)
Read Only:
true
-
retainage(optional):
object Cost
-
retainageAssociatedAgreement(optional):
object Cost
-
retainageCommitment(optional):
object Cost
-
retainageContract(optional):
object Cost
-
retainageLineItem(optional):
object Cost
-
retainageProject(optional):
object Cost
-
retainageWorkspace1(optional):
object Cost
-
retainageWorkspace2(optional):
object Cost
-
retainageWorkspace3(optional):
object Cost
-
total(optional):
object Cost
-
totalAssociatedAgreement(optional):
object Cost
-
totalCommitment(optional):
object Cost
-
totalContract(optional):
object Cost
-
totalLineItem(optional):
object Cost
-
totalProject(optional):
object Cost
-
totalWorkspace1(optional):
object Cost
-
totalWorkspace2(optional):
object Cost
-
totalWorkspace3(optional):
object Cost
-
unitPrice(optional):
object Cost
-
unitPriceAssociatedAgreement(optional):
object Cost
-
unitPriceCommitment(optional):
object Cost
-
unitPriceContract(optional):
object Cost
-
unitPriceLineItem(optional):
object Cost
-
unitPriceProject(optional):
object Cost
-
unitPriceWorkspace1(optional):
object Cost
-
unitPriceWorkspace2(optional):
object Cost
-
unitPriceWorkspace3(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
404 Response
The requested change order does not exist, or you do not have access to it.