Show Source

• [0]: object ApiEntityCodeType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityCodeType"
    }
}

Show Source

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

Show Source

• [0]: object ApiEntityCodeEntityType

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

Show Source

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