Read ProjectPortfolio
get
/projectPortfolio
Reads ProjectPortfolio objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter(required): string
Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:Example:
ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'
-
OrderBy(required): string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<ProjectPortfolio>
Type:
array
Title:
Show Source
List<ProjectPortfolio>
-
Array of:
object ProjectPortfolio
Title:
ProjectPortfolio
ProjectPortfolio Entity
Nested Schema : ProjectPortfolio
Type:
object
Title:
ProjectPortfolio
ProjectPortfolio Entity
Show Source
-
CreateDate: string
(date-time)
The date this project portfolio was created.
-
CreateUser: string
The name of the user that created this project portfolio.
-
Description: string
The description of the project portfolio.
-
IncludeClosedProjects: boolean
The flag that indicates whether closed projects are included in the portfolio.
-
IncludeWhatIfProjects: boolean
The flag that indicates whether what-if projects are included in the portfolio.
-
LastUpdateDate: string
(date-time)
The date this project portfolio was last updated.
-
LastUpdateUser: string
The name of the user that last updated this project portfolio.
-
MemberProject: array
MemberProject
MemberProject
-
Name(required): string
The name of the project portfolio.
-
ObjectId: integer
(int32)
The unique ID generated by the system.
-
PortfolioUserIdArray: string
-
PortfolioUserNameArray: string
-
Type: string
The type of the project portfolio: "Manual", "Auto-Maintained", or "Filtered".
-
UserName: string
The user's login name.
-
UserObjectId: integer
(int32)
The unique ID of a specific user who has access to the selected project portfolio.
Nested Schema : MemberProject
Type:
array
MemberProject
Show Source
-
Array of:
object MemberProject
MemberProject
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.