Jump to

• Request
• Response

View All Portfolio Measures Owned by a User

get

/api/restapi/portfolioMeasure/currentUserPortfolios

Send a request to this endpoint to view all portfolio measures owned by the current user.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityPortfolioMeasure>

Type: array

Title: List<ApiEntityPortfolioMeasure>

Show Source

• Array of: object ApiEntityPortfolioMeasure
  Title: ApiEntityPortfolioMeasure

{
    "title":"List<ApiEntityPortfolioMeasure>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityPortfolioMeasure",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityPortfolioMeasure

Type: object

Title: ApiEntityPortfolioMeasure

Show Source

• enabledFlag: boolean
  Indicates the state of the measure. Enabled measures can be associated with portfolios.
• lastCalculatedDate: string (date-time)
  The date on which the measure was last calculated.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• portfolioMeasureId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityPortfolioMeasure",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"Indicates the state of the measure. Enabled measures can be associated with portfolios.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which the measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested Portfolio Measure does not exist, or you do not have access to it.

Back to Top