• [0]: object ApiEntityExternallySourcedCommitment

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

• approvalDate(optional): string(date-time)
  Read Only: true

  The date on which the commitment was approved.
• approveByUserName(optional): string
  The name of the user that approved the commitment.
• approvedByUserId(optional): integer(int64)
  Read Only: true

  The system-generated identifier of the user that approved the commitment.
• awardedByCompanyId(optional): integer(int64)
  The company that awarded the commitment.
• awardedByUserId(optional): integer(int64)
  The system-generated identifier of a user.
• awardedToCompanyId(optional): integer(int64)
  The company that was awarded the commitment.
• awardedToUserId(optional): integer(int64)
  The person in the Awarded To Company who is officially responsible for communications about the commitment.
• closeByUserName(optional): string
  The name of the user that closed the commitment.
• closeDate(optional): string(date-time)
  Read Only: true

  The date on which the commitment was closed.
• codeValuesCommitment(optional): array codeValuesCommitment
  Unique Items Required: true
• commitmentConfiguredFields(optional): object ApiEntityCommitmentConfiguredFields
• commitmentCost(optional): object ApiEntityCommitmentCost
• commitmentId(optional): integer(int64)
  The system-generated identifier of a commitment.
• commitmentManagerUserId(optional): integer(int64)
  The person who is responsible for managing the commitment.
• commitmentManagerUserName(optional): string
• commitmentStatus(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "PENDING", "APPROVED", "CLOSED", "REJECTED" ]

  The status of the commitment.
• commitmentType(optional): string
  Allowed Values: [ "NONE", "COST_PLUS_FIXED_FEE", "COST_PLUS_PCT_FEE", "GUARANTEED_MAX_PRICE", "LUMP_SUM", "UNIT_PRICE", "TIME_AND_MATERIAL" ]

  The type of the commitment.
• contractId(optional): integer(int64)
  The unique identifier of the commitment.
• currencyCode(optional): string
• currencyId(optional): integer(int64)
  The unique identifier of a currency.
• description(optional): string
  Allowed Values: [ "Length[0-4000]" ]

  Details about the commitment.
• exchangeRate(optional): number
• finishDate(optional): string(date-time)
  The date when the work represented by the commitment is expected to be finished.
• fromCompanyName(optional): string
  The company that awarded the commitment.
• fromCompanyPostalCode(optional): string
  The postal code of the company that awarded the commitment.
• fromCompanySiteId(optional): string
  The unique identifier of the site of the company that awarded the commitment.
• fromCompanySourceId(optional): string
  The unique identifier of company data in an external source.
• fromContactUserName(optional): string
  The person at the company that awarded the commitment who is officially responsible for communications about the commitment.
• itemCode: string
  Allowed Values: [ "Length[0-60]" ]
• lastStatusAction(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
• name: string
  Allowed Values: [ "Length[0-255]" ]

  The name of the commitment.
• performancePeriod(optional): integer(int32)
  The period of time during which the work captured by the commitment is planned to be done.
• projectCode(optional): string
  The user-specified identifier of a project.
• projectId: integer(int64)
  The unique identifier for the project.
• projectSourceId(optional): string
  The unique identifier of a project in an external source.
• referenceNumber(optional): string
  Allowed Values: [ "Length[0-60]" ]

  The reference number of the commitment.
• rejectByUserName(optional): string
  The user who rejected the commitment.
• rejectedDate(optional): string(date-time)
  The date when the agreement, change, or payment application was rejected.
• reopenByUserName(optional): string
  The user who reopened the commitment.
• reopenDate(optional): string(date-time)
  Read Only: true

  The date on which the commitment was reopened.
• revisedFinishDate(optional): string(date-time)
  Read Only: true

  The revised finish date of the commitment.
• revisedPerformancePeriod(optional): integer(int32)
  Read Only: true

  The revised performance period of the commitment.
• revisedStartDate(optional): string(date-time)
  Read Only: true

  The revised start date of the commitment.
• securityGuid(optional): string
  Read Only: true

  The globally unique identifier of a commitment.
• sourceId(optional): string
  The unique identifier of commitment data in an external source.
• sovapprovalDate(optional): string(date-time)
  Read Only: true

  The date on which the commitment's schedule of values was approved.
• startDate(optional): string(date-time)
  The data on which the commitment began.
• statusTransitionData(optional): object ApiEntityCmStatusTransitionData
• submitByUserName(optional): string
  The user who submitted the commitment.
• submitedDate(optional): string(date-time)
  The date the agreement, change, or payment application was submitted for approval.
• toCompanyName(optional): string
  The company the commitment was awarded to.
• toCompanyPostalCode(optional): string
  The postal code of the company the commitment was awarded to.
• toCompanySiteId(optional): string
  The site of the company the commitment was awarded to.
• toCompanySourceId(optional): string
  The unique identifier of the company the commitment was awarded to.
• toContactUserName(optional): string
  The user assigned as a contact for the commitment.
• 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.
• withdrawApprovalByUserName(optional): string
  The user who withdrew approval of the commitment.
• withdrawApprovalDate(optional): string(date-time)
  Read Only: true

  The date on which approval for the commitment was withdrawn.
• workspaceCode(optional): string
  The user-specified identifier of a workspace.

{
    "type":"object",
    "required":[
        "itemCode",
        "name",
        "projectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project."
        },
        "currencyCode":{
            "type":"string"
        },
        "toCompanySiteId":{
            "type":"string",
            "description":"The site of the company the commitment was awarded to."
        },
        "fromCompanyPostalCode":{
            "type":"string",
            "description":"The postal code of the company that awarded the commitment."
        },
        "lastStatusAction":{
            "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"
            ]
        },
        "commitmentManagerUserName":{
            "type":"string"
        },
        "toCompanyPostalCode":{
            "type":"string",
            "description":"The postal code of the company the commitment was awarded to."
        },
        "fromCompanySiteId":{
            "type":"string",
            "description":"The unique identifier of the site of the company that awarded the commitment."
        },
        "reopenByUserName":{
            "type":"string",
            "description":"The user who reopened the commitment."
        },
        "fromCompanySourceId":{
            "type":"string",
            "description":"The unique identifier of company data in an external source."
        },
        "fromContactUserName":{
            "type":"string",
            "description":"The person at the company that awarded the commitment who is officially responsible for communications about the commitment."
        },
        "toContactUserName":{
            "type":"string",
            "description":"The user assigned as a contact for the commitment."
        },
        "projectSourceId":{
            "type":"string",
            "description":"The unique identifier of a project in an external source."
        },
        "toCompanySourceId":{
            "type":"string",
            "description":"The unique identifier of the company the commitment was awarded to."
        },
        "fromCompanyName":{
            "type":"string",
            "description":"The company that awarded the commitment."
        },
        "closeByUserName":{
            "type":"string",
            "description":"The name of the user that closed the commitment."
        },
        "rejectByUserName":{
            "type":"string",
            "description":"The user who rejected the commitment."
        },
        "approveByUserName":{
            "type":"string",
            "description":"The name of the user that approved the commitment."
        },
        "submitByUserName":{
            "type":"string",
            "description":"The user who submitted the commitment."
        },
        "withdrawApprovalByUserName":{
            "type":"string",
            "description":"The user who withdrew approval of the commitment."
        },
        "rejectedDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the agreement, change, or payment application was rejected."
        },
        "submitedDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the agreement, change, or payment application was submitted for approval."
        },
        "toCompanyName":{
            "type":"string",
            "description":"The company the commitment was awarded to."
        },
        "name":{
            "type":"string",
            "description":"The name of the commitment.",
            "enum":[
                "Length[0-255]"
            ]
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The data on which the commitment began."
        },
        "description":{
            "type":"string",
            "description":"Details about the commitment.",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"",
            "enum":[
                "Length[0-60]"
            ]
        },
        "contractId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the commitment."
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a commitment."
        },
        "securityGuid":{
            "type":"string",
            "description":"The globally unique identifier of a commitment.",
            "readOnly":true
        },
        "finishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the work represented by the commitment is expected to be finished."
        },
        "sourceId":{
            "type":"string",
            "description":"The unique identifier of commitment data in an external source."
        },
        "currencyId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a currency."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        },
        "awardedByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a user."
        },
        "commitmentType":{
            "type":"string",
            "description":"The type of the commitment.",
            "enum":[
                "NONE",
                "COST_PLUS_FIXED_FEE",
                "COST_PLUS_PCT_FEE",
                "GUARANTEED_MAX_PRICE",
                "LUMP_SUM",
                "UNIT_PRICE",
                "TIME_AND_MATERIAL"
            ]
        },
        "awardedToCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that was awarded the commitment."
        },
        "awardedByCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company that awarded the commitment."
        },
        "approvedByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the user that approved the commitment.",
            "readOnly":true
        },
        "sovapprovalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the commitment's schedule of values was approved.",
            "readOnly":true
        },
        "commitmentStatus":{
            "type":"string",
            "description":"The status of the commitment.",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "PENDING",
                "APPROVED",
                "CLOSED",
                "REJECTED"
            ]
        },
        "codeValuesCommitment":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueCommitment"
            }
        },
        "commitmentManagerUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The person who is responsible for managing the commitment."
        },
        "awardedToUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The person in the Awarded To Company who is officially responsible for communications about the commitment."
        },
        "commitmentConfiguredFields":{
            "$ref":"#/definitions/ApiEntityCommitmentConfiguredFields"
        },
        "revisedStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The revised start date of the commitment.",
            "readOnly":true
        },
        "revisedFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The revised finish date of the commitment.",
            "readOnly":true
        },
        "withdrawApprovalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which approval for the commitment was withdrawn.",
            "readOnly":true
        },
        "revisedPerformancePeriod":{
            "type":"integer",
            "format":"int32",
            "description":"The revised performance period of the commitment.",
            "readOnly":true
        },
        "statusTransitionData":{
            "description":"The system-generated identifier of a contract status transition.",
            "$ref":"#/definitions/ApiEntityCmStatusTransitionData"
        },
        "referenceNumber":{
            "type":"string",
            "description":"The reference number of the commitment.",
            "enum":[
                "Length[0-60]"
            ]
        },
        "performancePeriod":{
            "type":"integer",
            "format":"int32",
            "description":"The period of time during which the work captured by the commitment is planned to be done."
        },
        "commitmentCost":{
            "$ref":"#/definitions/ApiEntityCommitmentCost"
        },
        "exchangeRate":{
            "type":"number"
        },
        "approvalDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the commitment was approved.",
            "readOnly":true
        },
        "reopenDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the commitment was reopened.",
            "readOnly":true
        },
        "closeDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the commitment was closed.",
            "readOnly":true
        },
        "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 ApiEntityCodeValueCommitment

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueCommitment"
    }
}

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

  An object containing cost fields in the form of key-value pairs.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing non-cost and non-text fields in the form of key-value pairs.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  An object containing text fields in the form of key-value pairs.
• 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":"An object containing cost fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a commitment."
        },
        "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
        }
    }
}

• commitmentId(optional): integer(int64)
  The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
• currentValueCommitment(optional): object Cost
• link(optional): string(url)
  Read Only: true
• originalValue(optional): object Cost
• originalValueCommitment(optional): object Cost
• originalValueContract(optional): object Cost
• originalValueProject(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
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "currentValueCommitment":{
            "description":"The present value of the cost.",
            "$ref":"#/definitions/Cost"
        },
        "originalValueCommitment":{
            "description":"The original value of a commitment.",
            "$ref":"#/definitions/Cost"
        },
        "originalValueContract":{
            "description":"The sum of original costs of a commitment.",
            "$ref":"#/definitions/Cost"
        },
        "originalValueProject":{
            "description":"The original cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "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: object ApiEntityCodeValue
• codeValueCommitmentId: integer(int64)
  The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
• commitmentId(optional): integer(int64)
  The unique identifier of the commitment.
• 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",
    "required":[
        "codeValue",
        "codeValueCommitmentId"
    ],
    "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"
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the commitment."
        },
        "codeValueCommitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a commitment. 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":"An object containing cost fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing non-cost and non-text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"An object containing text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}