• [0]: object ApiEntityContract

{
    "title":"List<ApiEntityContract>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityContract"
    }
}

• 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.

{
    "type":"object",
    "required":[
        "itemCode",
        "name",
        "projectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the contract."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date by which the work contracted is scheduled to be started."
        },
        "description":{
            "type":"string",
            "description":"A brief description of the contract. The description becomes read-only after the contract is approved or closed."
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier for the contract. By default, the ID is automatically generated based on numbering preferences in the project."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a contract code."
        },
        "itemPrefix":{
            "type":"string",
            "description":"The prefix of a contract code."
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the contract. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "contractType":{
            "type":"string",
            "description":"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.",
            "enum":[
                "NONE",
                "COST_PLUS_FIXED_FEE",
                "COST_PLUS_PCT_FEE",
                "GUARANTEED_MAX_PRICE",
                "LUMP_SUM",
                "UNIT_PRICE",
                "TIME_AND_MATERIAL"
            ]
        },
        "contractCost":{
            "description":"The company that awarded the contract.",
            "$ref":"#/definitions/ApiEntityContractCost"
        },
        "securityGuid":{
            "type":"string",
            "description":"The globally unique identifier of a contract.",
            "readOnly":true
        },
        "finishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date by which the work contracted is scheduled to be finished. The Finish Date value is not affected by project calendars.",
            "readOnly":true
        },
        "currency":{
            "type":"integer",
            "format":"int64",
            "description":"The currency in which the contract is written."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The project associated with the contract."
        },
        "awardedByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in the Awarded By company who is officially responsible for communications about the contract."
        },
        "awardedToCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that was awarded the contract."
        },
        "awardedByCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that awarded the contract."
        },
        "awardedToUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in the Awarded To company who is officially responsible for communications about the contract."
        },
        "codeValuesContract":{
            "type":"array",
            "description":"The actual categories of the contract.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueContract"
            }
        },
        "contractManagerUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in your organization who is responsible for managing the contract."
        },
        "contractManagerCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the company the manager of a contract belongs to."
        },
        "contractConfiguredFields":{
            "description":"<li>The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.</li>",
            "$ref":"#/definitions/ApiEntityContractConfiguredFields"
        },
        "revisedStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The revised date by which the work contracted is scheduled to begin."
        },
        "revisedFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"Calculated as the contract's Finish Date plus the sum of the Time Change for all approved change orders for the contract."
        },
        "revisedPerformancePeriod":{
            "type":"integer",
            "format":"int32",
            "description":"The period between when the performance period started and the latest approved change order against the contract."
        },
        "statusTransitionData":{
            "description":"The system-generated identifier of a contract status transition.",
            "$ref":"#/definitions/ApiEntityCmStatusTransitionData"
        },
        "contractStatus":{
            "type":"string",
            "description":"The status of the contract.",
            "enum":[
                "DRAFT",
                "PENDING",
                "APPROVED",
                "CLOSED",
                "REJECTED"
            ]
        },
        "referenceNumber":{
            "type":"string",
            "description":"An optional value that can be used to sort and group contracts."
        },
        "performancePeriod":{
            "type":"integer",
            "format":"int32",
            "description":"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.",
            "readOnly":true
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The company that awarded the contract.",
            "readOnly":true
        },
        "companyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that awarded the contract."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityCodeValueContract

{
    "type":"array",
    "description":"The actual categories of the contract.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueContract"
    }
}

• contractId(optional): integer(int64)
  The system-generated identifier of a contract.
• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  The cost fields associated with a contract.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  The cost fields associated with a contract.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  The 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a contract.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a contract.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a contract.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a contract."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the contract. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "currentValue":{
            "description":"The present value of the cost.",
            "$ref":"#/definitions/Cost"
        },
        "nonapprovedChangeOrderValueProject":{
            "description":"The pending change order cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "nonapprovedChangeOrderValueContract":{
            "description":"The pending change order cost of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "approvedChangeOrderValueProject":{
            "description":"The approved change order cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "approvedChangeOrderValueContract":{
            "description":"The approved change order cost of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "nonapprovedChangeOrderValue":{
            "description":"The pending cost of a change order.",
            "$ref":"#/definitions/Cost"
        },
        "totalChangeOrderValue":{
            "description":"The total change order cost of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "approvedChangeOrderValue":{
            "description":"The approved change order costs of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "totalChangeOrderValueProject":{
            "description":"The total change order cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "totalChangeOrderValueContract":{
            "description":"The total change order cost of a constract.",
            "$ref":"#/definitions/Cost"
        },
        "originalValueContract":{
            "description":"The original cost of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "currentValueContract":{
            "description":"The current cost of a contract.",
            "$ref":"#/definitions/Cost"
        },
        "originalValueProject":{
            "description":"The original cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "currentValueProject":{
            "description":"The current cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "contractCostId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a contract."
        },
        "originalValue":{
            "description":"The value of the cost the first time it was saved.",
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "rejectDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was rejected."
        },
        "approveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was approved."
        },
        "submitDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was submitted for approval."
        },
        "withdrawDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was withdrawn."
        },
        "rreopenByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who reopened the agreement."
        },
        "withdrawByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew the agreement, change, or payment application."
        },
        "cancelByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who cancelled the agreement, change, or payment application."
        },
        "lastStatusTransitionType":{
            "type":"string",
            "description":"The last status of the agreement, change, or payment application.",
            "enum":[
                "SUBMIT",
                "APPROVE",
                "WITHDRAW_APPROVAL",
                "CLOSE",
                "REOPEN",
                "REJECT",
                "VOID",
                "WITHDRAW",
                "ANSWERED",
                "NONE"
            ]
        },
        "statusTransitionId":{
            "type":"integer",
            "format":"int64",
            "description":"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."
        },
        "withdrawApprovalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when approval for the agreement, change, or payment application was withdrawn."
        },
        "submitByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who submitted the agreement, change, or payment application for approval."
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who withdrew approval of the agreement, change, or payment application."
        },
        "approveByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who approved the agreement, change, or payment application."
        },
        "rejectByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who rejected the agreement, change, or payment application."
        },
        "voidByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who voided the agreement, change, or payment application."
        },
        "reopenDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was reopened."
        },
        "closeDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was closed."
        },
        "voidDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was voided."
        },
        "cancelDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was cancelled."
        },
        "closeByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who closed the agreement, change order, or payment application."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The system-generated identifier of a code value.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"The type of a code.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the contract."
        },
        "codeValueContractId":{
            "type":"integer",
            "format":"int64",
            "description":"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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "required":[
        "codeTypeCode",
        "codeTypeName",
        "pushDownType",
        "workspace"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a code type."
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "assignments":{
            "type":"array",
            "description":"CodeType assignments.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeEntityType"
            }
        },
        "codeTypeCode":{
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "workspace":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the owning workspace."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• 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.

{
    "type":"object",
    "required":[
        "codeTypeId",
        "codeTypeName",
        "codeValueCode",
        "codeValueName",
        "sequenceNumber"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the code value."
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the code type."
        },
        "codeValueName":{
            "type":"string",
            "description":"The name of the code value.",
            "enum":[
                "LENGTH[1-100]"
            ]
        },
        "codeValueCode":{
            "type":"string",
            "description":"The unique identifier for the code value.",
            "enum":[
                "LENGTH[1-32]"
            ]
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The number that specifies the position of the code value item within the code type list."
        },
        "parentCodeValue":{
            "type":"integer",
            "format":"int64",
            "description":"The parent code value."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityCodeEntityType

{
    "type":"array",
    "description":"CodeType assignments.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeEntityType"
    }
}

• 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.

{
    "type":"object",
    "required":[
        "codeType",
        "entityType",
        "primaryKey"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeType":{
            "description":"The unique identifier of a code type.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "entityType":{
            "type":"string",
            "description":"Indicates the type of object the code is associated to.",
            "enum":[
                "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"
            ]
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a code type table."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a contract.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a contract.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a contract.",
    "additionalProperties":{
        "type":"object"
    }
}