Jump to

• Request
• Response

View Porfolio Measure Value by Portfolio

get

/api/restapi/portfolioMeasureValue/portfolio/{capitalPortfolioId}

This endpoint returns portfolio measure values that meet the following requirements:

• The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.

Request

Path Parameters

• capitalPortfolioId(required): integer(int64)
  The system-generated identifier of a portfolio.

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<ApiEntityPortfolioMeasureValue>

Type: array

Title: List<ApiEntityPortfolioMeasureValue>

Show Source

• Array of: object ApiEntityPortfolioMeasureValue
  Title: ApiEntityPortfolioMeasureValue

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

Nested Schema : ApiEntityPortfolioMeasureValue

Type: object

Title: ApiEntityPortfolioMeasureValue

Show Source

• actualBaseValue: number (double)
  The base actual value for the measure.
• actualDerivedValue: number (double)
  The actual value for the measure.
• actualExpressionValue: number (double)
  The actual value for the measure.
  If the measure is set manually, the current period's actual value displays.
• capitalPortfolioId: integer (int64)
  The unique identifier of a portfolio.
• entryType: string
  Allowed Values: [ "COMPUTE" ]

  The type of a measure entry.
• lastCalculatedDate: string (date-time)
  The date on which a measure was last calculated.
• link: string (url)
  Read Only: true

  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 measure.
• portfolioMeasureValueId: integer (int64)
  The unique identifier of a portfolio.
• targetBaseValue: number (double)
  The base target value for a measure.
• targetDerivedValue: number (double)
  The target value for the measure.
• targetExpressionValue: number (double)
  The target value for the measure.
  If the measure is set manually, the current period's target value displays.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• varBaseValue: number (double)
  The variance for a measure base value associated with a portfolio.
• varDerivedValue: number (double)
  The variance for a measure value associated with a portfolio. Calculated as actual value minus target value.
• varExpressionValue: number (double)
  The expression value for the measure.

{
    "title":"ApiEntityPortfolioMeasureValue",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetDerivedValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which a measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureValueId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "varDerivedValue":{
            "type":"number",
            "description":"The variance for a measure value associated with a portfolio. Calculated as actual value minus target value.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varBaseValue":{
            "type":"number",
            "description":"The variance for a measure base value associated with a portfolio.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualDerivedValue":{
            "type":"number",
            "description":"The actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varExpressionValue":{
            "type":"number",
            "description":"The expression value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "targetBaseValue":{
            "type":"number",
            "description":"The base target value for a measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "entryType":{
            "type":"string",
            "description":"The type of a measure entry.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "COMPUTE"
            ]
        },
        "targetExpressionValue":{
            "type":"number",
            "description":"The target value for the measure. <br />If the measure is set manually, the current period's target value displays.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualBaseValue":{
            "type":"number",
            "description":"The base actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualExpressionValue":{
            "type":"number",
            "description":"The actual value for the measure. <br />If the measure is set manually, the current period's actual value displays.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The portfolio measure value does not exist, or you do not have access to it.

Back to Top