Return Funds for the Specified Portfolio Code and Workspace Code.
get
/primeapi/restapi/funds/portfolio/list?portfolioCode={portfolioCode}&workspaceCode={workspaceCode}
Return funds for the specified portfolio code and workspace code.
Request
Query Parameters
-
portfolioCode: string
Code of the portfolio to be found.
-
workspaceCode: string
Code of the workspace to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityFund
Type:
Show Source
object
-
appropriationType(optional):
string
Allowed Values:
[ "NONE", "MANUAL", "FROM_ALLOCATION" ]
The type of appropriation. -
capitalPortfolioId(optional):
integer(int64)
The unique identification code of the portfolio.
-
capitalPortfolioName(optional):
string
The name of the portfolio.
-
codeValuesFund(optional):
array codeValuesFund
Unique Items Required:
true
-
configuredFields(optional):
object ApiEntityFundConfiguredFields
-
consumptionType(optional):
string
Allowed Values:
[ "NONE", "MANUAL", "FROM_ALLOCATION", "FROM_ACTUAL" ]
The type of consumption. -
distributionType:
string
Allowed Values:
[ "YEARLY", "QUARTERLY", "MONTHLY", "LUMP_SUM" ]
Specifies how money is distributed for the fund. -
endDate:
string(date-time)
The date when money in the fund will no longer be available.
-
fromAllocation(optional):
boolean
Allowed Values:
[ true, false ]
Specifies whether the fund has allocations. -
fundCost(optional):
object ApiEntityFundCost
-
fundId(optional):
integer(int64)
The unique identification code of the fund.
-
fundStatus(optional):
string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
Either Active or Inactive. Inactive funds cannot be allocated or appropriated. They can only be consumed for projects. -
hasAllocations(optional):
boolean
Allowed Values:
[ true, false ]
Specifies whether the fund has allocations. -
itemCode:
string
The unique identification code of the fund.
-
link(optional):
string(url)
Read Only:
true
-
name:
string
The name of the fund.
-
parentFundCode(optional):
string
The unique identification code of the fund.
-
parentFundId(optional):
integer(int64)
The unique identification code of the parent fund.
-
parentWorkspaceCode(optional):
string
Workspace Code.
-
projectCode(optional):
string
The unique identifier for a project set by the user who created the project.
-
projectId(optional):
integer(int64)
The unique identifier for the project.
-
spreadRows(optional):
array spreadRows
Unique Items Required:
true
-
startDate:
string(date-time)
The date when money in the fund will start being available.
-
type(optional):
string
Allowed Values:
[ "WORKSPACE_FUND", "PROJECT_FUND", "PORTFOLIO_FUND" ]
The kind of object with which the fund is associated. This can either be Project or Workspace. -
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. -
workspaceCode(optional):
string
Workspace Code.
-
workspaceId(optional):
integer(int64)
The unique identification code of the workspace.
Nested Schema : ApiEntityFundConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesContains Fund cost configured fields and its values.
-
fundId(optional):
integer(int64)
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesContains Fund other configured fields and its values.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesContains Fund text configured fields and its values.
-
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.
Nested Schema : ApiEntityFundCost
Type:
Show Source
object
-
allocated(optional):
object Cost
-
allocatedProject(optional):
object Cost
-
appropriated(optional):
object Cost
-
appropriatedProject(optional):
object Cost
-
consumed(optional):
object Cost
-
consumedProject(optional):
object Cost
-
distributedTotal(optional):
object Cost
-
distributedTotalProject(optional):
object Cost
-
fundId:
integer(int64)
-
link(optional):
string(url)
Read Only:
true
-
remaining(optional):
object Cost
-
remainingProject(optional):
object Cost
-
total(optional):
object Cost
-
totalProject(optional):
object Cost
-
unallocated(optional):
object Cost
-
unallocatedProject(optional):
object Cost
-
unappropriated(optional):
object Cost
-
unappropriatedProject(optional):
object Cost
-
undistributedTotal(optional):
object Cost
-
undistributedTotalProject(optional):
object Cost
-
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.
Nested Schema : ApiEntityCodeValueFund
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueFundId(optional):
integer(int64)
The unique identifier for the fund.
-
fundId(optional):
integer(int64)
The unique identification code of the fund.
-
link(optional):
string(url)
Read Only:
true
-
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.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
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.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
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.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
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.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
Contains Fund cost configured fields and its values.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
Contains Fund other configured fields and its values.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
Contains Fund text configured fields and its values.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Nested Schema : ApiEntityFundSpreadRow
Type:
Show Source
object
-
fundAllocationSpreadRows(optional):
array fundAllocationSpreadRows
Unique Items Required:
true
-
fundSpreadRowCost(optional):
object BaseApiEntityFundCostSpreadRow
-
fundSpreadRowId(optional):
integer(int64)
The unique identification code of the spread row.
-
link(optional):
string(url)
Read Only:
true
-
month(optional):
string(date-time)
-
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.
Nested Schema : BaseApiEntityFundCostSpreadRow
Type:
Show Source
object
-
allocated(optional):
object Cost
-
allocatedProject(optional):
object Cost
-
appropriated(optional):
object Cost
-
appropriatedProject(optional):
object Cost
-
consumed(optional):
object Cost
-
consumedProject(optional):
object Cost
-
fundSpreadRowId(optional):
integer(int64)
-
link(optional):
string(url)
Read Only:
true
-
remaining(optional):
object Cost
-
remainingProject(optional):
object Cost
-
total(optional):
object Cost
-
totalProject(optional):
object Cost
-
unallocated(optional):
object Cost
-
unallocatedProject(optional):
object Cost
-
unappropriated(optional):
object Cost
-
unappropriatedProject(optional):
object Cost
-
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.
Nested Schema : ApiEntityFundAllocationSpreadRow
Type:
Show Source
object
-
fund(optional):
object ApiEntityFund
-
fundAllocationSpreadRowCost(optional):
object ApiEntityFundAllocationSpreadRowCost
-
fundAllocationSpreadRowId(optional):
integer(int64)
The unique identification code of the allocation row.
-
fundId(optional):
integer(int64)
The unique identification code of the fund.
-
fundSpreadRowId(optional):
integer(int64)
The unique identification code of the spread row.
-
link(optional):
string(url)
Read Only:
true
-
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.
Nested Schema : ApiEntityFundAllocationSpreadRowCost
Type:
Show Source
object
-
allocated(optional):
object Cost
-
allocatedProject(optional):
object Cost
-
fundAllocationSpreadRowId(optional):
integer(int64)
-
link(optional):
string(url)
Read Only:
true
-
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.
404 Response
The requested object does not exist, or you do not have access to it.