Batch Update Project Collections
put
/primeapi/restapi/projectCollections/batch
Send a request to this endpoint to update one or more project collections. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
Supported Media Types
- application/json
Project Collections to be updated.
Root Schema : List<ApiEntityProjectPortfolio>
Type:
array
Title:
Show Source
List<ApiEntityProjectPortfolio>
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.
Response
Supported Media Types
- application/json
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi/
400 Response
Invalid input.