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

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ApiEntityContract
Type: object
Show Source
Nested Schema : codeValuesContract
Type: array
Unique Items Required: true
The actual categories of the contract.
Show Source
Nested Schema : ApiEntityContractConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityContractCost
Type: object
Show Source
Nested Schema : ApiEntityCmStatusTransitionData
Type: object
Show Source
Nested Schema : ApiEntityCodeValueContract
Type: object
Show Source
Nested Schema : ApiEntityCodeType
Type: object
Show Source
Nested Schema : ApiEntityCodeValue
Type: object
Show Source
Nested Schema : assignments
Type: array
Unique Items Required: true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type: object
Show Source
  • ApiEntityCodeType
  • 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.
  • The unique identifier of a code type table.
  • 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.