View a Project Collection by Name
get
/primeapi/restapi/projectCollections/name/{name}
This endpoint returns project collections that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
Request
Path Parameters
-
name: string
Name of the Project Collection to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityProjectPortfolio
Type:
Show Source
object
-
description(optional):
string
Details about the project collection.
-
filter(optional):
string
The criteria that determines which projects are included in the project collection.
-
lastRefreshDate(optional):
object TimezoneSensitiveDateTime
-
link(optional):
string(url)
Read Only:
true
-
projectPortfolioId:
integer(int64)
The unique identifier of a portfolio.
-
projectPortfolioItems(optional):
array projectPortfolioItems
Unique Items Required:
true
The items stored in the portfolio. -
projectPortfolioName(optional):
string
The name of the project collection.
-
projectPortfolioType(optional):
string
Allowed Values:
[ "MANUAL", "FILTER" ]
Projects are manually selected for the project collection. -
securityGuid(optional):
string
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. -
workspaceId(optional):
integer(int64)
The workspace ID to which the project collection refers to.
Nested Schema : projectPortfolioItems
Type:
array
Unique Items Required:
true
The items stored in the portfolio.
Show Source
Nested Schema : ApiEntityProjectPortfolioItem
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
projectId:
integer(int64)
The unique identifier of a project.
-
projectPortfolioId:
integer(int64)
The unique identifier of a portfolio.
-
projectPortfolioItemId(optional):
integer(int64)
The unique identifier of a portfolio project.
-
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.
204 Response
Successful operation with no content.
404 Response
The requested project collections do not exist, or you do not have access to them.