• [0]: object ApiEntityPortfolio

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

• autoRefresh(optional): boolean
  Indicates whether the portfolio is set to refresh automatically.
• capitalPortfolioConfiguredFields(optional): object ApiEntityPortfolioConfiguredFields
• capitalPortfolioId: integer(int64)
• codeValuesPortfolio(optional): array codeValuesPortfolio
  Unique Items Required: true

  The categories of a portfolio.
• description: string
  Allowed Values: [ "Length[0-4000]" ]
• filter: string
  Allowed Values: [ "Length[0-4000]" ]

  Determines if projects included in the portfolio must meet all or any of the defined filter rules.
  Selecting an appropriate filter criteria helps specify the portfolio's project inclusions.
• image: object ApiEntityPortfolioImage
• lastRefreshDate(optional): object TimezoneSensitiveDateTime
• link(optional): string(url)
  Read Only: true
• linkType: string
  Allowed Values: [ "FORECAST", "PLANNED_BUDGET" ]

  Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
  Linked values will be factored into a budget plan's Proposed Budget.
  Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
  Any portfolio budget plans added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.
• name: string
  Allowed Values: [ "Length[1-255]" ]
• ownerId(optional): integer(int64)
  The owner of a portfolio.
• periodId: integer(int64)
  The unique identifier of a portfolio period.
• planningHorizon(optional): integer(int32)
• projects(optional): array projects
  The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.
• securityGuid(optional): string
  Allowed Values: [ "Length[0-4000]" ]

  Globally unique identifier of a portfolio.
• 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 workspace ID for the portfolio.
• workspaceId(optional): integer(int64)
  The workspace ID for the portfolio.
• yearsPlannedInMonth: integer(int32)
• yearsPlannedInQuarter: integer(int32)
• yearsPlannedInYear: integer(int32)

{
    "type":"object",
    "required":[
        "capitalPortfolioId",
        "description",
        "filter",
        "image",
        "linkType",
        "name",
        "periodId",
        "workspace",
        "yearsPlannedInMonth",
        "yearsPlannedInQuarter",
        "yearsPlannedInYear"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "enum":[
                "Length[1-255]"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The workspace ID for the portfolio."
        },
        "periodId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a portfolio period."
        },
        "description":{
            "type":"string",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "projects":{
            "type":"array",
            "description":"The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.",
            "items":{
                "$ref":"#/definitions/ApiEntityPortfolioProject"
            }
        },
        "linkType":{
            "type":"string",
            "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget. <br />Linked values will be factored into a budget plan's Proposed Budget. <br />Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans. <br />Any portfolio budget plans added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.",
            "enum":[
                "FORECAST",
                "PLANNED_BUDGET"
            ]
        },
        "autoRefresh":{
            "type":"boolean",
            "description":"Indicates whether the portfolio is set to refresh automatically."
        },
        "filter":{
            "type":"string",
            "description":"Determines if projects included in the portfolio must meet all or any of the defined filter rules. <br />Selecting an appropriate filter criteria helps specify the portfolio's project inclusions.",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "image":{
            "$ref":"#/definitions/ApiEntityPortfolioImage"
        },
        "securityGuid":{
            "type":"string",
            "description":"Globally unique identifier of a portfolio.",
            "enum":[
                "Length[0-4000]"
            ]
        },
        "workspace":{
            "type":"integer",
            "format":"int64",
            "description":"The workspace ID for the portfolio."
        },
        "ownerId":{
            "type":"integer",
            "format":"int64",
            "description":"The owner of a portfolio."
        },
        "capitalPortfolioConfiguredFields":{
            "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/ApiEntityPortfolioConfiguredFields"
        },
        "planningHorizon":{
            "type":"integer",
            "format":"int32"
        },
        "yearsPlannedInMonth":{
            "type":"integer",
            "format":"int32"
        },
        "capitalPortfolioId":{
            "type":"integer",
            "format":"int64"
        },
        "yearsPlannedInQuarter":{
            "type":"integer",
            "format":"int32"
        },
        "yearsPlannedInYear":{
            "type":"integer",
            "format":"int32"
        },
        "lastRefreshDate":{
            "description":"The date a refresh was last performed on the filter for the portfolio. The projects available in the portfolio are up-to-date as of the last refresh date.",
            "$ref":"#/definitions/TimezoneSensitiveDateTime"
        },
        "codeValuesPortfolio":{
            "type":"array",
            "description":"The categories of a portfolio.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValuePortfolio"
            }
        },
        "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
        }
    }
}

• capitalPortfolioId(optional): integer(int64)
  The system-generated identifier of a portfolio.
• 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, 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, 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"
            }
        },
        "capitalPortfolioId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a portfolio."
        },
        "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 ApiEntityCodeValuePortfolio

{
    "type":"array",
    "description":"The categories of a portfolio.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValuePortfolio"
    }
}

• image: array image
• imageType: string
  Allowed Values: [ "PNG", "JPEG", "GIF" ]
• link(optional): string(url)
  Read Only: true
• portfolio: integer(int64)
• portfolioImageId: integer(int64)
• uniqueName(optional): string
• 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":[
        "image",
        "imageType",
        "portfolio",
        "portfolioImageId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "image":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "imageType":{
            "type":"string",
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "uniqueName":{
            "type":"string"
        },
        "portfolioImageId":{
            "type":"integer",
            "format":"int64"
        },
        "portfolio":{
            "type":"integer",
            "format":"int64"
        },
        "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
        }
    }
}

• wrappedDateTime(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "wrappedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

• [0]: object ApiEntityPortfolioProject

{
    "type":"array",
    "description":"The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.",
    "items":{
        "$ref":"#/definitions/ApiEntityPortfolioProject"
    }
}

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

• codeType(optional): object ApiEntityCodeType
• codeValue: object ApiEntityCodeValue
• codeValuePortfolioId: integer(int64)
  The system-generated identifier of a portfolio.
• link(optional): string(url)
  Read Only: true
• portfolioId: integer(int64)
  The system-generated identifier of a portfolio.
• 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",
        "codeValuePortfolioId",
        "portfolioId"
    ],
    "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"
        },
        "codeValuePortfolioId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a portfolio."
        },
        "portfolioId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a portfolio."
        },
        "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
        }
    }
}

• [0]: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

• capitalPortfolioId(optional): integer(int64)
  The portfolio that includes the project.
• capitalPortfolioProjectId(optional): integer(int64)
  The unique identifier of a project contained in a portfolio.
• link(optional): string(url)
  Read Only: true
• projectId(optional): integer(int64)
  The unique identifier for the portfolio.
• 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
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the portfolio."
        },
        "capitalPortfolioId":{
            "type":"integer",
            "format":"int64",
            "description":"The portfolio that includes the project."
        },
        "capitalPortfolioProjectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project contained in a portfolio."
        },
        "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
        }
    }
}