Jump to

• Request
• Response

View Portfolio Projects by Portfolio

get

/api/restapi/portfolioProject/portfolio/{capitalPortfolioId}

This endpoint returns a portofolio project that meet the following requirements:

• The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.

Portfolio projects are references to projects that belong to a portfolio.

Request

Path Parameters

• capitalPortfolioId(required): integer(int64)
  The system-generated identifier of a portfolio.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityPortfolioProject>

Type: array

Title: List<ApiEntityPortfolioProject>

Show Source

• Array of: object ApiEntityPortfolioProject
  Title: ApiEntityPortfolioProject

{
    "title":"List<ApiEntityPortfolioProject>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityPortfolioProject

Type: object

Title: ApiEntityPortfolioProject

Show Source

• capitalPortfolioId: integer (int64)
  The portfolio that includes the project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectId: integer (int64)
  The unique identifier for the portfolio.
• projectPortfolioProjectId: integer (int64)
  The unique identifier of a project contained in a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• review: boolean
  Indicates a project in the capital plan is currently undergoing review.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityPortfolioProject",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectPortfolioProjectId":{
            "type":"integer",
            "description":"The unique identifier of a project contained in a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The portfolio that includes the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "review":{
            "type":"boolean",
            "description":"Indicates a project in the capital plan is currently undergoing review.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested portfolio project does not exist, or you do not have access to it.

Back to Top