View all Capital Portfolio Members by Parent
get
/api/restapi/capitalPortfolioMember/parentCode
Send a request to this endpoint to view all capital portfolio members under parent with codes matching the code fields in query parameters.
Request
Query Parameters
-
capitalPortfolioName(required): string
The name of a capital portfolio.
This is a required field. -
workspaceCode(required): string
The user-specified identifier of a workspace.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityCapitalPortfolioMember>
Type:
array
Title:
Show Source
List<ApiEntityCapitalPortfolioMember>
-
Array of:
object ApiEntityCapitalPortfolioMember
Title:
ApiEntityCapitalPortfolioMember
Nested Schema : ApiEntityCapitalPortfolioMember
Type:
object
Title:
Show Source
ApiEntityCapitalPortfolioMember
-
capitalPortfolioId: integer
(int64)
The unique identifier of a portfolio.
-
capitalPortfolioMemberId: integer
(int64)
The unique identifier of a portfolio member.
-
capitalPortfolioName: string
Minimum Length:
1
Maximum Length:255
The name of a portfolio. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
memberPortfolioId: integer
(int64)
The unique identifier of a portfolio associated to a portfolio member.
-
memberPortfolioName: string
Minimum Length:
1
Maximum Length:255
The name of a portfolio associated to a portfolio member. -
memberPortfolioWorkspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
memberPortfolioWorkspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The code of the workspace associated to a portfolio member. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
204 Response
Successful operation with no content.
404 Response
The requested capital portfolio member does not exist, or you do not have access to it.