View a Contract by Code
get
/primeapi/restapi/contract/code/{code}
This endpoint returns contracts that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
The user-specified identifier of a contract.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityContract
Type:
Show Source
object
-
awardedByCompanyId(optional):
integer(int64)
The company that awarded the contract.
-
awardedByUserId(optional):
integer(int64)
The person in the Awarded By company who is officially responsible for communications about the contract.
-
awardedToCompanyId(optional):
integer(int64)
The company that was awarded the contract.
-
awardedToUserId(optional):
integer(int64)
The person in the Awarded To company who is officially responsible for communications about the contract.
-
codeValuesContract(optional):
array codeValuesContract
Unique Items Required:
true
The actual categories of the contract. -
companyId(optional):
integer(int64)
The company that awarded the contract.
-
contractConfiguredFields(optional):
object ApiEntityContractConfiguredFields
-
contractCost(optional):
object ApiEntityContractCost
-
contractId(optional):
integer(int64)
The ID of the contract. This value should not be provided in create operation request data, however, it is required for update requests.
-
contractManagerCompanyId(optional):
integer(int64)
The system-generated identifier of the company the manager of a contract belongs to.
-
contractManagerUserId(optional):
integer(int64)
The person in your organization who is responsible for managing the contract.
-
contractStatus(optional):
string
Allowed Values:
[ "DRAFT", "PENDING", "APPROVED", "CLOSED", "REJECTED" ]
The status of the contract. -
contractType(optional):
string
Allowed Values:
[ "NONE", "COST_PLUS_FIXED_FEE", "COST_PLUS_PCT_FEE", "GUARANTEED_MAX_PRICE", "LUMP_SUM", "UNIT_PRICE", "TIME_AND_MATERIAL" ]
Specifies how the cost of the contract is calculated. Values can include Cost Plus Fixed Fee, Cost Plus Percentage Fee, Guaranteed Maximum Price, Lump Sum, Time & Material, or Unit Price. -
currency(optional):
integer(int64)
The currency in which the contract is written.
-
description(optional):
string
A brief description of the contract. The description becomes read-only after the contract is approved or closed.
-
finishDate(optional):
string(date-time)
Read Only:
true
The date by which the work contracted is scheduled to be finished. The Finish Date value is not affected by project calendars. -
fixedExchangeRate(optional):
number
Read Only:
true
The company that awarded the contract. -
itemCode:
string
The unique identifier for the contract. By default, the ID is automatically generated based on numbering preferences in the project.
-
itemPrefix(optional):
string
The prefix of a contract code.
-
itemSuffix(optional):
integer(int64)
The suffix of a contract code.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
The name of the contract.
-
performancePeriod(optional):
integer(int32)
Read Only:
true
The period between the contract start and finish dates. If this value is changed, the Finished Date value adjusts automatically. If the start or finish dates are changed, this value adjusts automatically. -
projectId:
integer(int64)
The project associated with the contract.
-
referenceNumber(optional):
string
An optional value that can be used to sort and group contracts.
-
revisedFinishDate(optional):
string(date-time)
Calculated as the contract's Finish Date plus the sum of the Time Change for all approved change orders for the contract.
-
revisedPerformancePeriod(optional):
integer(int32)
The period between when the performance period started and the latest approved change order against the contract.
-
revisedStartDate(optional):
string(date-time)
The revised date by which the work contracted is scheduled to begin.
-
securityGuid(optional):
string
Read Only:
true
The globally unique identifier of a contract. -
startDate(optional):
string(date-time)
The date by which the work contracted is scheduled to be started.
-
statusTransitionData(optional):
object ApiEntityCmStatusTransitionData
-
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 : codeValuesContract
Type:
array
Unique Items Required:
true
The actual categories of the contract.
Show Source
Nested Schema : ApiEntityContractConfiguredFields
Type:
Show Source
object
-
contractId(optional):
integer(int64)
The system-generated identifier of a contract.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a contract.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a contract.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a contract.
-
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 : ApiEntityContractCost
Type:
Show Source
object
-
approvedChangeOrderValue(optional):
object Cost
-
approvedChangeOrderValueContract(optional):
object Cost
-
approvedChangeOrderValueProject(optional):
object Cost
-
contractCostId(optional):
integer(int64)
The system-generated identifier of a contract.
-
contractId(optional):
integer(int64)
The ID of the contract. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentValue(optional):
object Cost
-
currentValueContract(optional):
object Cost
-
currentValueProject(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
nonapprovedChangeOrderValue(optional):
object Cost
-
nonapprovedChangeOrderValueContract(optional):
object Cost
-
nonapprovedChangeOrderValueProject(optional):
object Cost
-
originalValue(optional):
object Cost
-
originalValueContract(optional):
object Cost
-
originalValueProject(optional):
object Cost
-
totalChangeOrderValue(optional):
object Cost
-
totalChangeOrderValueContract(optional):
object Cost
-
totalChangeOrderValueProject(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 : ApiEntityCmStatusTransitionData
Type:
Show Source
object
-
approveByUserId(optional):
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate(optional):
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId(optional):
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate(optional):
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId(optional):
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate(optional):
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType(optional):
string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]
The last status of the agreement, change, or payment application. -
link(optional):
string(url)
Read Only:
true
-
rejectByUserId(optional):
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate(optional):
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate(optional):
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId(optional):
integer(int64)
The user who reopened the agreement.
-
statusTransitionId(optional):
integer(int64)
The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests.
-
submitByUserId(optional):
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate(optional):
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
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. -
voidByUserId(optional):
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate(optional):
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId(optional):
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate(optional):
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId(optional):
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate(optional):
string(date-time)
The date the agreement, change, or payment application was withdrawn.
Nested Schema : ApiEntityCodeValueContract
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueContractId(optional):
integer(int64)
The system-generated identifier of a contract. This value should not be provided in create operation request data, however, it is required for update requests.
-
contractId(optional):
integer(int64)
The ID of the contract.
-
link(optional):
string(url)
Read Only:
true
-
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 : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
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. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
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 : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
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 : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a contract.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a contract.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a contract.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested contract does not exist, or you do not have access to it.